locan.locan_io.locdata.asdf_io.save_asdf#

locan.locan_io.locdata.asdf_io.save_asdf(locdata, path)[source]#

Save LocData attributes in an asdf file.

In the Advanced Scientific Data Format (ASDF) file format we store metadata, properties and column names as human-readable yaml header. The data is stored as binary numpy.ndarray.

Note

Only selected LocData attributes are saved. Currently these are: ‘data’, ‘columns’, ‘properties’, ‘meta’.

Parameters:
  • locdata (LocData) – The LocData object to be saved.

  • path (str | os.PathLike[Any] | SupportsWrite[Any]) – File path including file name to save to.

Return type:

None