Warning

You are reading the documentation related to the development version. Go here if you are looking for the documentation of the stable release.

spectrochempy.read_ddr¶

read_ddr(*paths, **kwargs)[source]¶

Open a Surface Optics Corps. file or a list of files with extension .ddr.

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.

If a source is not provided (i.e., no paths , nor content), a dialog box will be opened to select files.
**kwargs (keyword parameters, optional) – See Other Parameters.

Returns

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

Other Parameters

return_ifg (str or None, optional) – Default value is None. When set to ‘sample’ returns the sample interferogram of the spa file if present or None if absent. When set to ‘background’ returns the backgroung interferogram of the spa file if present or None if absent.
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.