| OpenMS 2.5.0

Public Member Functions | List of all members
RichPeak2D Class Reference
Kernel

A 2-dimensional raw data point or peak with meta information. More...

`#include <OpenMS/KERNEL/RichPeak2D.h>`

Inheritance diagram for RichPeak2D:

## Public Member Functions

| RichPeak2D ()
| Default constructor. More...
| RichPeak2D (const RichPeak2D &p)=default
| Copy constructor. More...
| RichPeak2D (const Peak2D &p)
| Constructor from Peak2D. More...
| RichPeak2D (const PositionType &pos, const IntensityType in)
| Member constructor. More...
| RichPeak2D (RichPeak2D &&p)=default
| Move constructor. More...
| ~RichPeak2D () override
| Destructor. More...
RichPeak2D & | operator= (const RichPeak2D &rhs)=default
| Assignment operator. More...
RichPeak2D & | operator= (RichPeak2D &&rhs) &=default
| Move Assignment operator. More...
RichPeak2D & | operator= (const Peak2D &rhs)
| Assignment operator. More...
bool | operator== (const RichPeak2D &rhs) const
| Equality operator. More...
bool | operator!= (const RichPeak2D &rhs) const
| Equality operator. More...
Public Member Functions inherited from Peak2D
Peak2D & | operator= (const Peak2D &rhs)=default
| Assignment operator. More...
Peak2D & | operator= (Peak2D &&) &=default
| Move assignment operator. More...
bool | operator== (const Peak2D &rhs) const
| Equality operator. More...
bool | operator!= (const Peak2D &rhs) const
| Equality operator. More...
| Peak2D ()
| Peak2D (const PositionType &pos, const IntensityType in)
| Member constructor. More...
| Peak2D (const Peak2D &p)=default
| Copy constructor. More...
| Peak2D (Peak2D &&)=default
| Move constructor. More...
| ~Peak2D ()
| Destructor. More...
IntensityType | getIntensity () const
void | setIntensity (IntensityType intensity)
| Non-mutable access to the data point intensity (height) More...
PositionType const & | getPosition () const
| Non-mutable access to the position. More...
PositionType & | getPosition ()
| Mutable access to the position. More...
void | setPosition (const PositionType &position)
| Mutable access to the position. More...
CoordinateType | getMZ () const
| Returns the m/z coordinate (index 1) More...
void | setMZ (CoordinateType coordinate)
| Mutable access to the m/z coordinate (index 1) More...
CoordinateType | getRT () const
| Returns the RT coordinate (index 0) More...
void | setRT (CoordinateType coordinate)
| Mutable access to the RT coordinate (index 0) More...
Public Member Functions inherited from MetaInfoInterface
| MetaInfoInterface ()
| Constructor. More...
| MetaInfoInterface (const MetaInfoInterface &rhs)
| Copy constructor. More...
| MetaInfoInterface (MetaInfoInterface &&) noexcept
| Move constructor. More...
| ~MetaInfoInterface ()
| Destructor. More...
MetaInfoInterface & | operator= (const MetaInfoInterface &rhs)
| Assignment operator. More...
MetaInfoInterface & | operator= (MetaInfoInterface &&) noexcept
| Move assignment operator. More...
bool | operator== (const MetaInfoInterface &rhs) const
| Equality operator. More...
bool | operator!= (const MetaInfoInterface &rhs) const
| Equality operator. More...
const DataValue & | getMetaValue (const String &name, const DataValue &default_value=DataValue::EMPTY) const
| Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More...
const DataValue & | getMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const
| Returns the value corresponding to an index, or a default value (default: DataValue::EMPTY) if not found. More...
bool | metaValueExists (const String &name) const
| Returns whether an entry with the given name exists. More...
bool | metaValueExists (UInt index) const
| Returns whether an entry with the given index exists. More...
void | setMetaValue (const String &name, const DataValue &value)
| Sets the DataValue corresponding to a name. More...
void | setMetaValue (UInt index, const DataValue &value)
| Sets the DataValue corresponding to an index. More...
void | removeMetaValue (const String &name)
| Removes the DataValue corresponding to `name` if it exists. More...
void | removeMetaValue (UInt index)
| Removes the DataValue corresponding to `index` if it exists. More...
void | getKeys (std::vector< String > &keys) const
| Fills the given vector with a list of all keys for which a value is set. More...
void | getKeys (std::vector< UInt > &keys) const
| Fills the given vector with a list of all keys for which a value is set. More...
bool | isMetaEmpty () const
| Returns if the MetaInfo is empty. More...
void | clearMetaInfo ()
| Removes all meta values. More...
Public Member Functions inherited from UniqueIdInterface
| UniqueIdInterface ()
| Default constructor - the unique id will be invalid More...
| UniqueIdInterface (const UniqueIdInterface &rhs)=default
| Copy constructor - copies the unique id. More...
| UniqueIdInterface (UniqueIdInterface &&rhs)=default
| Move constructor. More...
UniqueIdInterface & | operator= (UniqueIdInterface const &rhs)=default
| Assignment operator - copies the unique id. More...
UniqueIdInterface & | operator= (UniqueIdInterface &&) &=default
| Move Assignment operator - copies the unique id. More...
virtual | ~UniqueIdInterface ()=default
| Destructor. More...
bool | operator== (UniqueIdInterface const &rhs) const
| Equality comparison operator - the unique ids must be equal (!) More...
UInt64 | getUniqueId () const
| Non-mutable access to unique id - returns the unique id. More...
Size | clearUniqueId ()
| Clear the unique id. The new unique id will be invalid. Returns 1 if the unique id was changed, 0 otherwise. More...
void | swap (UniqueIdInterface &from)
Size | hasValidUniqueId () const
| Returns whether the unique id is valid. Returns 1 if the unique id is valid, 0 otherwise. More...
Size | hasInvalidUniqueId () const
| Returns whether the unique id is invalid. Returns 1 if the unique id is invalid, 0 otherwise. More...
Size | setUniqueId ()
| Assigns a new, valid unique id. Always returns 1. More...
Size | ensureUniqueId ()
| Assigns a valid unique id, but only if the present one is invalid. Returns 1 if the unique id was changed, 0 otherwise. More...
void | setUniqueId (UInt64 rhs)
| Assigns the given unique id. More...
void | setUniqueId (const String &rhs)
| Mutable access to unique id. More...

