Warning

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

Core objects

The NDDataset object is the main object used by SpectroChemPy .

Like a numpy ndarray, a NDDataset have the capability to be sliced, sorted and subjected to mathematical operations.

But, in addition, NDDataset may have units, can be masked and each dimension can have coordinates (Coord ) also with units.

This make NDDataset aware of unit compatibility, e.g.,, for binary operation such as additions or subtraction or during the application of mathematical operations.

In addition or in replacement of numerical data for coordinates, NDDataset can also have labeled coordinates where labels can be different kinds of objects (strings, datetime, ndarray or other NDDataset s, etc.).

This offers a lot of flexibility in using NDDataset s that, we hope, will be useful for the users.

Finally, Project is a structure that allows aggregating other Project s, NDDataset s, and processing scripts (Script) for a better management of complex set of spectroscopic data.

NDDataset

• The NDDataset object
  • 1D-Dataset (unidimensional dataset)
  • About the dates and times
  • About the history attribute
  • Units
  • Coordinates
  • Labels
• More insight on coordinates
  • Sharing coordinates between dimensions
  • Setting coordinates using set_coordset
  • Adding several coordinates to a single dimension
  • Summary of the coordinate setting syntax
• Methods to create NDDataset
  • Create a dataset from a function
  • Using numpy-like constructors of NDDatasets
  • Copying existing NDDataset
  • Importing from external dataset

Project

• Project management
  • Project creation
  • Remove an element from a project
  • Get project’s elements
  • Saving and loading projects

Script

Todo

To be documented