locan.scripts.script_rois.sc_draw_roi_napari#

locan.scripts.script_rois.sc_draw_roi_napari(file_path=None, file_type=FileType.CUSTOM, roi_file_indicator='_roi', **kwargs)[source]#

Define regions of interest by drawing a boundary.

Parameters:
  • file_path (UnionType[str, PathLike[Any], None]) – File path to localization data.

  • file_type (int | str | FileType | Metadata) – Indicator for the file type. Integer or string should be according to locan.constants.FileType.

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

  • kwargs (Any) – Other parameters passed to render_2d_napari().

Returns:

File paths for all roi files

Return type:

list[Path]