locan.locan_io.locdata.decode_io.load_decode_file#

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

Load data from a DECODE single-molecule localization file.

Parameters:
  • path (str | os.PathLike[Any] | SupportsRead[Any]) – File path or file-like object 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.

Returns:

A new instance of LocData with all localizations.

Return type:

LocData