## Additional Inherited Members

Public Types inherited from Peak2D
typedef float | IntensityType
| Intensity type. More...
typedef double | CoordinateType
| Coordinate type (of the position) More...
typedef DPosition< 2 > | PositionType
| Position type. More...
enum | DimensionDescription { RT = 0, MZ = 1, DIMENSION = 2 }
| This enum maps the symbolic names of the dimensions to numbers. More...
Public Types inherited from UniqueIdInterface
enum | { INVALID = 0 }
| This is the invalid unique id (cast it to a UInt64 if you like) More...
Static Public Member Functions inherited from Peak2D
static char const * | shortDimensionName (UInt const dim)
| Short name of the dimension (abbreviated form) More...
static char const * | shortDimensionNameRT ()
| Short name of the dimension (abbreviated form) More...
static char const * | shortDimensionNameMZ ()
| Short name of the dimension (abbreviated form) More...
static char const * | fullDimensionName (UInt const dim)
| Full name of the dimension (self-explanatory form) More...
static char const * | fullDimensionNameRT ()
| Full name of the dimension (self-explanatory form) More...
static char const * | fullDimensionNameMZ ()
| Full name of the dimension (self-explanatory form) More...
static char const * | shortDimensionUnit (UInt const dim)
| Unit of measurement (abbreviated form) More...
static char const * | shortDimensionUnitRT ()
| Unit of measurement (abbreviated form) More...
static char const * | shortDimensionUnitMZ ()
| Unit of measurement (abbreviated form) More...
static char const * | fullDimensionUnit (UInt const dim)
| Unit of measurement (self-explanatory form) More...
static char const * | fullDimensionUnitRT ()
| Unit of measurement (self-explanatory form) More...
static char const * | fullDimensionUnitMZ ()
| Unit of measurement (self-explanatory form) More...
Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistry & | metaRegistry ()
| Returns a reference to the MetaInfoRegistry. More...
Static Public Member Functions inherited from UniqueIdInterface
static bool | isValid (UInt64 unique_id)
| Returns true if the unique_id is valid, false otherwise. More...
Protected Member Functions inherited from MetaInfoInterface
void | createIfNotExists_ ()
| Creates the MetaInfo object if it does not exist. More...
Protected Attributes inherited from Peak2D
PositionType | position_
| The data point position. More...
IntensityType | intensity_
| The data point intensity. More...
Protected Attributes inherited from MetaInfoInterface
MetaInfo * | meta_
| Pointer to the MetaInfo object (0 by default) More...
Protected Attributes inherited from UniqueIdInterface
UInt64 | unique_id_
| the unique id More...
Static Protected Attributes inherited from Peak2D
static char const *const | dimension_name_short_ [DIMENSION]
| Short name of the dimension (abbreviated form) More...
static char const *const | dimension_name_full_ [DIMENSION]
| Full name of the dimension (self-explanatory form) More...
static char const *const | dimension_unit_short_ [DIMENSION]
| Unit of measurement (abbreviated form) More...
static char const *const | dimension_unit_full_ [DIMENSION]
| Unit of measurement (self-explanatory form) More...

## Detailed Description

A 2-dimensional raw data point or peak with meta information.

This data structure is intended for continuous data or peak data. If you do not need to annotated single peaks with meta data, use Peak2D instead.

## Constructor & Destructor Documentation

## ◆ RichPeak2D() [1/5]

RichPeak2D | ( |  | ) |

inline

Default constructor.

## ◆ RichPeak2D() [2/5]

RichPeak2D | ( | const RichPeak2D & | p | ) |

default

Copy constructor.

## ◆ RichPeak2D() [3/5]

RichPeak2D | ( | const Peak2D & | p | ) |

inline explicit

Constructor from Peak2D.

References UniqueIdInterface::clearUniqueId().

## ◆ RichPeak2D() [4/5]

RichPeak2D | ( | const PositionType & | pos,
|  | const IntensityType | in
| ) |  |

inline explicit

Member constructor.

## ◆ RichPeak2D() [5/5]

RichPeak2D | ( | RichPeak2D && | p | ) |

default

Move constructor.

## ◆ ~RichPeak2D()

~RichPeak2D | ( |  | ) |

inline override

Destructor.

## Member Function Documentation

## ◆ operator!=()

bool operator!= | ( | const RichPeak2D & | rhs | ) | const

inline

Equality operator.

References KDTree::operator==().

## ◆ operator=() [1/3]

RichPeak2D& operator= | ( | const RichPeak2D & | rhs | ) |

default

Assignment operator.

## ◆ operator=() [2/3]

RichPeak2D& operator= | ( | RichPeak2D && | rhs | ) | &

default

Move Assignment operator.

## ◆ operator=() [3/3]

RichPeak2D& operator= | ( | const Peak2D & | rhs | ) |

inline

Assignment operator.

References UniqueIdInterface::clearUniqueId(), and Peak2D::operator=().

## ◆ operator==()

bool operator== | ( | const RichPeak2D & | rhs | ) | const

inline

Equality operator.

References MetaInfoInterface::operator==(), UniqueIdInterface::operator==(), and Peak2D::operator==().