Skip to content

remove ipywidget code from selectors and cleanup docstrings #644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 18, 2024
Merged

remove ipywidget code from selectors and cleanup docstrings #644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
888f0e8
remove ipywidget code from linear selector and cleanup docstrings
kushalkolar Oct 8, 2024
01d2be6
remove ipywidget code from LinearRegionSelector, cleanup docstrings
kushalkolar Oct 8, 2024
9e416fb
remove a method
kushalkolar Oct 8, 2024
4660257
update API docs
kushalkolar Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/source/api/selectors/LinearRegionSelector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,10 @@ Methods

LinearRegionSelector.add_axes
LinearRegionSelector.add_event_handler
LinearRegionSelector.add_ipywidget_handler
LinearRegionSelector.clear_event_handlers
LinearRegionSelector.get_selected_data
LinearRegionSelector.get_selected_index
LinearRegionSelector.get_selected_indices
LinearRegionSelector.make_ipywidget_slider
LinearRegionSelector.remove_event_handler
LinearRegionSelector.rotate
LinearRegionSelector.share_property
Expand Down
2 changes: 0 additions & 2 deletions docs/source/api/selectors/LinearSelector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,10 @@ Methods

LinearSelector.add_axes
LinearSelector.add_event_handler
LinearSelector.add_ipywidget_handler
LinearSelector.clear_event_handlers
LinearSelector.get_selected_data
LinearSelector.get_selected_index
LinearSelector.get_selected_indices
LinearSelector.make_ipywidget_slider
LinearSelector.remove_event_handler
LinearSelector.rotate
LinearSelector.share_property
Expand Down
195 changes: 28 additions & 167 deletions fastplotlib/graphics/selectors/_linear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@
from typing import *
import math
from numbers import Real
from typing import Sequence

import numpy as np
import pygfx

from ...utils.gui import IS_JUPYTER
from .._base import Graphic
from .._collection_base import GraphicCollection
from .._features._selection_features import LinearSelectionFeature
from ._base_selector import BaseSelector


if IS_JUPYTER:
# If using the jupyter backend, user has jupyter_rfb, and thus also ipywidgets
import ipywidgets


class LinearSelector(BaseSelector):
@property
def parent(self) -> Graphic:
Expand All @@ -39,11 +33,11 @@ def selection(self, value: int):
self._selection.set_value(self, value)

@property
def limits(self) -> Tuple[float, float]:
def limits(self) -> tuple[float, float]:
return self._limits

@limits.setter
def limits(self, values: Tuple[float, float]):
def limits(self, values: tuple[float, float]):
# check that `values` is an iterable of two real numbers
# using `Real` here allows it to work with builtin `int` and `float` types, and numpy scaler types
if len(values) != 2 or not all(map(lambda v: isinstance(v, Real), values)):
Expand All @@ -62,46 +56,50 @@ def __init__(
center: float,
axis: str = "x",
parent: Graphic = None,
color: str | tuple = "w",
color: str | Sequence[float] | np.ndarray = "w",
thickness: float = 2.5,
arrow_keys_modifier: str = "Shift",
name: str = None,
):
"""
Create a horizontal or vertical line slider that is synced to an ipywidget IntSlider
Create a horizontal or vertical line that can be used to select a value along an axis.

Parameters
----------
selection: int
initial x or y selected position for the slider, in world space
initial x or y selected position for the selector, in data space

limits: (int, int)
(min, max) limits along the x or y axis for the selector, in world space
(min, max) limits along the x or y-axis for the selector, in data space

axis: str, default "x"
"x" | "y", the axis which the slider can move along
size: float
size of the selector, usually the range of the data

center: float
center offset of the selector on the orthogonal axis, by default the data mean
center offset of the selector on the orthogonal axis, usually the data mean

axis: str, default "x"
"x" | "y", the axis along which the selector can move

parent: Graphic
parent graphic for this LineSelector
parent graphic for this LinearSelector

arrow_keys_modifier: str
modifier key that must be pressed to initiate movement using arrow keys, must be one of:
"Control", "Shift", "Alt" or ``None``. Double click on the selector first to enable the
"Control", "Shift", "Alt" or ``None``. Double-click the selector first to enable the
arrow key movements, or set the attribute ``arrow_key_events_enabled = True``

thickness: float, default 2.5
thickness of the slider
thickness of the selector

color: Any, default "w"
selection to set the color of the slider
color: str | tuple | np.ndarray, default "w"
color of the selector

name: str, optional
name of line slider
name of linear selector

"""

if len(limits) != 2:
raise ValueError("limits must be a tuple of 2 integers, i.e. (int, int)")

