locan.locan_io.locdata.elyra_io.load_Elyra_file#
- locan.locan_io.locdata.elyra_io.load_Elyra_file(path, nrows=None, convert=True, **kwargs)[source]#
Load data from a rapidSTORM single-molecule localization file.
- Parameters:
path (str | os.PathLike[Any] | SupportsRead[Any]) – File path for a file to load.
nrows (int | None) – 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.
kwargs (Any) – Other parameters passed to pandas.read_csv().
- Returns:
A new instance of LocData with all localizations.
- Return type:
Note
Data is loaded with encoding = ‘latin-1’ and only data before the first NUL character is returned. Additional information appended at the end of the file is thus ignored.