spectrochempy.read_topspin

read_topspin(*paths, **kwargs)[source][source]

Open Bruker TOPSPIN (NMR) dataset.

Parameters:

*paths (str, optional) – Paths of the Bruker directories to read.
**kwargs (keyword parameters, optional) – See Other Parameters.

Returns:

object (NDDataset or list of NDDataset) – The returned dataset(s).

Other Parameters:

expno (int, optional) – Experiment number.
procno (int, optional) – Processing number.
use_list (bool or str, optional, default: False) – Whether to use a list to make indirect coordinates for pseudo-2D spectra (e.g., for relaxation experiments). If True the list vdlist is used. If a string, the list with the given name is used.
protocol (str, optional) – Protocol used for reading. It can be one of {'scp', 'omnic', 'opus', 'topspin', 'matlab', 'jcamp', 'csv', 'excel'}. If not provided, the correct protocol is inferred (whenever it is possible) from the filename extension.
directory (Path object objects or valid urls, optional) – From where to read the files.
merge (bool, optional, default: False) – If True and several filenames or a directory have been provided as arguments, then a single NDDataset with merged (stacked along the first dimension) is returned.
sortbydate (bool, optional, default: True) – Sort multiple filename by acquisition date.
description (str, optional) – A Custom description.
origin (one of {'omnic', 'tga'}, optional) – Used when reading with the CSV protocol. In order to properly interpret CSV file it can be necessary to set the origin of the spectra. Up to now only 'omnic' and 'tga' have been implemented.
csv_delimiter (str, optional, default: csv_delimiter) – Set the column delimiter in CSV file.
content (bytes object, optional) – Instead of passing a filename for further reading, a bytes content can be directly provided as bytes objects. The most convenient way is to use a dictionary. This feature is particularly useful for a GUI Dash application to handle drag and drop of files into a Browser.
iterdir (bool, optional, default: True) – If True and no filename was provided, all files present in the provided directory are returned (and merged if merge is True. It is assumed that all the files correspond to current reading protocol.

Changed in version 0.6.2: iterdir replace the deprecated listdir argument.