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

RawDataPoint2D Class Reference
[Kernel]

#include <OpenMS/KERNEL/RawDataPoint2D.h>

Inheritance diagram for RawDataPoint2D:

Peak2D ConsensusPeak Feature ConsensusFeature

List of all members.


Detailed Description

2-dimensional raw data point.

This datastructure is intended for continuous data. If you want to handle picked data use Peak2D or PickedPeak2D.
enum  DimensionDescription { RT = 0, MZ = 1, DIMENSION = 2 }
 Dimensions. More...
static char const *const dimension_name_short_ [DIMENSION]
 Short name of the dimension (abbreviated form).
static char const *const dimension_name_full_ [DIMENSION]
 Full name of the dimension (self-explanatory form).
static char const *const dimension_unit_short_ [DIMENSION]
 Unit of measurement (abbreviated form).
static char const *const dimension_unit_full_ [DIMENSION]
 Unit of measurement (self-explanatory form).
static char const * shortDimensionName (UInt const dim)
 Short name of the dimension (abbreviated form).
static char const * shortDimensionNameRT ()
 Short name of the dimension (abbreviated form).
static char const * shortDimensionNameMZ ()
 Short name of the dimension (abbreviated form).
static char const * fullDimensionName (UInt const dim)
 Full name of the dimension (self-explanatory form).
static char const * fullDimensionNameRT ()
 Full name of the dimension (self-explanatory form).
static char const * fullDimensionNameMZ ()
 Full name of the dimension (self-explanatory form).
static char const * shortDimensionUnit (UInt const dim)
 Unit of measurement (abbreviated form).
static char const * shortDimensionUnitRT ()
 Unit of measurement (abbreviated form).
static char const * shortDimensionUnitMZ ()
 Unit of measurement (abbreviated form).
static char const * fullDimensionUnit (UInt const dim)
 Unit of measurement (self-explanatory form).
static char const * fullDimensionUnitRT ()
 Unit of measurement (self-explanatory form).
static char const * fullDimensionUnitMZ ()
 Unit of measurement (self-explanatory form).

Public Types

Type definitions
typedef Real IntensityType
 Intensity type.
typedef DoubleReal CoordinateType
 Coordinate type (of the position).
typedef DPosition< 2 > PositionType
 Position type.
Comparator classes.
These classes implement binary predicates that can be used to compare two peaks with respect to their intensities, positions. They are employed by the sort methods in container classes such as PeakArray.

typedef NthPositionLess< RT > LessRT
 Comparator with respect to retention time.
typedef NthPositionLess< MZ > LessMZ
 Comparator with respect to mass-to-charge.

Public Member Functions

RawDataPoint2Doperator= (const RawDataPoint2D &rhs)
 Assignment operator.
bool operator== (const RawDataPoint2D &rhs) const
 Equality operator.
bool operator!= (const RawDataPoint2D &rhs) const
 Equality operator.
Constructors and Destructor
 RawDataPoint2D ()
 Default constructor.
 RawDataPoint2D (const RawDataPoint2D &p)
 Copy constructor.
 ~RawDataPoint2D ()
 Destructor.
Accessors
IntensityType getIntensity () const
 Non-mutable access to the data point intensity (height).
void setIntensity (IntensityType intensity)
 Non-mutable access to the data point intensity (height).
PositionType const & getPosition () const
 Non-mutable access to the position.
PositionTypegetPosition ()
 Mutable access to the position.
void setPosition (const PositionType &position)
 Mutable access to the position.
CoordinateType getMZ () const
 Returns the m/z coordinate (index 1).
void setMZ (CoordinateType coordinate)
 Mutable access to the m/z coordinate (index 1).
CoordinateType getRT () const
 Returns the RT coordinate (index 0).
void setRT (CoordinateType coordinate)
 Mutable access to the RT coordinate (index 0).

Protected Attributes

PositionType position_
 The data point position.
IntensityType intensity_
 The data point intensity.

Classes

struct  IntensityLess
 Compare by getIntensity(). More...
