a =b$@sRdZddlmZddlZddlmZmZmZddl m Z m Z Gdddej Z dS) z8 Base class for Plugins that interact with ImageViewer. )warnN) QtWidgetsQtCoreSignal) RequiredAttr init_qtappcseZdZdZdZedeZeej Z ee Z d(fdd Z d d Zd d ZddZddZddZddZddZeddZddZddZd)fdd Zd d!Zd"d#Zd$d%Zd&d'ZZS)*Plugina] Base class for plugins that interact with an ImageViewer. A plugin connects an image filter (or another function) to an image viewer. Note that a Plugin is initialized *without* an image viewer and attached in a later step. See example below for details. Parameters ---------- image_viewer : ImageViewer Window containing image used in measurement/manipulation. image_filter : function Function that gets called to update image in image viewer. This value can be `None` if, for example, you have a plugin that extracts information from an image and doesn't manipulate it. Alternatively, this function can be defined as a method in a Plugin subclass. height, width : int Size of plugin window in pixels. Note that Qt will automatically resize a window to fit components. So if you're adding rows of components, you can leave `height = 0` and just let Qt determine the final height. useblit : bool If True, use blitting to speed up animation. Only available on some Matplotlib backends. If None, set to True when using Agg backend. This only has an effect if you draw on top of an image viewer. Attributes ---------- image_viewer : ImageViewer Window containing image used in measurement. name : str Name of plugin. This is displayed as the window title. artist : list List of Matplotlib artists and canvastools. Any artists created by the plugin should be added to this list so that it gets cleaned up on close. Examples -------- >>> from skimage.viewer import ImageViewer >>> from skimage.viewer.widgets import Slider >>> from skimage import data >>> >>> plugin = Plugin(image_filter=lambda img, ... threshold: img > threshold) # doctest: +SKIP >>> plugin += Slider('threshold', 0, 255) # doctest: +SKIP >>> >>> image = data.coins() >>> viewer = ImageViewer(image) # doctest: +SKIP >>> viewer += plugin # doctest: +SKIP >>> thresholded = viewer.show()[0][0] # doctest: +SKIP The plugin will automatically delegate parameters to `image_filter` based on its parameter type, i.e., `ptype` (widgets for required arguments must be added in the order they appear in the function). The image attached to the viewer is **automatically passed as the first argument** to the filter function. #TODO: Add flag so image is not passed to filter function by default. `ptype = 'kwarg'` is the default for most widgets so it's unnecessary here. z!%s is not attached to ImageViewerNrTbottomcsttt|||_d|_t|ds2||_n|durBtd| |j t ||_ |||d|_g|_i|_||_g|_g|_dS)N image_filterzbIf the Plugin class defines an `image_filter` method, then the `image_filter` argument is ignored.r)rsuperr __init__dock image_viewerhasattrr rZsetWindowTitlenamerZ QGridLayoutlayoutZresizerow argumentskeyword_argumentsuseblitZcidsartists)selfr Zheightwidthrr __class__:lib/python3.9/site-packages/skimage/viewer/plugins/base.pyrPs"    zPlugin.__init__cCsD|||tjj||_|jj||jjg|_ | dS)awAttach the plugin to an ImageViewer. Note that the ImageViewer will automatically call this method when the plugin is added to the ImageViewer. For example:: viewer += Plugin(...) Also note that `attach` automatically calls the filter function so that the image matches the filtered value specified by attached widgets. N) Z setParentZsetWindowFlagsrZQtZDialogrpluginsappendZoriginal_imager filter_image)rrrrrattachks  z Plugin.attachcCs|jdkr,|jdd}||j|<|j|_n2|jdkrL|j||j|_n|jdkr^|j|_||_ |j ||j d|j d7_ dS) a1Add widget to plugin. Alternatively, Plugin's `__add__` method is overloaded to add widgets:: plugin += Widget(...) Widgets can adjust required or optional arguments of filter function or parameters for the plugin. This is specified by the Widget's `ptype`. kwarg _argpluginrN) Zptyperreplacerr!callbackrr update_pluginr'rZ addWidgetr)rwidgetrrrr add_widgets       zPlugin.add_widgetcCs|||SN)r-)rr,rrr__add__s zPlugin.__add__csdjdurdSfddjD}fddjD}j|i|}|j|dS)zyCall `image_filter` with widget args and kwargs Note: `display_filtered_image` is automatically called. Ncsg|]}|qSr _get_value).0arrr z'Plugin.filter_image..csi|]\}}||qSrr0)r2rr3r4rr sz'Plugin.filter_image..)r rritemsdisplay_filtered_image image_changedemit)rZ widget_argrkwargsZfilteredrr4rr!s   zPlugin.filter_imagecCst|ds|S|jS)Nval)rr=)rZparamrrrr1szPlugin._get_valuecCs ||jd<|||dS)zUpdate the original image argument passed to the filter function. This method is called by the viewer when the original image is updated. rN)r _on_new_imager!rimagerrr_update_original_images  zPlugin._update_original_imagecCsdS)z:Override this method to update your plugin for new images.Nrr?rrrr>szPlugin._on_new_imagecCs|jjS)zReturn filtered image.rr@r4rrrfiltered_imageszPlugin.filtered_imagecCs ||j_dS)zDisplay the filtered image on image viewer. If you don't want to simply replace the displayed image with the filtered image (e.g., you want to display a transparent overlay), you can override this method. NrBr?rrrr9szPlugin.display_filtered_imagecCst|||dS)zUpdate keyword parameters of the plugin itself. These parameters will typically be implemented as class properties so that they update the image or some other component. N)setattr)rrvaluerrrr+szPlugin.update_plugincsFtt||||}||}|j |dS)z Show plugin.N) r r showZactivateWindowZraise_Z frameGeometryxr_startedr;)rZ main_windowsizeZx_hintrrrrFs z Plugin.showcCs||dS)zOn close disconnect all artists and events from ImageViewer. Note that artists must be appended to `self.artists`. N)clean_upclose)rZeventrrr closeEventszPlugin.closeEventcCs:|||jjvr"|jj||j|jdSr.)remove_image_artistsrrremoveZ reset_imageZredrawr4rrrrJs   zPlugin.clean_upcCs|jD] }|qdS)z6Remove artists that are connected to the image viewer.N)rrN)rr3rrrrMs zPlugin.remove_image_artistscCs |jjdfS)aReturn the plugin's representation and data. Returns ------- image : array, same shape as ``self.image_viewer.image``, or None The filtered image. data : None Any data associated with the plugin. Notes ----- Derived classes should override this method to return a tuple containing an *overlay* of the same shape of the image, and a *data* object. Either of these is optional: return ``None`` if you don't want to return a value. NrBr4rrroutputsz Plugin.output)Nrr Tr )T)__name__ __module__ __qualname____doc__rrrrnpZndarrayr:intrHrr"r-r/r!r1rAr>propertyrCr9r+rFrLrJrMrO __classcell__rrrrr s0=      r )rSwarningsrZnumpyrTZqtrrrZutilsrrZQDialogr rrrrs