locan.locan_io.locdata.smlm_io.save_SMLM¶

locan.locan_io.locdata.smlm_io.save_SMLM(locdata, path, manifest=None)[source]¶

Save LocData attributes in a SMLM single-molecule localization (zip) file with manifest.json (version 0.2).

In the smlm file format we store metadata as a human- readable manifest. The data is stored as byte string.

Note

Only selected LocData attributes are saved. These are: ‘data’, ‘columns’, ‘meta’.

Parameters:

locdata (LocData) – The LocData object to be saved.
path (Union[str, PathLike[Any], IO[Any]]) – File path including file name to save to.
manifest (Manifest | None) – Protobuf with manifest to use instead of an autogenerated manifest.

Return type:

None