IO

Load & Save

spinlab.io.load.load(path, data_format=None, dim=None, coord=None, verbose=False, *args, **kwargs)

Import data from a file, directory, or list of paths.

Parameters:

  • path (str, PathLike, list) -- Path to data or list of paths to concatenate.

  • data_format (str) -- Format to import. If omitted, the format is detected from the path. Allowed values include prospa, topspin, delta, vnmrj, tnmr, specman, xenon, xepr, winepr, esp, h5, mat, power, vna, cnsi_powers, speclog, and rs2d.

  • dim (str) -- Name of the concatenation dimension when path is a list.

  • coord (array-like) -- Coordinates for the concatenation dimension.

  • verbose (bool) -- If True, print debugging output.

  • *args -- Additional positional arguments passed to the format-specific import function.

  • **kwargs -- Additional keyword arguments passed to the format-specific import function.

Returns:

Loaded data object.

Return type:

SpinData

Examples

>>> data = sl.load("path/to/file")
>>> data = sl.load(
...     ["1/data.1d", "2/data.1d", "3/data.1d"],
...     dim="t1",
...     coord=[0.1, 0.2, 0.3],
... )
spinlab.io.save.save(data_object, filename, save_type=None, *args, **kwargs)

Save SpinLab data to a supported file format.

Parameters:

  • data_object (SpinData or dict) -- Data object or workspace dictionary to save.

  • filename (str, PathLike) -- Output path.

  • save_type (str) -- Save format. If omitted, the format is detected from the filename extension. Allowed values are h5 and mat.

  • *args -- Additional positional arguments passed to the format-specific save function.

  • **kwargs -- Additional keyword arguments passed to the format-specific save function.

Returns:

None

Examples

>>> sl.save(data, "data.h5", overwrite=True)
>>> sl.save(data, "data.mat")

Bruker

JEOL

Varian / Agilent

Magritek

FeMi

Tecmag

RS2D

Other