OpenMS: Peak1D Class Reference

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

A 1-dimensional raw data point or peak. More...

#include <OpenMS/KERNEL/Peak1D.h>

Inheritance diagram for Peak1D:

List of all members.

Classes
struct	IntensityLess
struct	MZLess
	Comparator by m/z position. More...
struct	PositionLess
	Comparator by position. As this class has dimension 1, this is basically an alias for MZLess. More...
Public Types
Type definitions
Dimension
enum	{ DIMENSION = 1 }
typedef Real	IntensityType
	Intensity type.
typedef DPosition< 1 >	PositionType
	Position type.
typedef DoubleReal	CoordinateType
	Coordinate type.
Public Member Functions
Peak1D &	operator= (const Peak1D &rhs)
	Assignment operator.
bool	operator== (const Peak1D &rhs) const
	Equality operator.
bool	operator!= (const Peak1D &rhs) const
	Equality operator.
Constructors and Destructor
Default constructor
	Peak1D ()
	Peak1D (const Peak1D &p)
	Copy constructor.
	~Peak1D ()
	Destructor.
Accessors

IntensityType	getIntensity () const
void	setIntensity (IntensityType intensity)
	Mutable access to the data point intensity (height).
CoordinateType	getMZ () const
	Non-mutable access to m/z.
void	setMZ (CoordinateType mz)
	Mutable access to m/z.
CoordinateType	getPos () const
	Alias for getMZ().
void	setPos (CoordinateType pos)
	Alias for setMZ().
PositionType const &	getPosition () const
	Non-mutable access to the position.
PositionType &	getPosition ()
	Mutable access to the position.
void	setPosition (PositionType const &position)
	Mutable access to the position.
Protected Attributes
PositionType	position_
	The data point position.
IntensityType	intensity_
	The data point intensity.

Detailed Description

A 1-dimensional raw data point or peak.

This datastructure is intended for continuous data or peak data. If wou want to annotated single peaks with meta data, use RichPeak1D instead.

Member Typedef Documentation

typedef DoubleReal CoordinateType

Coordinate type.

typedef Real IntensityType

Intensity type.

typedef DPosition<1> PositionType

Position type.

Member Enumeration Documentation

anonymous enum

Enumerator:

DIMENSION

Constructor & Destructor Documentation

Peak1D ( ) [inline]

Peak1D ( const Peak1D & p ) [inline]

Copy constructor.

~Peak1D ( ) [inline]

Destructor.

Note:: The destructor is non-virtual although many classes are derived from Peak1D. This is intentional, since otherwise we would "waste" space for a vtable pointer in each instance. Normally you should not derive other classes from Peak1D (unless you know what you are doing, of course).

Member Function Documentation

IntensityType getIntensity ( ) const [inline]

Non-mutable access to the data point intensity (height)

Referenced by Peak1D::IntensityLess::operator()(), MzMLHandler< MapType >::writePrecursor_(), MzXMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

CoordinateType getMZ ( ) const [inline]

Non-mutable access to m/z.

Referenced by OfflinePrecursorIonSelection::makePrecursorSelectionForKnownLCMSMap(), Peak1D::MZLess::operator()(), DTAFile::store(), MzMLHandler< MapType >::writePrecursor_(), MzXMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

CoordinateType getPos ( ) const [inline]

Alias for getMZ().

PositionType& getPosition ( ) [inline]

Mutable access to the position.

PositionType const& getPosition ( ) const [inline]

Non-mutable access to the position.

Referenced by Peak1D::PositionLess::operator()().

bool operator!= ( const Peak1D & rhs ) const [inline]

Equality operator.

Peak1D& operator= ( const Peak1D & rhs ) [inline]

Assignment operator.

References Peak1D::intensity_, and Peak1D::position_.

Referenced by RichPeak1D::operator=().

bool operator== ( const Peak1D & rhs ) const [inline]

Equality operator.

References Peak1D::intensity_, and Peak1D::position_.

Referenced by RichPeak1D::operator==().

void setIntensity ( IntensityType intensity ) [inline]

Mutable access to the data point intensity (height).

Referenced by MzMLHandler< MapType >::handleCVParam_(), OfflinePrecursorIonSelection::makePrecursorSelectionForKnownLCMSMap(), EmgScoring::prepareFit_(), CachedmzML::readSpectrum_(), and FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run().

void setMZ ( CoordinateType mz ) [inline]

Mutable access to m/z.

Referenced by MzMLHandler< MapType >::handleCVParam_(), DTAFile::load(), TOPPRNPxl::main_(), OfflinePrecursorIonSelection::makePrecursorSelectionForKnownLCMSMap(), EmgScoring::prepareFit_(), ChromatogramExtractor::prepareSpectra_(), CachedmzML::readSpectrum_(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), and TOPPViewBase::showSpectrumGenerationDialog().

void setPos ( CoordinateType pos ) [inline]

Alias for setMZ().

void setPosition ( PositionType const & position ) [inline]

Mutable access to the position.

Referenced by MSSpectrum< RichPeak1D >::MZBegin(), and MSSpectrum< RichPeak1D >::MZEnd().

Member Data Documentation

IntensityType intensity_ [protected]

The data point intensity.

Referenced by Peak1D::operator=(), and Peak1D::operator==().

PositionType position_ [protected]

The data point position.

Referenced by Peak1D::operator=(), and Peak1D::operator==().

OpenMS / TOPP release 1.10.0

Documentation generated on Thu Mar 7 2013 09:42:55 using doxygen 1.7.1