Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

MSSpectrum Class Template Reference
[Kernel]

#include <OpenMS/KERNEL/MSSpectrum.h>

Inheritance diagram for MSSpectrum:

DSpectrum SpectrumSettings PersistentObject MetaInfoInterface RangeManager< ContainerT::value_type::DIMENSION >

List of all members.


Detailed Description

template<typename PeakT = Peak1D, typename AllocT = std::allocator<PeakT>>
class OpenMS::MSSpectrum< PeakT, AllocT >

The representation of a 1D spectrum.

It contains the data itself (Spectrum) and metadata about spectrum specific instrument settings, aquisition settings, description of the meta values used in the peaks and precursor info (SpectrumSettings).

Several MSSpectrum instances are contained in MSExperiment e.g. class MSExperiment is essentially a vector of spectra with additional information about the experiment.

Precursor info from SpectrumSettings should only be used if this spectrum is a tandem-MS spectrum. The precursor spectrum is the first spectrum in MSExperiment, that has a lower MS-level than the current spectrum.

Note:
For range operations, see RangeUtils module!

Public Types

typedef PeakT PeakType
 Peak type.
typedef DSpectrum< DPeakArray
< PeakT, AllocT > > 
BaseSpectrum
 Spectrum base type.

Public Member Functions

 MSSpectrum ()
 Constructor.
 MSSpectrum (const AllocT &alloc)
 Constructor with custom allocator.
 MSSpectrum (const MSSpectrum &source)
 Copy constructor.
template<typename AllocT2>
 MSSpectrum (const MSSpectrum< PeakT, AllocT2 > &source)
 Copy constructor for different allocator.
template<typename AllocT2>
 MSSpectrum (const MSSpectrum< PeakT, AllocT2 > &source, const AllocT &alloc)
 Copy constructor for different allocator.
 ~MSSpectrum ()
 Destructor.
MSSpectrumoperator= (const MSSpectrum &source)
 Assignment operator.
template<typename AllocT2>
MSSpectrumoperator= (const MSSpectrum< PeakT, AllocT2 > &source)
 Assignment operator for different allocator.
bool operator== (const MSSpectrum &rhs) const
 Equality operator.
bool operator!= (const MSSpectrum &rhs) const
 Equality operator.

Protected Member Functions

virtual void clearChildIds_ ()
 Clears the persistence id of all sub-objects.

Classes

struct  RTLess
 Comparator for the retention time. More...

Member Typedef Documentation

typedef PeakT PeakType

Peak type.

Reimplemented from DSpectrum.

typedef DSpectrum< DPeakArray< PeakT, AllocT > > BaseSpectrum

Spectrum base type.


Constructor & Destructor Documentation

MSSpectrum (  )  [inline]

Constructor.

MSSpectrum ( const AllocT &  alloc  )  [inline]

Constructor with custom allocator.

MSSpectrum ( const MSSpectrum< PeakT, AllocT > &  source  )  [inline]

Copy constructor.

MSSpectrum ( const MSSpectrum< PeakT, AllocT2 > &  source  )  [inline]

Copy constructor for different allocator.

MSSpectrum ( const MSSpectrum< PeakT, AllocT2 > &  source,
const AllocT &  alloc 
) [inline]

Copy constructor for different allocator.

~MSSpectrum (  )  [inline]

Destructor.


Member Function Documentation

MSSpectrum& operator= ( const MSSpectrum< PeakT, AllocT > &  source  )  [inline]

Assignment operator.

MSSpectrum& operator= ( const MSSpectrum< PeakT, AllocT2 > &  source  )  [inline]

Assignment operator for different allocator.

bool operator== ( const MSSpectrum< PeakT, AllocT > &  rhs  )  const [inline]

Equality operator.

bool operator!= ( const MSSpectrum< PeakT, AllocT > &  rhs  )  const [inline]

Equality operator.

virtual void clearChildIds_ (  )  [inline, protected, virtual]

Clears the persistence id of all sub-objects.

Implements PersistentObject.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:46 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1