Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes

DataProcessing Class Reference
[Metadata]

Descripton of the applied preprocessing steps. More...

#include <OpenMS/METADATA/DataProcessing.h>

Inheritance diagram for DataProcessing:
MetaInfoInterface

List of all members.

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.
 DataProcessing (const DataProcessing &source)
 Copy construcor.
 ~DataProcessing ()
 Destructor.
DataProcessingoperator= (const DataProcessing &source)
 Assignement operator.
bool operator== (const DataProcessing &rhs) const
 Equality operator.
bool operator!= (const DataProcessing &rhs) const
 Equality operator.
const SoftwaregetSoftware () const
 returns a const reference to the software used for processing
SoftwaregetSoftware ()
 returns a mutable reference to the software used for processing
void setSoftware (const Software &software)
 sets the software used for processing
const std::set
< ProcessingAction > & 
getProcessingActions () const
 returns a const reference to the applied processing actions
std::set< ProcessingAction > & getProcessingActions ()
 returns a mutable reference to the description of the applied processing
void setProcessingActions (const std::set< ProcessingAction > &actions)
 sets the description of the applied processing
const DateTimegetCompletionTime () const
 returns the time of completition of the processing
void setCompletionTime (const DateTime &completion_time)
 sets the time of completition taking a DateTime object

Static Public Attributes

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

Protected Attributes

Software software_
std::set< ProcessingActionprocessing_actions_
DateTime completion_time_

Detailed Description

Descripton 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 

Convertion 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

DataProcessing (  ) 

Constructor.

DataProcessing ( const DataProcessing source  ) 

Copy construcor.

~DataProcessing (  ) 

Destructor.


Member Function Documentation

const DateTime& getCompletionTime (  )  const

returns the time of completition of the processing

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

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

returns a const reference to the applied processing actions

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

std::set<ProcessingAction>& getProcessingActions (  ) 

returns a mutable reference to the description of the applied processing

Software& getSoftware (  ) 

returns a mutable reference to the software used for processing

const Software& getSoftware (  )  const
bool operator!= ( const DataProcessing rhs  )  const

Equality operator.

DataProcessing& operator= ( const DataProcessing source  ) 

Assignement operator.

bool operator== ( const DataProcessing rhs  )  const

Equality operator.

void setCompletionTime ( const DateTime completion_time  ) 
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(), DBAdapter::loadSpectrum(), and MzMLHandler< MapType >::startElement().


Member Data Documentation

const std::string NamesOfProcessingAction[SIZE_OF_PROCESSINGACTION] [static]

Names of inlet types.

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

OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:55 using doxygen 1.7.1