locan.visualize.render_napari.utilities.save_rois#

locan.visualize.render_napari.utilities.save_rois(rois, file_path=None, roi_file_indicator='_roi')[source]#

Save list of Roi objects.

Parameters:

  • rois (Iterable[Roi]) – The rois to be saved.

  • file_path (Union[str, PathLike[Any], Literal['roi_reference'], None]) – Base name for roi files or existing directory to save rois in. If “roi_reference”, roi.reference.file.path is used. If None, a file dialog is opened.

  • roi_file_indicator (str) – Indicator to add to the localization file name and use as roi file name (with further extension .yaml).

Returns:

New created roi file paths.

Return type:

list[Path]