OpenMS
Loading...
Searching...
No Matches
PipEchoAlgorithm Class Reference

Match-between-runs feature grouping via the PIP-ECHO algorithm. More...

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

Inheritance diagram for PipEchoAlgorithm:
[legend]
Collaboration diagram for PipEchoAlgorithm:
[legend]

Public Member Functions

 PipEchoAlgorithm ()
 Constructor.
 
 PipEchoAlgorithm (PipEchoAlgorithm &&)=delete
 
PipEchoAlgorithmoperator= (PipEchoAlgorithm &&)=delete
 
 PipEchoAlgorithm (const PipEchoAlgorithm &other)=delete
 Copy constructor.
 
PipEchoAlgorithmoperator= (const PipEchoAlgorithm &source)=delete
 Assignment operator.
 
 ~PipEchoAlgorithm () override
 Destructor.
 
void group (const std::vector< FeatureMap > &features, ConsensusMap &consensus) override
 Groups corresponding features across the feature maps of one fraction.
 
- Public Member Functions inherited from FeatureGroupingAlgorithm
 FeatureGroupingAlgorithm ()
 Default constructor.
 
 ~FeatureGroupingAlgorithm () override
 Destructor.
 
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.
 
- Public Member Functions inherited from DefaultParamHandler
 DefaultParamHandler (const std::string &name)
 Constructor with name that is displayed in error messages.
 
 DefaultParamHandler (const DefaultParamHandler &rhs)
 Copy constructor.
 
virtual ~DefaultParamHandler ()
 Destructor.
 
DefaultParamHandleroperator= (const DefaultParamHandler &rhs)
 Assignment operator.
 
virtual bool operator== (const DefaultParamHandler &rhs) const
 Equality operator.
 
void setParameters (const Param &param)
 Sets the parameters.
 
const ParamgetParameters () const
 Non-mutable access to the parameters.
 
const ParamgetDefaults () const
 Non-mutable access to the default parameters.
 
const std::string & getName () const
 Non-mutable access to the name.
 
void setName (const std::string &name)
 Mutable access to the name.
 
const std::vector< std::string > & getSubsections () const
 Non-mutable access to the registered subsections.
 

Additional Inherited Members

- Static Public Member Functions inherited from DefaultParamHandler
static void writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const std::string &key_prefix="")
 Writes all parameters to meta values.
 
- Protected Member Functions inherited from FeatureGroupingAlgorithm
template<class MapType >
void postprocess_ (const std::vector< MapType > &maps, ConsensusMap &out)
 
- Protected Member Functions inherited from DefaultParamHandler
virtual void updateMembers_ ()
 This method is used to update extra member variables at the end of the setParameters() method.
 
void defaultsToParam_ ()
 Updates the parameters after the defaults have been set in the constructor.
 
- Protected Attributes inherited from DefaultParamHandler
Param param_
 Container for current parameters.
 
Param defaults_
 Container for default parameters. This member should be filled in the constructor of derived classes!
 
std::vector< std::string > subsections_
 Container for registered subsections. This member should be filled in the constructor of derived classes!
 
std::string error_name_
 Name that is displayed in error messages during the parameter checking.
 
bool check_defaults_
 If this member is set to false no checking if parameters in done;.
 
bool warn_empty_defaults_
 If this member is set to false no warning is emitted when defaults are empty;.
 

Detailed Description

Match-between-runs feature grouping via the PIP-ECHO algorithm.

Groups features that represent the same identified peptide across multiple retention-time-aligned LC-MS runs of a single fraction. Identifications are transferred to runs in which a feature was detected but not identified (match-between-runs); candidate transfers are scored and filtered at a controlled false-discovery rate using a target/decoy model.

Parameters of this class are:

