OpenMS  2.7.0
Public Member Functions | Private Attributes | List of all members
GridFeature Class Reference

Representation of a feature in a hash grid. More...

#include <OpenMS/DATASTRUCTURES/GridFeature.h>

Collaboration diagram for GridFeature:
[legend]

Public Member Functions

 GridFeature (const BaseFeature &feature, Size map_index, Size feature_index)
 Detailed constructor. More...
 
const BaseFeaturegetFeature () const
 Returns the feature. More...
 
virtual ~GridFeature ()
 Destructor. More...
 
Size getMapIndex () const
 Returns the map index. More...
 
Size getFeatureIndex () const
 Returns the feature index. More...
 
Int getID () const
 Returns the ID of the GridFeature (same as the feature index) More...
 
const std::set< AASequence > & getAnnotations () const
 Returns the set of peptide sequences annotated to the cluster center. More...
 
double getRT () const
 Returns the feature RT. More...
 
double getMZ () const
 Returns the feature m/z. More...
 

Private Attributes

const BaseFeaturefeature_
 Reference to the contained feature. More...
 
Size map_index_
 Index of the feature map or consensus map. More...
 
Size feature_index_
 Index of the feature in the map. More...
 
std::set< AASequenceannotations_
 Set of peptide sequences annotated to the feature. More...
 

Detailed Description

Representation of a feature in a hash grid.

A GridFeature can be stored in a HashGrid and points to a BaseFeature (Feature or ConsensusFeature). Used for QT feature grouping (see QTClusterFinder).

Constructor & Destructor Documentation

◆ GridFeature()

GridFeature ( const BaseFeature feature,
Size  map_index,
Size  feature_index 
)

Detailed constructor.

Parameters
featureReference to the contained feature
map_indexIndex of the feature map or consensus map
feature_indexIndex of the feature in the map

◆ ~GridFeature()

virtual ~GridFeature ( )
virtual

Destructor.

Member Function Documentation

◆ getAnnotations()

const std::set<AASequence>& getAnnotations ( ) const

Returns the set of peptide sequences annotated to the cluster center.

◆ getFeature()

const BaseFeature& getFeature ( ) const

Returns the feature.

◆ getFeatureIndex()

Size getFeatureIndex ( ) const

Returns the feature index.

◆ getID()

Int getID ( ) const

Returns the ID of the GridFeature (same as the feature index)

◆ getMapIndex()

Size getMapIndex ( ) const

Returns the map index.

◆ getMZ()

double getMZ ( ) const

Returns the feature m/z.

◆ getRT()

double getRT ( ) const

Returns the feature RT.

Member Data Documentation

◆ annotations_

std::set<AASequence> annotations_
private

Set of peptide sequences annotated to the feature.

◆ feature_

const BaseFeature& feature_
private

Reference to the contained feature.

◆ feature_index_

Size feature_index_
private

Index of the feature in the map.

◆ map_index_

Size map_index_
private

Index of the feature map or consensus map.