Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
DataProcessing Class Reference

Description of the applied preprocessing steps. More...

#include <OpenMS/METADATA/DataProcessing.h>

Inheritance diagram for DataProcessing:
MetaInfoInterface

Public Types

enum  ProcessingAction {
  DATA_PROCESSING, CHARGE_DECONVOLUTION, DEISOTOPING, SMOOTHING,
  CHARGE_CALCULATION, PRECURSOR_RECALCULATION, BASELINE_REDUCTION, PEAK_PICKING,
  ALIGNMENT, CALIBRATION, NORMALIZATION, FILTERING,
  QUANTITATION, FEATURE_GROUPING, IDENTIFICATION_MAPPING, FORMAT_CONVERSION,
  CONVERSION_MZDATA, CONVERSION_MZML, CONVERSION_MZXML, CONVERSION_DTA,
  SIZE_OF_PROCESSINGACTION
}
 

Public Member Functions

 DataProcessing ()
 Constructor. More...
 
 DataProcessing (const DataProcessing &source)
 Copy constructor. More...
 
 ~DataProcessing ()
 Destructor. More...
 
DataProcessingoperator= (const DataProcessing &source)
 Assignment operator. More...
 
bool operator== (const DataProcessing &rhs) const
 Equality operator. More...
 
bool operator!= (const DataProcessing &rhs) const
 Equality operator. More...
 
const SoftwaregetSoftware () const
 returns a const reference to the software used for processing More...
 
SoftwaregetSoftware ()
 returns a mutable reference to the software used for processing More...
 
void setSoftware (const Software &software)
 sets the software used for processing More...
 
const std::set< ProcessingAction > & getProcessingActions () const
 returns a const reference to the applied processing actions More...
 
std::set< ProcessingAction > & getProcessingActions ()
 returns a mutable reference to the description of the applied processing More...
 
void setProcessingActions (const std::set< ProcessingAction > &actions)
 sets the description of the applied processing More...
 
const DateTimegetCompletionTime () const
 returns the time of completion of the processing More...
 
void setCompletionTime (const DateTime &completion_time)
 sets the time of completion taking a DateTime object More...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 constructor More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 copy constructor More...
 
 ~MetaInfoInterface ()
 destructor More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 assignment operator More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValuegetMetaValue (const String &name) const
 returns the value corresponding to a string More...
 
const DataValuegetMetaValue (UInt index) const
 returns the value corresponding to an index More...
 
bool metaValueExists (const String &name) const
 returns if this MetaInfo is set More...
 
bool metaValueExists (UInt index) const
 returns if this MetaInfo is set More...
 
void setMetaValue (const String &name, const DataValue &value)
 sets the DataValue corresponding to a name More...
 
void setMetaValue (UInt index, const DataValue &value)
 sets the DataValue corresponding to an index More...
 
void removeMetaValue (const String &name)
 Removes the DataValue corresponding to name if it exists. More...
 
void removeMetaValue (UInt index)
 Removes the DataValue corresponding to index if it exists. More...
 
void getKeys (std::vector< String > &keys) const
 fills the given vector with a list of all keys for which a value is set More...
 
void getKeys (std::vector< UInt > &keys) const
 fills the given vector with a list of all keys for which a value is set More...
 
bool isMetaEmpty () const
 returns if the MetaInfo is empty More...
 
void clearMetaInfo ()
 removes all meta values More...
 

Static Public Attributes

static const std::string NamesOfProcessingAction [SIZE_OF_PROCESSINGACTION]
 Names of inlet types. More...
 

Protected Attributes

Software software_
 
std::set< ProcessingActionprocessing_actions_
 
DateTime completion_time_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 pointer to the MetaInfo object. 0 by default More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 returns a reference to the MetaInfoRegistry More...
 
- Protected Member Functions inherited from MetaInfoInterface
void createIfNotExists_ ()
 creates the MetaInfo object if it does not exist More...
 

Detailed Description

Description of the applied preprocessing steps.

Member Enumeration Documentation

Enumerator
DATA_PROCESSING 

General data processing (if no other term applies)

CHARGE_DECONVOLUTION 

Charge deconvolution.

DEISOTOPING 

Deisotoping.

SMOOTHING 

Smoothing of the signal to reduce noise.

CHARGE_CALCULATION 

Determination of the peak charge.

PRECURSOR_RECALCULATION 

Recalculation of precursor m/z.

BASELINE_REDUCTION 

Baseline reduction.

PEAK_PICKING 

Peak picking (conversion from raw to peak data)

ALIGNMENT 

Retention time alignment of different maps.

CALIBRATION 

Calibration of m/z positions.

NORMALIZATION 

Normalization of intensity values.

FILTERING 

Data filtering or extraction.

QUANTITATION 

Quantitation.

FEATURE_GROUPING 

Feature grouping

IDENTIFICATION_MAPPING 

Identification mapping

FORMAT_CONVERSION 

General file format conversion (if no other term applies)

CONVERSION_MZDATA 

Conversion to mzData format.

CONVERSION_MZML 

Conversion to mzML format.

CONVERSION_MZXML 

Conversion to mzXML format.

CONVERSION_DTA 

Conversion to DTA format.

SIZE_OF_PROCESSINGACTION 

Constructor & Destructor Documentation

Constructor.

DataProcessing ( const DataProcessing source)

Copy constructor.

Destructor.

Member Function Documentation

const DateTime& getCompletionTime ( ) const

returns the time of completion of the processing

Referenced by MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().

const std::set<ProcessingAction>& getProcessingActions ( ) const

returns a const reference to the applied processing actions

Referenced by MzDataHandler< MapType >::cvParam_(), MzDataHandler< MapType >::writeTo(), and MzXMLHandler< MapType >::writeTo().

std::set<ProcessingAction>& getProcessingActions ( )

returns a mutable reference to the description of the applied processing

const Software& getSoftware ( ) const
Software& getSoftware ( )

returns a mutable reference to the software used for processing

bool operator!= ( const DataProcessing rhs) const

Equality operator.

DataProcessing& operator= ( const DataProcessing source)

Assignment operator.

bool operator== ( const DataProcessing rhs) const

Equality operator.

void setCompletionTime ( const DateTime completion_time)

sets the time of completion taking a DateTime object

Referenced by SpectrumCanvas::addDataProcessing_(), XMassFile::load(), and MzDataHandler< MapType >::startElement().

void setProcessingActions ( const std::set< ProcessingAction > &  actions)

sets the description of the applied processing

Referenced by SpectrumCanvas::addDataProcessing_(), and XMassFile::load().

void setSoftware ( const Software software)

sets the software used for processing

Referenced by XMassFile::load(), and MzMLHandler< MapType >::startElement().

Member Data Documentation

DateTime completion_time_
protected
const std::string NamesOfProcessingAction[SIZE_OF_PROCESSINGACTION]
static

Names of inlet types.

std::set<ProcessingAction> processing_actions_
protected
Software software_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Tue Nov 1 2016 16:34:46 using doxygen 1.8.11