locan.visualize.render_napari.utilities.get_rois#

locan.visualize.render_napari.utilities.get_rois(shapes_layer, reference=None, loc_properties=None)[source]#

Create rois from shapes in napari.viewer.Shapes.

Parameters:

shapes_layer (Shapes) – Napari shapes layer like viewer.layers[“Shapes”]
reference (UnionType[LocData, dict[str, str], Metadata, File, None]) – Reference to localization data for which the region of interest is defined. It can be a LocData object, a reference to a saved SMLM file, or None for indicating no specific reference. When dict it must have keys file_path`and `file_type. When Metadata message it must have keys file.path and file.type for a path pointing to a localization file and an integer or string indicating the file type. Integer or string should be according to locan.constants.FileType.
loc_properties (Optional[Sequence[str]]) – Localization properties in LocData object on which the region selection will be applied (for instance the coordinate_keys).

Return type:

list[Roi]