uvvispy.metadata module¶
Metadata: crucial information about the numerical data.
Metadata¶
In this module, the individual metadata classes are defined which contain the individual information about the experiment:
What may sound like a minor detail is one key aspect of the UVVisPy package:
The metadata and their structure provide a unified interface for all
functionality operating on datasets. Furthermore, the metadata contained
particularly in the uvvispy.metadata.ExperimentalDatasetMetadata class
are the result of several years of practical experience. Reproducible research
is only possible if all information necessary is always recorded, and this
starts with all the metadata accompanying a measurement. Defining what kind
of metadata is important and needs to be recorded, together with metadata
formats easily writable by the experimenters during recording the data
requires a thorough understanding of both, the method and the setup(s) used.
For an overview of the structures of the dataset classes and their
corresponding metadata, see the dataset structure
section.
Module documentation¶
- class uvvispy.metadata.ExperimentalDatasetMetadata¶
Bases:
aspecd.metadata.ExperimentalDatasetMetadataSet of all metadata for a dataset object.
Metadata as a unified structure of information coupled to the dataset are necessary for the understanding, analysis and processing of data, especially in UVVisPy. Too many parameters have an direct influence to the spectral shape of the spectrum that anything other than saving them in an appropriate place and accessing them automatised in the respective tasks is no option. Some parameters are written automatically by the spectrometer’s software, others, depending also on the actual setup (that may change over time!) are omitted and it is highly recommended those should be noted by hand, for example in an .info-file.
- cell¶
Metadata corresponding to the cell used for the experiment.
- Type
uvvispy.metadata.Measurement
- experiment¶
Metadata corresponding to the actual experiment.
- spectrometer¶
Metadata corresponding to the spectrometer used for the experiment.
- class uvvispy.metadata.Sample¶
Bases:
aspecd.metadata.SampleMetadata corresponding to the sample measured.
- concentration¶
Type of the cell as given by the manufacturer.
- class uvvispy.metadata.TemperatureControl¶
Bases:
aspecd.metadata.TemperatureControlMetadata corresponding to the temperature control.
- class uvvispy.metadata.Cell¶
Bases:
aspecd.metadata.MetadataMetadata corresponding to the cell used for the experiment.
- pathlength¶
Optical pathlength of the cell, usually 1 cm.
- class uvvispy.metadata.Experiment¶
Bases:
aspecd.metadata.MetadataMetadata corresponding to the actual experiment.
- class uvvispy.metadata.Spectrometer¶
Bases:
aspecd.metadata.MetadataMetadata corresponding to the spectrometer used for the experiment.