locan.locan_io.locdata.io_locdata.load_locdata#
- locan.locan_io.locdata.io_locdata.load_locdata(path, file_type=1, nrows=None, **kwargs)[source]#
Load data from localization file as specified by type.
This function is a wrapper for read functions for the various types of SMLM data.
- Parameters:
path (str | os.PathLike[Any] | SupportsRead[Any]) – File path for a localization data file to load.
file_type (int | str | locan.constants.FileType | locan.data.metadata_pb2.Metadata) – Indicator for the file type. Integer or string should be according to locan.constants.FileType.
nrows (int | None) – The number of localizations to load from file. None means that all available rows are loaded.
kwargs (Any) – kwargs passed to the specific load function.
- Returns:
A new instance of LocData with all localizations.
- Return type: