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

ConsensusFeature Class Template Reference
[Kernel]

#include <OpenMS/KERNEL/ConsensusFeature.h>

Inheritance diagram for ConsensusFeature:

Feature Group< ContainerT > Peak2D RawDataPoint2D MetaInfoInterface

List of all members.


Detailed Description

template<typename ContainerT = FeatureMap< >>
class OpenMS::ConsensusFeature< ContainerT >

A 2-dimensional consensus feature.

A consensus feature represents corresponding features in multiple featuremaps.

Public Types

Type definitions
typedef Feature BaseElementType
typedef ContainerT ElementContainerType
typedef
ElementContainerType::value_type 
ElementType
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 GroupgetFeatures () const
 Non-mutable access to the combined features.
GroupgetFeatures ()
 Mutable access to the combined features.
void setFeatures (const Group &g)
 Set the combined features.
Constructors and Destructor
 ConsensusFeature ()
 Default constructor.
 ConsensusFeature (const PositionType &pos, IntensityType i)
 ConsensusFeature (UInt map_index, UInt feature_index, const ElementType &feature)
 Constructor for a singleton consensus feature.
 ConsensusFeature (UInt map_1_index, UInt feature_index_1, const ElementType &feature_1, UInt map_2_index, UInt feature_index_2, const ElementType &feature_2)
 Constructor.
 ConsensusFeature (UInt map_index, UInt feature_index, const ElementType &feature, const ConsensusFeature &c_feature)
 Constructor.
 ConsensusFeature (const ConsensusFeature &c_feature_1, const ConsensusFeature &c_feature_2)
 Constructor.
 ConsensusFeature (const ConsensusFeature &source)
 Copy constructor.
ConsensusFeatureoperator= (const ConsensusFeature &source)
 Assignement operator.
virtual ~ConsensusFeature ()
 Destructor.

Protected Member Functions

void computeConsensus_ ()

Protected Attributes

PositionBoundingBoxType position_range_
IntensityBoundingBoxType intensity_range_


Member Typedef Documentation

typedef Feature BaseElementType

typedef ContainerT ElementContainerType

typedef ElementContainerType::value_type ElementType

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

ConsensusFeature (  )  [inline]

Default constructor.

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

ConsensusFeature ( UInt  map_index,
UInt  feature_index,
const ElementType feature 
) [inline]

Constructor for a singleton consensus feature.

ConsensusFeature ( UInt  map_1_index,
UInt  feature_index_1,
const ElementType feature_1,
UInt  map_2_index,
UInt  feature_index_2,
const ElementType feature_2 
) [inline]

Constructor.

ConsensusFeature ( UInt  map_index,
UInt  feature_index,
const ElementType feature,
const ConsensusFeature< ContainerT > &  c_feature 
) [inline]

Constructor.

ConsensusFeature ( const ConsensusFeature< ContainerT > &  c_feature_1,
const ConsensusFeature< ContainerT > &  c_feature_2 
) [inline]

Constructor.

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

Copy constructor.

virtual ~ConsensusFeature (  )  [inline, virtual]

Destructor.


Member Function Documentation

ConsensusFeature& operator= ( const ConsensusFeature< 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& getFeatures (  )  const [inline]

Non-mutable access to the combined features.

Group& getFeatures (  )  [inline]

Mutable access to the combined features.

void setFeatures ( const Group g  )  [inline]

Set the combined features.

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