This is development documentation. Some features are not available in the stable release. View stable documentation.

spectrochempy.read_topspin

read_topspin(dataset) = <spectrochempy.nmr.read_topspin unresolved>

Open TopSpin Bruker NMR spectra.

Parameters:

*paths (str, Path object objects or valid urls, optional) – The data source(s) can be specified by the name or a list of name for the file(s) to be loaded:
- e.g., ( filename1, filename2, …, kwargs )
If the list of filenames are enclosed into brackets:
- e.g., ( [filename1, filename2, …], kwargs )
The returned datasets are merged to form a single dataset, except if merge is set to False.
**kwargs (keyword parameters, optional) – See Other Parameters.

Returns:

object (NDDataset or ScpObjectList of NDDataset) – The returned dataset(s). When several datasets are returned, the result is a list-like ScpObjectList.

Other Parameters:

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 web application to handle drag and drop of files into a Browser.
csv_delimiter (str, optional, default: csv_delimiter) – Set the column delimiter in CSV file.
description (str, optional) – A Custom description.
directory (Path object objects or valid urls, optional) – From where to read the files.
download_only (bool, optional, default: False) – Used only when url are specified. If True, only downloading and saving of the files is performed, with no attempt to read their content.
merge (bool, optional, default: False) – If True and several filenames or a directory have been provided as arguments, then a single NDDataset with merged dataset (stacked along the first dimension) is returned. In the case not all datasets have compatible dimensions or types/origins, then several NDDatasets can be returned for different groups of compatible datasets.
origin (str, optional) – Override the origin label (default 'topspin').
pattern (str, optional) – A pattern to filter the files to read.

Added in version 0.7.2.
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.
read_only (bool, optional, default: True) – Used only when url are specified. If True, saving of the files is performed in the current directory, or in the directory specified by the directory parameter.
recursive (bool, optional, default: False) – Read also in subfolders.
replace_existing (bool, optional, default: False) – Used only when url are specified. By default, existing files are not replaced so not downloaded.
sortbydate (bool, optional, default: True) – Sort multiple filename by acquisition date.

See also

read: Generic reader inferring protocol from the filename extension.
spectrochempy.read_zip: Read Zip archives (containing spectrochempy readable files)
spectrochempy.read_dir: Read an entire directory.
spectrochempy.read_opus: Read OPUS spectra.
spectrochempy.read_labspec: Read Raman LABSPEC spectra (.txt).
spectrochempy.read_omnic: Read Omnic spectra (.spa, .spg, .srs).
spectrochempy.read_soc: Read Surface Optics Corps. files (.ddr , .hdr or .sdr).
spectrochempy.read_spc: Read Galactic files (.spc).
spectrochempy.read_quadera: Read a Pfeiffer Vacuum’s QUADERA mass spectrometer software file.
spectrochempy.read_csv: Read CSV files (.csv).
spectrochempy.read_matlab: Read Matlab files (.mat, .dso).
spectrochempy.read_jcamp: Read Infrared JCAMP-DX files (.jdx, .dx).
spectrochempy.carroucell.read: Read files in a directory after a carroucell experiment.
spectrochempy.read_wire: Read Renishaw Wire files (.wdf).

Examples

Reading a single TopSpin file

>>> scp.nmr.read('irdata/topspin/1/pdata/1/1r')
NDDataset: [float64] a.u. (shape: (y:1, x:16384))