Expand Down Expand Up @@ -155,10 +153,6 @@ def __init__(

self._move_info: dict = None

self._block_ipywidget_call = False

self._handled_widgets = list()

if axis == "x":
offset = (parent.offset[0], center + parent.offset[1], 0)
elif axis == "y":
Expand Down Expand Up @@ -187,149 +181,22 @@ def __init__(
else:
self._selection.set_value(self, selection)

# update any ipywidgets
self.add_event_handler(self._update_ipywidgets, "selection")

def _setup_ipywidget_slider(self, widget):
# setup an ipywidget slider with bidirectional callbacks to this LinearSelector
value = self.selection

if isinstance(widget, ipywidgets.IntSlider):
value = int(value)

widget.value = value

# user changes widget -> linear selection changes
widget.observe(self._ipywidget_callback, "value")

self._handled_widgets.append(widget)

def _update_ipywidgets(self, ev):
# update the ipywidget sliders when LinearSelector value changes
self._block_ipywidget_call = True # prevent infinite recursion

value = ev.info["value"]
# update all the handled slider widgets
for widget in self._handled_widgets:
if isinstance(widget, ipywidgets.IntSlider):
widget.value = int(value)
else:
widget.value = value

self._block_ipywidget_call = False

def _ipywidget_callback(self, change):
# update the LinearSelector when the ipywidget value changes
if self._block_ipywidget_call or self._moving:
return

self.selection = change["new"]

def _fpl_add_plot_area_hook(self, plot_area):
super()._fpl_add_plot_area_hook(plot_area=plot_area)

# resize the slider widgets when the canvas is resized
self._plot_area.renderer.add_event_handler(self._set_slider_layout, "resize")

def _set_slider_layout(self, *args):
w, h = self._plot_area.renderer.logical_size

for widget in self._handled_widgets:
widget.layout = ipywidgets.Layout(width=f"{w}px")

def make_ipywidget_slider(self, kind: str = "IntSlider", **kwargs):
def get_selected_index(self, graphic: Graphic = None) -> int | list[int]:
"""
Makes and returns an ipywidget slider that is associated to this LinearSelector
Data index the selector is currently at w.r.t. the Graphic data.

Parameters
----------
kind: str
"IntSlider", "FloatSlider" or "FloatLogSlider"

kwargs
passed to the ipywidget slider constructor

Returns
-------
ipywidgets.Intslider or ipywidgets.FloatSlider

"""

if not IS_JUPYTER:
raise ImportError(
"Must installed `ipywidgets` to use `make_ipywidget_slider()`"
)

if kind not in ["IntSlider", "FloatSlider", "FloatLogSlider"]:
raise TypeError(
f"`kind` must be one of: 'IntSlider', 'FloatSlider' or 'FloatLogSlider'\n"
f"You have passed: '{kind}'"
)

cls = getattr(ipywidgets, kind)

value = self.selection
if "Int" in kind:
value = int(self.selection)

slider = cls(
min=self.limits[0],
max=self.limits[1],
value=value,
**kwargs,
)
self.add_ipywidget_handler(slider)

return slider

def add_ipywidget_handler(self, widget, step: Union[int, float] = None):
"""
Bidirectionally connect events with a ipywidget slider

Parameters
----------
widget: ipywidgets.IntSlider, ipywidgets.FloatSlider, or ipywidgets.FloatLogSlider
ipywidget slider to connect to

step: int or float, default ``None``
step size, if ``None`` 100 steps are created

"""

if not isinstance(
widget,
(ipywidgets.IntSlider, ipywidgets.FloatSlider, ipywidgets.FloatLogSlider),
):
raise TypeError(
f"`widget` must be one of: ipywidgets.IntSlider, ipywidgets.FloatSlider, or ipywidgets.FloatLogSlider\n"
f"You have passed a: <{type(widget)}"
)

if step is None:
step = (self.limits[1] - self.limits[0]) / 100

if isinstance(widget, ipywidgets.IntSlider):
step = int(step)

widget.step = step

self._setup_ipywidget_slider(widget)

def get_selected_index(self, graphic: Graphic = None) -> Union[int, List[int]]:
"""
Data index the slider is currently at w.r.t. the Graphic data. With LineGraphic data, the geometry x or y
position is not always the data position, for example if plotting data using np.linspace. Use this to get
the data index of the slider.
With LineGraphic data, the geometry x or y position is not always the data position, for example if plotting
data using np.linspace. Use this to get the data index of the selector.

Parameters
----------
graphic: Graphic, optional
Graphic to get the selected data index from. Default is the parent graphic associated to the slider.
Graphic to get the selected data index from. Default is the parent graphic associated to the selector.

Returns
-------
int or List[int]
data index the slider is currently at, list of ``int`` if a Collection
data index the selector is currently at, list of ``int`` if a Collection
"""

source = self._get_source(graphic)
Expand All @@ -354,10 +221,10 @@ def _get_selected_index(self, graphic):
"Line" in graphic.__class__.__name__
or "Scatter" in graphic.__class__.__name__
):
# we want to find the index of the data closest to the slider position
# we want to find the index of the data closest to the selector position
find_value = self.selection

# get closest data index to the world space position of the slider
# get closest data index to the world space position of the selector
idx = np.searchsorted(data, find_value, side="left")

if idx > 0 and (
Expand Down Expand Up @@ -398,9 +265,3 @@ def _move_graphic(self, delta: np.ndarray):
self.selection = self.selection + delta[0]
else:
self.selection = self.selection + delta[1]

def _fpl_prepare_del(self):
for widget in self._handled_widgets:
widget.unobserve(self._ipywidget_callback, "value")

super()._fpl_prepare_del()
Loading
Loading