ndv.views.bases #

@abstractmethod
def canvas_to_world(
    self, pos_xy: tuple[float, float]
) -> tuple[float, float, float]:
    """Map XY canvas position (pixels) to XYZ coordinate in world space."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_range(
    self,
    x: tuple[float, float] | None = None,
    y: tuple[float, float] | None = None,
    z: tuple[float, float] | None = None,
    margin: float = ...,
) -> None:
    """Sets the bounds of the camera."""
    ...

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""

@abstractmethod
def can_select(self) -> bool:
    """Defines whether the element can be selected."""

def remove(self) -> None:
    """Removes the element from the canvas."""

@abstractmethod
def selected(self) -> bool:
    """Returns element selection status."""

@abstractmethod
def set_selected(self, selected: bool) -> None:
    """Sets element selection status."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets element visibility."""

@abstractmethod
def visible(self) -> bool:
    """Defines whether the element is visible on the canvas."""

@abstractmethod
def canvas_to_world(
    self, pos_xy: tuple[float, float]
) -> tuple[float, float, float]:
    """Map XY canvas position (pixels) to XYZ coordinate in world space."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

def highlight(self, value: float | None) -> None:
    """Highlights a domain value on the histogram."""

@abstractmethod
def set_channel_name(self, name: str) -> None:
    """Set the name of the channel to `name`."""

@abstractmethod
def set_channel_visible(self, visible: bool) -> None:
    """Check or uncheck the visibility indicator of the LUT.

    Usually corresponds to a checkbox.

    Note that this method must not modify the backing LUTModel.
    """

def set_clim_bounds(
    self,
    bounds: tuple[float | None, float | None] = (None, None),
) -> None:
    """Defines the minimum and maximum possible values for the clims."""

@abstractmethod
def set_clim_policy(self, policy: ClimPolicy) -> None:
    """Set the clim policy to `policy`.

    Usually corresponds to an "autoscale" checkbox.

    Note that this method must not modify the backing LUTModel.
    """

@abstractmethod
def set_clims(self, clims: tuple[float, float]) -> None:
    """Set the (low, high) contrast limits to `clims`.

    Usually this will be a range slider or two text boxes.

    Note that this method must not modify the backing LUTModel.
    """

@abstractmethod
def set_colormap(self, cmap: cmap.Colormap) -> None:
    """Set the colormap to `cmap`.

    Usually corresponds to a dropdown menu.

    Note that this method must not modify the backing LUTModel.
    """

def set_data(self, values: np.ndarray, bin_edges: np.ndarray) -> None:
    """Sets the histogram data.

    Properties
    ----------
    values : np.ndarray
        The histogram values.
    bin_edges : np.ndarray
        The bin edges of the histogram.
    """

def set_gamma(self, gamma: float) -> None:
    """Set the gamma value of the LUT.

    Note that this method must not modify the backing LUTModel.
    """
    return None

def set_log_base(self, base: float | None) -> None:
    """Sets the axis scale of the range.

    Properties
    ----------
    enabled : bool
        If true, the range will be displayed with a logarithmic (base 10)
        scale. If false, the range will be displayed with a linear scale.
    """

@abstractmethod
def set_range(
    self,
    x: tuple[float, float] | None = None,
    y: tuple[float, float] | None = None,
    z: tuple[float, float] | None = None,
    margin: float = ...,
) -> None:
    """Sets the bounds of the camera."""
    ...

def set_vertical(self, vertical: bool) -> None:
    """If True, orient axes vertically (x-axis on left)."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""

def synchronize(self) -> None:
    """Aligns the view against the backing model."""
    if model := self._model:
        self.set_clim_policy(model.clims)
        self.set_clim_bounds(model.clim_bounds)
        self.set_colormap(model.cmap)
        self.set_gamma(model.gamma)
        self.set_channel_visible(model.visible)

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_channel_name(self, name: str) -> None:
    """Set the name of the channel to `name`."""

@abstractmethod
def set_channel_visible(self, visible: bool) -> None:
    """Check or uncheck the visibility indicator of the LUT.

    Usually corresponds to a checkbox.

    Note that this method must not modify the backing LUTModel.
    """

def set_clim_bounds(
    self,
    bounds: tuple[float | None, float | None] = (None, None),
) -> None:
    """Defines the minimum and maximum possible values for the clims."""

@abstractmethod
def set_clim_policy(self, policy: ClimPolicy) -> None:
    """Set the clim policy to `policy`.

    Usually corresponds to an "autoscale" checkbox.

    Note that this method must not modify the backing LUTModel.
    """

@abstractmethod
def set_clims(self, clims: tuple[float, float]) -> None:
    """Set the (low, high) contrast limits to `clims`.

    Usually this will be a range slider or two text boxes.

    Note that this method must not modify the backing LUTModel.
    """

@abstractmethod
def set_colormap(self, cmap: cmap.Colormap) -> None:
    """Set the colormap to `cmap`.

    Usually corresponds to a dropdown menu.

    Note that this method must not modify the backing LUTModel.
    """

def set_gamma(self, gamma: float) -> None:
    """Set the gamma value of the LUT.

    Note that this method must not modify the backing LUTModel.
    """
    return None

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""

def synchronize(self) -> None:
    """Aligns the view against the backing model."""
    if model := self._model:
        self.set_clim_policy(model.clims)
        self.set_clim_bounds(model.clim_bounds)
        self.set_colormap(model.cmap)
        self.set_gamma(model.gamma)
        self.set_channel_visible(model.visible)

def call_in_main_thread(
    self, func: Callable[P, T], *args: P.args, **kwargs: P.kwargs
) -> Future[T]:
    """Call `func` in the main gui thread."""
    future: Future[T] = Future()
    future.set_result(func(*args, **kwargs))
    return future

def call_later(self, msec: int, func: Callable[[], None]) -> None:
    """Call `func` after `msec` milliseconds."""
    # generic implementation using python threading

    from threading import Timer

    Timer(msec / 1000, func).start()

def create_app(self) -> Any:
    """Create the application instance, if not already created."""
    raise NotImplementedError

def filter_mouse_events(
    self, canvas: Any, receiver: Mouseable
) -> Callable[[], None]:
    """Install mouse event filter on `canvas`, redirecting events to `receiver`."""
    raise NotImplementedError

def get_executor(self) -> Executor:
    """Return an executor for running tasks in the background."""
    return _thread_pool_executor()

def process_events(self) -> None:
    """Process events for the application."""
    pass

def run(self) -> None:
    """Run the application."""
    pass

@abstractmethod
def can_select(self) -> bool:
    """Defines whether the element can be selected."""

def remove(self) -> None:
    """Removes the element from the canvas."""

@abstractmethod
def selected(self) -> bool:
    """Returns element selection status."""

def set_border(self, color: _cmap.Color) -> None:
    """Sets the border color."""

def set_bounding_box(
    self, minimum: tuple[float, float], maximum: tuple[float, float]
) -> None:
    """Sets the bounding box."""

def set_fill(self, color: _cmap.Color) -> None:
    """Sets the fill color."""

def set_handles(self, color: _cmap.Color) -> None:
    """Sets the handle face color."""

@abstractmethod
def set_selected(self, selected: bool) -> None:
    """Sets element selection status."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets element visibility."""

@abstractmethod
def visible(self) -> bool:
    """Defines whether the element is visible on the canvas."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""