locan.locan_io.locdata.smlm_io.load_SMLM_file#

locan.locan_io.locdata.smlm_io.load_SMLM_file(path, nrows=None, convert=True)[source]#

Load data from a SMLM single-molecule localization file.

Parameters:

  • path (Union[str, PathLike[Any], IO[Any]]) – File path for a file to load.

  • nrows (Optional[int]) – The number of localizations to load from file. None means that all available rows are loaded.

  • convert (bool) – If True convert types by applying type specifications in locan.constants.PROPERTY_KEYS.

Returns:

A new instance of LocData with all localizations. Returns a list of LocData if multiple tables are found.

Return type:

LocData | list[LocData]