locan.locan_io.locdata.rapidstorm_io.load_rapidSTORM_track_file#
- locan.locan_io.locdata.rapidstorm_io.load_rapidSTORM_track_file(path, nrows=None, convert=True, collection=True, min_localization_count=1, **kwargs)[source]#
Load data from a rapidSTORM single-molecule localization file with tracked localizations.
- 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.
collection (bool) – If True a collection of all tracks is returned. If False LocData with center positions is returned.
min_localization_count (int) – If collection is True, only clusters with at least min_localization_count localizations are loaded.
kwargs (Any) – Other parameters passed to pandas.read_csv().
- Returns:
A new instance of LocData with all localizations/tracks as a collection.
- Return type: