locan.scripts.script_draw_roi.sc_draw_roi_mpl#

locan.scripts.script_draw_roi.sc_draw_roi_mpl(file_path=None, file_type=1, roi_file_indicator='_roi', region_type='rectangle')[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).

  • region_type (Literal['rectangle', 'ellipse', 'polygon']) – rectangle, ellipse, or polygon specifying the selection widget to use.

Return type:

None