struct  NthPositionLess
 Comparator for the n-th coordinate of the position. More...
struct  PositionLess
 Comparator for the position. More...


Member Typedef Documentation

typedef Real IntensityType

Intensity type.

Reimplemented in ConsensusFeature, and ConsensusPeak.

typedef DoubleReal CoordinateType

Coordinate type (of the position).

typedef DPosition<2> PositionType

Position type.

Reimplemented in ConsensusFeature, and ConsensusPeak.

typedef NthPositionLess< RT > LessRT

Comparator with respect to retention time.

typedef NthPositionLess< MZ > LessMZ

Comparator with respect to mass-to-charge.


Member Enumeration Documentation

enum DimensionDescription

Dimensions.

This enum maps the symbolic names of the dimensions to numbers

Enumerator:
RT  Mass-to-charge dimension id (0 if used as a const int).
MZ  Retention time dimension id (1 if used as a const int).
DIMENSION  Number of dimensions.


Constructor & Destructor Documentation

RawDataPoint2D (  )  [inline]

Default constructor.

RawDataPoint2D ( const RawDataPoint2D p  )  [inline]

Copy constructor.

~RawDataPoint2D (  )  [inline]

Destructor.

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


Member Function Documentation

static char const* shortDimensionName ( UInt const   dim  )  [static]

Short name of the dimension (abbreviated form).

static char const* shortDimensionNameRT (  )  [static]

Short name of the dimension (abbreviated form).

static char const* shortDimensionNameMZ (  )  [static]

Short name of the dimension (abbreviated form).

static char const* fullDimensionName ( UInt const   dim  )  [static]

Full name of the dimension (self-explanatory form).

static char const* fullDimensionNameRT (  )  [static]

Full name of the dimension (self-explanatory form).

static char const* fullDimensionNameMZ (  )  [static]

Full name of the dimension (self-explanatory form).

static char const* shortDimensionUnit ( UInt const   dim  )  [static]

Unit of measurement (abbreviated form).

static char const* shortDimensionUnitRT (  )  [static]

Unit of measurement (abbreviated form).

static char const* shortDimensionUnitMZ (  )  [static]

Unit of measurement (abbreviated form).

static char const* fullDimensionUnit ( UInt const   dim  )  [static]

Unit of measurement (self-explanatory form).

static char const* fullDimensionUnitRT (  )  [static]

Unit of measurement (self-explanatory form).

static char const* fullDimensionUnitMZ (  )  [static]

Unit of measurement (self-explanatory form).

IntensityType getIntensity (  )  const [inline]

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

void setIntensity ( IntensityType  intensity  )  [inline]

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

PositionType const& getPosition (  )  const [inline]

Non-mutable access to the position.

PositionType& getPosition (  )  [inline]

Mutable access to the position.

void setPosition ( const PositionType position  )  [inline]

Mutable access to the position.

CoordinateType getMZ (  )  const [inline]

Returns the m/z coordinate (index 1).

void setMZ ( CoordinateType  coordinate  )  [inline]

Mutable access to the m/z coordinate (index 1).

CoordinateType getRT (  )  const [inline]

Returns the RT coordinate (index 0).

void setRT ( CoordinateType  coordinate  )  [inline]

Mutable access to the RT coordinate (index 0).

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

Assignment operator.

bool operator== ( const RawDataPoint2D rhs  )  const [inline]

Equality operator.

bool operator!= ( const RawDataPoint2D rhs  )  const [inline]

Equality operator.


Member Data Documentation

char const* const dimension_name_short_[DIMENSION] [static, protected]

Short name of the dimension (abbreviated form).

char const* const dimension_name_full_[DIMENSION] [static, protected]

Full name of the dimension (self-explanatory form).

char const* const dimension_unit_short_[DIMENSION] [static, protected]

Unit of measurement (abbreviated form).

char const* const dimension_unit_full_[DIMENSION] [static, protected]

Unit of measurement (self-explanatory form).

PositionType position_ [protected]

The data point position.

IntensityType intensity_ [protected]

The data point intensity.


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