.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_gallery/selection_tools/highlight_selector.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download__gallery_selection_tools_highlight_selector.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr__gallery_selection_tools_highlight_selector.py:


Highlight Selector
==================

NDWidget with a time-varying 100x100 image (two circles driven by sine/cosine)
and a heatmap of all pixel timeseries. Clicking a row of the heatmap highlights
that row and the corresponding pixel on the image.
Shift-click appends; plain click replaces the selection.

.. GENERATED FROM PYTHON SOURCE LINES 10-91



.. image-sg:: /_gallery/selection_tools/images/sphx_glr_highlight_selector_001.webp
   :alt: highlight selector
   :srcset: /_gallery/selection_tools/images/sphx_glr_highlight_selector_001.webp
   :class: sphx-glr-single-img





.. code-block:: Python


    # test_example = false

    import numpy as np
    import fastplotlib as fpl
    from fastplotlib.graphics import ImageGraphic
    from fastplotlib.graphics.selectors import ImageHighlightSelector
    from fastplotlib.utils.functions import heatmap_to_positions

    # --- synthetic data ---
    n_t = 100
    n_y, n_x = 100, 100

    rng = np.random.default_rng(0)
    vol = np.zeros((n_t, n_y, n_x), dtype=np.float32)

    yy, xx = np.ogrid[:n_y, :n_x]
    mask1 = (yy - 30) ** 2 + (xx - 30) ** 2 < 15**2
    mask2 = (yy - 70) ** 2 + (xx - 70) ** 2 < 15**2

    t = np.linspace(0, 2 * np.pi, n_t)
    for i in range(n_t):
        vol[i, mask1] = np.sin(t[i]) + rng.normal(0, 0.05, mask1.sum())
        vol[i, mask2] = np.cos(t[i]) + rng.normal(0, 0.05, mask2.sum())

    # heatmap: (n_pixels, n_t), then convert to positions for add_nd_timeseries
    heatmap = vol.reshape(n_t, n_y * n_x).T.astype(np.float32)  # (n_pixels, n_t)
    xvals = np.arange(n_t, dtype=np.float32)
    heatmap_pos = heatmap_to_positions(heatmap, xvals)  # (n_pixels, n_t, 2)

    # --- layout ---
    ndw = fpl.NDWidget(ranges={"t": (0, n_t, 1)}, shape=(1, 2), size=(1400, 560))

    nd_img = ndw[0, 0].add_nd_image(vol, ("t", "y", "x"), ("y", "x"), name="image")

    nd_hm = ndw[0, 1].add_nd_timeseries(
        heatmap_pos,
        dims=("pixel", "t", "xy"),
        display_dims=("pixel", "t", "xy"),
        graphic_type=ImageGraphic,
        x_range_mode="fixed",
        display_window=None,
        name="heatmap",
    )

    # --- highlight selectors ---
    img_sel = ImageHighlightSelector(color="w", alpha=0.4)
    img_sel.add_graphic(nd_img.graphic)

    hm_sel = ImageHighlightSelector(color="w", alpha=0.4)
    hm_sel.add_graphic(nd_hm.graphic)


    @nd_hm.graphic.add_event_handler("double_click")
    def on_heatmap_click(ev):
        idx = ev.pick_info.get("index")
        if idx is None:
            return
        # index = (col, row) = (timepoint, pixel_idx)
        pixel_idx = idx[1]
        row = pixel_idx // n_x
        col = pixel_idx % n_x

        if "Shift" in ev.modifiers:
            hm_sel.append({"rows": pixel_idx})
            img_sel.append({"pixels": np.array([[row, col]])})
            print(hm_sel.selection)
        else:
            hm_sel.selection = {"rows": [pixel_idx]}
            img_sel.selection = {"pixels": [np.array([[row, col]])]}


    ndw.show(maintain_aspect=False)

    figure = ndw.figure

    # NOTE: fpl.loop.run() should not be used for interactive sessions
    # See the "JupyterLab and IPython" section in the user guide
    if __name__ == "__main__":
        print(__doc__)
        fpl.loop.run()


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.522 seconds)


.. _sphx_glr_download__gallery_selection_tools_highlight_selector.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: highlight_selector.py <highlight_selector.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: highlight_selector.zip <highlight_selector.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_