Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | List of all members
RichPeak1D Class Reference

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

#include <OpenMS/KERNEL/RichPeak1D.h>

Inheritance diagram for RichPeak1D:
Peak1D MetaInfoInterface

Public Member Functions

 RichPeak1D ()
 Default constructor. More...
 
 RichPeak1D (const RichPeak1D &p)
 Copy constructor. More...
 
 ~RichPeak1D ()
 Destructor. More...
 
RichPeak1Doperator= (const RichPeak1D &rhs)
 Assignment operator. More...
 
bool operator== (const RichPeak1D &rhs) const
 Equality operator. More...
 
bool operator!= (const RichPeak1D &rhs) const
 Equality operator. More...
 
- Public Member Functions inherited from Peak1D
Peak1Doperator= (const Peak1D &rhs)
 Assignment operator. More...
 
bool operator== (const Peak1D &rhs) const
 Equality operator. More...
 
bool operator!= (const Peak1D &rhs) const
 Equality operator. More...
 
 Peak1D ()
 
 Peak1D (PositionType a, IntensityType b)
 construct with position and intensity More...
 
 Peak1D (const Peak1D &p)
 Copy constructor. More...
 
 ~Peak1D ()
 Destructor. More...
 
IntensityType getIntensity () const
 
void setIntensity (IntensityType intensity)
 Mutable access to the data point intensity (height) More...
 
CoordinateType getMZ () const
 Non-mutable access to m/z. More...
 
void setMZ (CoordinateType mz)
 Mutable access to m/z. More...
 
CoordinateType getPos () const
 Alias for getMZ() More...
 
void setPos (CoordinateType pos)
 Alias for setMZ() More...
 
PositionType const & getPosition () const
 Non-mutable access to the position. More...
 
PositionTypegetPosition ()
 Mutable access to the position. More...
 
void setPosition (PositionType const &position)
 Mutable access to the position. More...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 constructor More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 copy constructor More...
 
 ~MetaInfoInterface ()
 destructor More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 assignment operator More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValuegetMetaValue (const String &name) const
 returns the value corresponding to a string More...
 
const DataValuegetMetaValue (UInt index) const
 returns the value corresponding to an index More...
 
bool metaValueExists (const String &name) const
 returns if this MetaInfo is set More...
 
bool metaValueExists (UInt index) const
 returns if this MetaInfo is set 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...
 

Additional Inherited Members

- Public Types inherited from Peak1D
enum  { DIMENSION = 1 }
 
typedef float IntensityType
 Intensity type. More...
 
typedef DPosition< 1 > PositionType
 Position type. More...
 
typedef double CoordinateType
 Coordinate type. More...
 
- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 returns a reference to the MetaInfoRegistry More...
 
- Protected Member Functions inherited from MetaInfoInterface
void createIfNotExists_ ()
 creates the MetaInfo object if it does not exist More...
 
- Protected Attributes inherited from Peak1D
PositionType position_
 The data point position. More...
 
IntensityType intensity_
 The data point intensity. More...
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 pointer to the MetaInfo object. 0 by default More...
 

Detailed Description

A 1-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 Peak1D instead.

Constructor & Destructor Documentation

RichPeak1D ( )
inline

Default constructor.

RichPeak1D ( const RichPeak1D p)
inline

Copy constructor.

~RichPeak1D ( )
inline

Destructor.

Member Function Documentation

bool operator!= ( const RichPeak1D rhs) const
inline

Equality operator.

RichPeak1D& operator= ( const RichPeak1D rhs)
inline

Assignment operator.

References MetaInfoInterface::operator=(), and Peak1D::operator=().

bool operator== ( const RichPeak1D rhs) const
inline

Equality operator.

References MetaInfoInterface::operator==(), and Peak1D::operator==().


OpenMS / TOPP release 2.0.0 Documentation generated on Thu Aug 20 2015 01:44:39 using doxygen 1.8.9.1