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

FeatureMap Class Template Reference
[Kernel]

#include <OpenMS/KERNEL/FeatureMap.h>

Inheritance diagram for FeatureMap:

RangeManager< 2 > ExperimentalSettings MetaInfoInterface

List of all members.


Detailed Description

template<typename FeatureT = Feature>
class OpenMS::FeatureMap< FeatureT >

A container for (composite) features.

A map is a container holding 2-dimensional features, which in turn represent chemical entities (peptides, proteins, etc.) found in a 2-dimensional experiment. Maps are implemented as vectors of features and have basically the same interface as an STL vector has (model of Random Access Container and Back Insertion Sequence). Maps are typically created from peak data of 2D runs through the FeatureFinder.

Public Types

Type definitions
typedef FeatureT FeatureType
typedef RangeManager< 2 > RangeManagerType
typedef std::vector< FeatureTypeBase
typedef Base::iterator Iterator
typedef Base::const_iterator ConstIterator
typedef Base::reverse_iterator ReverseIterator
typedef
Base::const_reverse_iterator 
ConstReverseIterator
typedef FeatureTypeReference
typedef const FeatureTypeConstReference

Public Member Functions

FeatureMapoperator= (const FeatureMap &rhs)
 Assignment operator.
bool operator== (const FeatureMap &rhs) const
 Equality operator.
bool operator!= (const FeatureMap &rhs) const
 Equality operator.
void sortByIntensity ()
 Sort features by intensity.
void sortByPosition ()
 Sort features by position.
void sortByNthPosition (UInt i) throw (Exception::NotImplemented)
 Sort features by position i.
void sortByOverallQuality ()
void updateRanges ()
 Updates minimum and maximum position/intensity.
Constructors and Destructor
 FeatureMap ()
 Default constructor.
 FeatureMap (const FeatureMap &map)
 Copy constructor.
virtual ~FeatureMap ()
 Destructor.


Member Typedef Documentation

typedef FeatureT FeatureType

typedef RangeManager<2> RangeManagerType

typedef std::vector<FeatureType> Base

typedef Base::iterator Iterator

typedef Base::const_iterator ConstIterator

typedef Base::reverse_iterator ReverseIterator

typedef Base::const_reverse_iterator ConstReverseIterator

typedef FeatureType& Reference

typedef const FeatureType& ConstReference


Constructor & Destructor Documentation

FeatureMap (  )  [inline]

Default constructor.

FeatureMap ( const FeatureMap< FeatureT > &  map  )  [inline]

Copy constructor.

virtual ~FeatureMap (  )  [inline, virtual]

Destructor.


Member Function Documentation

FeatureMap& operator= ( const FeatureMap< FeatureT > &  rhs  )  [inline]

Assignment operator.

bool operator== ( const FeatureMap< FeatureT > &  rhs  )  const [inline]

Equality operator.

bool operator!= ( const FeatureMap< FeatureT > &  rhs  )  const [inline]

Equality operator.

void sortByIntensity (  )  [inline]

Sort features by intensity.

void sortByPosition (  )  [inline]

Sort features by position.

Lexicographical sorting from dimention 0 to dimension 1 is performed.

void sortByNthPosition ( UInt  i  )  throw (Exception::NotImplemented) [inline]

Sort features by position i.

Features are only sorted by position i.

void sortByOverallQuality (  )  [inline]

void updateRanges (  )  [inline, virtual]

Updates minimum and maximum position/intensity.

This method is usually implemented by calling clearRanges() and updateRanges_() or updateRanges1D_().

Implements RangeManager< 2 >.


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