Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Static Public Member Functions | Private Member Functions

FeatureGroupingAlgorithm Class Reference

Base class for all feature grouping algorithms. More...

#include <OpenMS/ANALYSIS/MAPMATCHING/FeatureGroupingAlgorithm.h>

Inheritance diagram for FeatureGroupingAlgorithm:
DefaultParamHandler FeatureGroupingAlgorithmIdentification FeatureGroupingAlgorithmLabeled FeatureGroupingAlgorithmQT FeatureGroupingAlgorithmUnlabeled

List of all members.

Public Member Functions

 FeatureGroupingAlgorithm ()
 Default constructor.
virtual ~FeatureGroupingAlgorithm ()
 Destructor.
virtual void group (const std::vector< FeatureMap<> > &maps, ConsensusMap &out)=0
 Applies the algorithm. The features in the input maps are grouped and the output is written to the consensus map out.
virtual void group (const std::vector< ConsensusMap > &maps, ConsensusMap &out)
void transferSubelements (const std::vector< ConsensusMap > &maps, ConsensusMap &out) const
 Transfers subelements (grouped features) from input consensus maps to the result consensus map.

Static Public Member Functions

static void registerChildren ()
 Register all derived classes in this method.

Private Member Functions

 FeatureGroupingAlgorithm (const FeatureGroupingAlgorithm &)
 Copy constructor is not implemented -> private.
FeatureGroupingAlgorithmoperator= (const FeatureGroupingAlgorithm &)
 Assignment operator is not implemented -> private.

Detailed Description

Base class for all feature grouping algorithms.

These algorithms group corresponding features in one map or across maps.


Constructor & Destructor Documentation

Default constructor.

virtual ~FeatureGroupingAlgorithm (  )  [virtual]

Destructor.

Copy constructor is not implemented -> private.


Member Function Documentation

virtual void group ( const std::vector< FeatureMap<> > &  maps,
ConsensusMap out 
) [pure virtual]

Applies the algorithm. The features in the input maps are grouped and the output is written to the consensus map out.

Implemented in FeatureGroupingAlgorithmIdentification, FeatureGroupingAlgorithmLabeled, FeatureGroupingAlgorithmQT, and FeatureGroupingAlgorithmUnlabeled.

virtual void group ( const std::vector< ConsensusMap > &  maps,
ConsensusMap out 
) [virtual]

Applies the algorithm. The consensus features in the input maps are grouped and the output is written to the consensus map out Algorithms not supporting ConsensusMap input should simply not override this method, as the base implementation will forward the data to the FeatureMap version of group()

Reimplemented in FeatureGroupingAlgorithmQT.

FeatureGroupingAlgorithm& operator= ( const FeatureGroupingAlgorithm  )  [private]

Assignment operator is not implemented -> private.

static void registerChildren (  )  [static]

Register all derived classes in this method.

void transferSubelements ( const std::vector< ConsensusMap > &  maps,
ConsensusMap out 
) const

Transfers subelements (grouped features) from input consensus maps to the result consensus map.


OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:49 using doxygen 1.7.1