OpenMS
Static Public Member Functions | Static Private Member Functions | List of all members
MapAlignmentTransformer Class Reference

This class collects functions for applying retention time transformations to data structures. More...

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

Static Public Member Functions

static void transformRetentionTimes (PeakMap &msexp, const TransformationDescription &trafo, bool store_original_rt=false)
 Applies the given transformation to a peak map. More...
 
static void transformRetentionTimes (FeatureMap &fmap, const TransformationDescription &trafo, bool store_original_rt=false)
 Applies the given transformation to a feature map. More...
 
static void transformRetentionTimes (ConsensusMap &cmap, const TransformationDescription &trafo, bool store_original_rt=false)
 Applies the given transformation to a consensus map. More...
 
static void transformRetentionTimes (std::vector< PeptideIdentification > &pep_ids, const TransformationDescription &trafo, bool store_original_rt=false)
 Applies the given transformation to peptide identifications. More...
 
static void transformRetentionTimes (IdentificationData &id_data, const TransformationDescription &trafo, bool store_original_rt=false)
 Applies the given transformation to input items in IdentificationData. More...
 

Static Private Member Functions

static void applyToFeature_ (Feature &feature, const TransformationDescription &trafo, bool store_original_rt=false)
 Applies a transformation to a feature. More...
 
static void applyToBaseFeature_ (BaseFeature &feature, const TransformationDescription &trafo, bool store_original_rt=false)
 Applies a transformation to a basic feature. More...
 
static void applyToConsensusFeature_ (ConsensusFeature &feature, const TransformationDescription &trafo, bool store_original_rt=false)
 Applies a transformation to a consensus feature. More...
 
static bool storeOriginalRT_ (MetaInfoInterface &meta_info, double original_rt)
 Stores the original RT in a meta value. More...
 

Detailed Description

This class collects functions for applying retention time transformations to data structures.

Member Function Documentation

◆ applyToBaseFeature_()

static void applyToBaseFeature_ ( BaseFeature &  feature,
const TransformationDescription &  trafo,
bool  store_original_rt = false 
)
staticprivate

Applies a transformation to a basic feature.

◆ applyToConsensusFeature_()

static void applyToConsensusFeature_ ( ConsensusFeature &  feature,
const TransformationDescription &  trafo,
bool  store_original_rt = false 
)
staticprivate

Applies a transformation to a consensus feature.

◆ applyToFeature_()

static void applyToFeature_ ( Feature &  feature,
const TransformationDescription &  trafo,
bool  store_original_rt = false 
)
staticprivate

Applies a transformation to a feature.

◆ storeOriginalRT_()

static bool storeOriginalRT_ ( MetaInfoInterface &  meta_info,
double  original_rt 
)
staticprivate

Stores the original RT in a meta value.

The original RT is written to a meta value "original_RT", but only if that meta value doesn't already exist.

Returns
True if the meta value was written, false if it already exists.

◆ transformRetentionTimes() [1/5]

static void transformRetentionTimes ( ConsensusMap &  cmap,
const TransformationDescription &  trafo,
bool  store_original_rt = false 
)
static

Applies the given transformation to a consensus map.

◆ transformRetentionTimes() [2/5]

static void transformRetentionTimes ( FeatureMap &  fmap,
const TransformationDescription &  trafo,
bool  store_original_rt = false 
)
static

Applies the given transformation to a feature map.

◆ transformRetentionTimes() [3/5]

static void transformRetentionTimes ( IdentificationData &  id_data,
const TransformationDescription &  trafo,
bool  store_original_rt = false 
)
static

Applies the given transformation to input items in IdentificationData.

◆ transformRetentionTimes() [4/5]

static void transformRetentionTimes ( PeakMap &  msexp,
const TransformationDescription &  trafo,
bool  store_original_rt = false 
)
static

Applies the given transformation to a peak map.

◆ transformRetentionTimes() [5/5]

static void transformRetentionTimes ( std::vector< PeptideIdentification > &  pep_ids,
const TransformationDescription &  trafo,
bool  store_original_rt = false 
)
static

Applies the given transformation to peptide identifications.