# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.
"""
.. Image panel (see parent package :mod:`datalab.gui.panel`)
"""
# pylint: disable=invalid-name # Allows short reference names like x, y, ...
from __future__ import annotations
from typing import TYPE_CHECKING, Type
from plotpy.tools import (
AnnotatedCircleTool,
AnnotatedEllipseTool,
AnnotatedPointTool,
AnnotatedRectangleTool,
AnnotatedSegmentTool,
LabelTool,
)
from sigima.io.image import ImageIORegistry
from sigima.objects import ImageDatatypes, ImageObj, ImageROI, NewImageParam
from datalab.config import Conf, _
from datalab.gui import roieditor
from datalab.gui.actionhandler import ImageActionHandler
from datalab.gui.newobject import create_image_gui
from datalab.gui.panel.base import BaseDataPanel
from datalab.gui.plothandler import ImagePlotHandler
from datalab.gui.processor.image import ImageProcessor
if TYPE_CHECKING:
from plotpy.plot import BasePlot
from qtpy import QtWidgets as QW
from datalab.gui.docks import DockablePlotWidget
[docs]
class ImagePanel(BaseDataPanel[ImageObj, ImageROI, roieditor.ImageROIEditor]):
"""Object handling the item list, the selected item properties and plot,
specialized for Image objects"""
PANEL_STR = _("Image Panel")
PANEL_STR_ID = "image"
PARAMCLASS = ImageObj
MINDIALOGSIZE = (800, 800)
# The following tools are used to create annotations on images. The annotation
# items are created using PlotPy's default settings. Those appearance settings
# may be modified in the configuration (see `datalab.config`).
ANNOTATION_TOOLS = (
AnnotatedCircleTool,
AnnotatedSegmentTool,
AnnotatedRectangleTool,
AnnotatedPointTool,
AnnotatedEllipseTool,
LabelTool,
)
IO_REGISTRY = ImageIORegistry
H5_PREFIX = "DataLab_Ima"
# pylint: disable=duplicate-code
[docs]
@staticmethod
def get_roi_class() -> Type[ImageROI]:
"""Return ROI class"""
return ImageROI
[docs]
@staticmethod
def get_roieditor_class() -> Type[roieditor.ImageROIEditor]:
"""Return ROI editor class"""
return roieditor.ImageROIEditor
def __init__(
self,
parent: QW.QWidget,
dockableplotwidget: DockablePlotWidget,
panel_toolbar: QW.QToolBar,
) -> None:
super().__init__(parent)
self.plothandler = ImagePlotHandler(self, dockableplotwidget.plotwidget)
self.processor = ImageProcessor(self, dockableplotwidget.plotwidget)
view_toolbar = dockableplotwidget.toolbar
self.acthandler = ImageActionHandler(self, panel_toolbar, view_toolbar)
# ------Refreshing GUI--------------------------------------------------------------
[docs]
def plot_lut_changed(self, plot: BasePlot) -> None:
"""The LUT of the plot has changed: updating image objects accordingly
Args:
plot: Plot object
"""
zmin, zmax = plot.get_axis_limits(plot.colormap_axis)
for obj in self.objview.get_sel_objects():
obj.zscalemin, obj.zscalemax = zmin, zmax
if obj is self.objview.get_current_object():
self.objprop.update_properties_from(obj)
# ------Creating, adding, removing objects------------------------------------------
[docs]
def get_newparam_from_current(
self, newparam: NewImageParam | None = None, title: str | None = None
) -> NewImageParam | None:
"""Get new object parameters from the current object.
Args:
newparam (guidata.dataset.DataSet): new object parameters.
If None, create a new one.
title: new object title. If None, use the current object title, or the
default title.
Returns:
New object parameters
"""
curobj: ImageObj = self.objview.get_current_object()
if newparam is None:
newparam = NewImageParam()
if title is not None:
newparam.title = title
if curobj is not None and Conf.proc.use_image_dims.get(True):
# Use current image dimensions for new image:
newparam.height, newparam.width = curobj.data.shape
newparam.dtype = ImageDatatypes.from_numpy_dtype(curobj.data.dtype)
return newparam
[docs]
def new_object(
self,
param: NewImageParam | None = None,
edit: bool = False,
add_to_panel: bool = True,
) -> ImageObj | None:
"""Create a new object (image).
Args:
param (guidata.dataset.DataSet): new object parameters
edit (bool): Open a dialog box to edit parameters (default: False).
When False, the object is created with default parameters and creation
parameters are stored in metadata for interactive editing.
add_to_panel (bool): Add the object to the panel (default: True)
Returns:
New object
"""
if not self.mainwindow.confirm_memory_state():
return None
param = self.get_newparam_from_current(param)
image = create_image_gui(param, edit=edit, parent=self.parentWidget())
if image is None:
return None
if add_to_panel:
self.add_object(image)
return image
[docs]
def toggle_show_contrast(self, state: bool) -> None:
"""Toggle show contrast option"""
Conf.view.show_contrast.set(state)
self.refresh_plot("selected", True, False)
