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

ConsensusPeak Class Template Reference
[Kernel]

#include <OpenMS/KERNEL/ConsensusPeak.h>

Inheritance diagram for ConsensusPeak:

Peak2D Group< ContainerT > RawDataPoint2D MetaInfoInterface

List of all members.


Detailed Description

template<typename ContainerT = DPeakArray< Peak2D >>
class OpenMS::ConsensusPeak< ContainerT >

A 2-dimensional consensus peak.

A consensus peak represents corresponding peaks in multiple peakmaps.

Public Types

Type definitions
typedef Peak2D ElementType
typedef ContainerT ElementContainerType
typedef Group
< ElementContainerType
Group
typedef DPosition< 2 > PositionType
 Position type.
typedef DoubleReal IntensityType
 Intensity type.
typedef IndexTuple
< ElementContainerType
IndexTuple
typedef DRange< 2 > PositionBoundingBoxType
typedef DRange< 1 > IntensityBoundingBoxType

Public Member Functions

void insert (const IndexTuple &tuple)
const PositionBoundingBoxTypegetPositionRange () const
 Non-mutable access to the position range.
PositionBoundingBoxTypegetPositionRange ()
 Mutable access to the position range.
void setPositionRange (const PositionBoundingBoxType &p)
 Set the position range.
const IntensityBoundingBoxTypegetIntensityRange () const
 Non-mutable access to the intensity range.
IntensityBoundingBoxTypegetIntensityRange ()
 Mutable access to the intensity range.
void setIntensityRange (const IntensityBoundingBoxType &i)
 Set the intensity range.
const GroupgetPeaks () const
 Non-mutable access to the combined peaks.
GroupgetPeaks ()
 Mutable access to the combined peaks.
void setPeaks (const Group &g)
 Set the combined peaks.
Constructors and Destructor
 ConsensusPeak ()
 Default constructor.
 ConsensusPeak (const PositionType &pos, IntensityType i)
 ConsensusPeak (UInt map_index, UInt peak_index, const ElementType &peak)
 Constructor for a singleton consensus peak.
 ConsensusPeak (UInt map_1_index, UInt peak_index_1, const ElementType &peak_1, UInt map_2_index, UInt peak_index_2, const ElementType &peak_2)
 Constructor.
 ConsensusPeak (UInt map_index, UInt peak_index, const ElementType &peak, const ConsensusPeak &c_peak)
 Constructor.
 ConsensusPeak (const ConsensusPeak &c_peak_1, const ConsensusPeak &c_peak_2)
 Constructor.
 ConsensusPeak (const ConsensusPeak &source)
 Copy constructor.
ConsensusPeakoperator= (const ConsensusPeak &source)
 Assignement operator.
virtual ~ConsensusPeak ()
 Destructor.

Protected Member Functions

void computeConsensus_ ()

Protected Attributes

PositionBoundingBoxType position_range_
IntensityBoundingBoxType intensity_range_


Member Typedef Documentation

typedef Peak2D ElementType

typedef ContainerT ElementContainerType

typedef Group< ElementContainerType > Group

typedef DPosition< 2 > PositionType

Position type.

Reimplemented from RawDataPoint2D.

typedef DoubleReal IntensityType

Intensity type.

Reimplemented from RawDataPoint2D.

typedef IndexTuple< ElementContainerType > IndexTuple

typedef DRange<2> PositionBoundingBoxType

typedef DRange<1> IntensityBoundingBoxType


Constructor & Destructor Documentation

ConsensusPeak (  )  [inline]

Default constructor.

ConsensusPeak ( const PositionType pos,
IntensityType  i 
) [inline]

ConsensusPeak ( UInt  map_index,
UInt  peak_index,
const ElementType peak 
) [inline]

Constructor for a singleton consensus peak.

ConsensusPeak ( UInt  map_1_index,
UInt  peak_index_1,
const ElementType peak_1,
UInt  map_2_index,
UInt  peak_index_2,
const ElementType peak_2 
) [inline]

Constructor.

ConsensusPeak ( UInt  map_index,
UInt  peak_index,
const ElementType peak,
const ConsensusPeak< ContainerT > &  c_peak 
) [inline]

Constructor.

ConsensusPeak ( const ConsensusPeak< ContainerT > &  c_peak_1,
const ConsensusPeak< ContainerT > &  c_peak_2 
) [inline]

Constructor.

ConsensusPeak ( const ConsensusPeak< ContainerT > &  source  )  [inline]

Copy constructor.

virtual ~ConsensusPeak (  )  [inline, virtual]

Destructor.


Member Function Documentation

ConsensusPeak& operator= ( const ConsensusPeak< ContainerT > &  source  )  [inline]

Assignement operator.

void insert ( const IndexTuple tuple  )  [inline]

const PositionBoundingBoxType& getPositionRange (  )  const [inline]

Non-mutable access to the position range.

PositionBoundingBoxType& getPositionRange (  )  [inline]

Mutable access to the position range.

void setPositionRange ( const PositionBoundingBoxType p  )  [inline]

Set the position range.

const IntensityBoundingBoxType& getIntensityRange (  )  const [inline]

Non-mutable access to the intensity range.

IntensityBoundingBoxType& getIntensityRange (  )  [inline]

Mutable access to the intensity range.

void setIntensityRange ( const IntensityBoundingBoxType i  )  [inline]

Set the intensity range.

const Group& getPeaks (  )  const [inline]

Non-mutable access to the combined peaks.

Group& getPeaks (  )  [inline]

Mutable access to the combined peaks.

void setPeaks ( const Group g  )  [inline]

Set the combined peaks.

void computeConsensus_ (  )  [inline, protected]


Member Data Documentation

PositionBoundingBoxType position_range_ [protected]

IntensityBoundingBoxType intensity_range_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:45 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1