ChromatogramPeak Class Reference [Kernel]

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

#include <OpenMS/KERNEL/ChromatogramPeak.h>

List of all members.

Classes
struct	IntensityLess
	Comparator by intensity. More...
struct	PositionLess
	Comparator by position. As this class has dimension 1, this is basically an alias for RTLess. More...
struct	RTLess
	Comparator by RT position. More...
Public Types
Type definitions
enum	{ DIMENSION = 1 }
	Dimension. More...
typedef DoubleReal	IntensityType
	Intensity type.
typedef DPosition< 1 >	PositionType
	Position type.
typedef DoubleReal	CoordinateType
	Coordinate type.
Public Member Functions
ChromatogramPeak &	operator= (const ChromatogramPeak &rhs)
	Assignment operator.
bool	operator== (const ChromatogramPeak &rhs) const
	Equality operator.
bool	operator!= (const ChromatogramPeak &rhs) const
	Equality operator.
Constructors and Destructor
	ChromatogramPeak ()
	Default constructor.
	ChromatogramPeak (const ChromatogramPeak &p)
	Copy constructor.
	~ChromatogramPeak ()
	Destructor.
Accessors
IntensityType	getIntensity () const
	Non-mutable access to the data point intensity (height).
void	setIntensity (IntensityType intensity)
	Mutable access to the data point intensity (height).
CoordinateType	getRT () const
	Non-mutable access to RT.
void	setRT (CoordinateType rt)
	Mutable access to RT.
CoordinateType	getPos () const
	Alias for getRT().
void	setPos (CoordinateType pos)
	Alias for setRT().
CoordinateType	getMZ () const
	Alias for getRT().
void	setMZ (CoordinateType rt)
	Alias for setRT().
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 for chromatograms.

This datastructure is intended for chromatograms. If wou want to annotated single peaks with meta data, use RichChromatogramPeak instead.

---

Member Typedef Documentation

typedef DoubleReal CoordinateType

Coordinate type.

typedef DoubleReal IntensityType

Intensity type.

typedef DPosition<1> PositionType

Position type.

---

Member Enumeration Documentation

anonymous enum

Dimension.

Enumerator:

DIMENSION

---

Constructor & Destructor Documentation

ChromatogramPeak

(

)

[inline]

Default constructor.

ChromatogramPeak

(

const ChromatogramPeak &

p

)

[inline]

Copy constructor.

~ChromatogramPeak

(

)

[inline]

Destructor.

Note:

The destructor is non-virtual although many classes are derived from ChromatogramPeak. This is intentional, since otherwise we would "waste" space for a vtable pointer in each instance. Normally you should not derive other classes from ChromatogramPeak (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 ChromatogramPeak::IntensityLess::operator()().

CoordinateType getMZ

(

)

const [inline]

Alias for getRT().

CoordinateType getPos

(

)

const [inline]

Alias for getRT().

Referenced by ChromatogramPeak::RTLess::operator()().

PositionType const& getPosition

(

)

const [inline]

Non-mutable access to the position.

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

PositionType& getPosition

(

)

[inline]

Mutable access to the position.

CoordinateType getRT

(

)

const [inline]

Non-mutable access to RT.

Referenced by ChromatogramPeak::RTLess::operator()().

bool operator!=

(

const ChromatogramPeak &

rhs

)

const [inline]

Equality operator.

ChromatogramPeak& operator=

(

const ChromatogramPeak &

rhs

)

[inline]

Assignment operator.

References ChromatogramPeak::intensity_, and ChromatogramPeak::position_.

bool operator==

(

const ChromatogramPeak &

rhs

)

const [inline]

Equality operator.

References ChromatogramPeak::intensity_, and ChromatogramPeak::position_.

void setIntensity

(

IntensityType

intensity

)

[inline]

Mutable access to the data point intensity (height).

Referenced by MSExperiment< SimPointType >::getTIC(), and CachedmzML::readChromatogram_().

void setMZ

(

CoordinateType

rt

)

[inline]

Alias for setRT().

void setPos

(

CoordinateType

pos

)

[inline]

Alias for setRT().

void setPosition

(

PositionType const &

position

)

[inline]

Mutable access to the position.

void setRT

(

CoordinateType

rt

)

[inline]

Mutable access to RT.

Referenced by MSExperiment< SimPointType >::getTIC(), and CachedmzML::readChromatogram_().

---

Member Data Documentation

IntensityType intensity_ [protected]

The data point intensity.

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

PositionType position_ [protected]

The data point position.

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