NameTypeDefaultRestrictionsDescription
fdr float0.05 min: 0.0 max: 1.0MBR FDR threshold (0.05=5%).
random_seed int0  Seed for the random number generator used to select decoy donors. A fixed seed makes results reproducible.
min_decoys int20 min: 1Minimum number of MBR decoy transfers required before any transferred feature is kept. Transferred features are also dropped whenever the requested 'fdr' cannot be resolved by the available decoys (1/decoys > fdr). When transfers are dropped, only direct identifications are retained. A 'fdr' of 1.0 disables FDR control and keeps all transfers regardless of this value.
max_training_points int50000 min: 0Upper bound on the number of candidate transfers used to TRAIN the transfer-FDR SVM in each cross-validation fold (0 = unlimited). Predictions and the FDR/q-values are always computed over ALL transfers, so this only bounds the SVM-fitting cost and does not change which transfers are scored. Runs with very many features per run can otherwise make the SVM grid search slow. When the cap is hit, a deterministic stratified subsample is used: both labelled classes (decoys and positives) are kept whole if they fit, otherwise the minority class is kept whole and the majority is score-spread sampled to fit the budget.
distance_RT:max_difference float100.0 min: 0.0Never pair features with a larger RT distance (in seconds).
distance_MZ:max_difference float10.0 min: 0.0Never pair features with larger m/z distance (unit defined by 'unit')
distance_MZ:unit stringppm Da, ppmUnit of the 'max_difference' parameter
local_rt:enabled stringtrue true, falseUse a LOCAL adaptive retention-time window for MBR candidate search instead of the single global RT window ('distance_RT:max_difference'). For each donor the expected acceptor RT is predicted from nearby peptides identified in BOTH runs (local alignment) and the search window is sized from the local RT scatter, sharpening the RT feature and removing much of the false in-window background. The window is widened adaptively if too few decoys are produced to resolve the FDR. Set 'false' to restore the legacy single global RT window.
local_rt:max_window float100.0 min: 0.0Maximum half-width (seconds) of the local RT window before adaptive widening (backstop cap on the data-driven width).
local_rt:min_window float5.0 min: 0.0Minimum half-width (seconds) of the local RT window.
local_rt:anchor_window float120.0 min: 0.0Only peptides within this RT distance (seconds) of the donor are used as local-alignment anchors.
local_rt:anchors int3 min: 1Maximum number of anchor peptides per side used for the local RT prediction.
local_rt:sigma_scale float3.0 min: 0.0Local RT window half-width = this multiple of the local anchor RT-shift standard deviation.
local_rt:fallback_window float15.0 min: 0.0Half-width (seconds) used when fewer than two local anchors are available.
local_rt:auto stringtrue true, falseEstimate the local RT window scales (max_window, min_window, anchor_window, fallback_window) from the data instead of using the fixed values above, so one configuration adapts across short and long gradients. Derived from the RT-shift scatter of shared anchors and the anchor density; uses 'median_fwhm' as a physical lower guard when provided.
local_rt:median_fwhm float0.0 min: 0.0Chromatographic peak FWHM (seconds) used as a physical lower guard when 'auto' is enabled (0 = estimate window scales from RT residuals and anchor density only). Set by the host tool (e.g. ProteomicsLFQ) which has raw-spectra context.
local_rt:rt_score stringsvm_and_mbr raw, svm, svm_and_mbrHow the retention-time feature is used on the local RT path. 'raw': the raw |Δrt| is the SVM predictor (legacy). 'svm': a calibrated [0,1] RT-agreement score (FlashLFQ-style two-tailed CDF against the data-driven RT prediction-error distribution) replaces it as the SVM predictor. 'svm_and_mbr': as 'svm', and the calibrated score also enters the bootstrap geometric mean. Ignored unless 'enabled'.

Note:
  • If a section name is documented, the documentation is displayed as tooltip.
  • Advanced parameter names are italic.

Constructor & Destructor Documentation

◆ PipEchoAlgorithm() [1/3]

Constructor.

◆ PipEchoAlgorithm() [2/3]

◆ PipEchoAlgorithm() [3/3]

PipEchoAlgorithm ( const PipEchoAlgorithm other)
delete

Copy constructor.

◆ ~PipEchoAlgorithm()

~PipEchoAlgorithm ( )
override

Destructor.

Member Function Documentation

◆ group()

void group ( const std::vector< FeatureMap > &  features,
ConsensusMap consensus 
)
overridevirtual

Groups corresponding features across the feature maps of one fraction.

Features representing the same identified peptide are grouped together and, where possible, identifications are transferred between runs.

Parameters
featuresThe input feature maps (same fraction) to link.
consensusThe resulting consensus map of grouped features.
Precondition
The input maps must be retention-time aligned (e.g. via a map-alignment algorithm) and originate from the same fraction.

Implements FeatureGroupingAlgorithm.

◆ operator=() [1/2]

PipEchoAlgorithm & operator= ( const PipEchoAlgorithm source)
delete

Assignment operator.

◆ operator=() [2/2]

PipEchoAlgorithm & operator= ( PipEchoAlgorithm &&  )
delete