locan.rois.roi.load_locdata_from_roi_file

locan.rois.roi.load_locdata_from_roi_file(path, reference_path=None)[source]

A helper function to load localization data according to the chosen roi file.

Parameters:
  • path (str | PathLike[Any]) – File path for a file to load.

  • reference_path (Union[str, PathLike[Any], Literal['path'], None]) – Taken as new roi reference path but with the localization file name. If “path”, reference path will be set to path but with the localization file name

Returns:

A new instance of LocData with all localizations.

Return type:

LocData