OpenMS
ConsensusIDAlgorithmAverage Class Reference

Calculates a consensus from multiple ID runs by averaging the search scores. More...

#include <OpenMS/ANALYSIS/ID/ConsensusIDAlgorithmAverage.h>

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

Public Member Functions

 ConsensusIDAlgorithmAverage ()
 Default constructor. More...
 
- Public Member Functions inherited from ConsensusIDAlgorithm
void apply (std::vector< PeptideIdentification > &ids, const std::map< String, String > &se_info, Size number_of_runs=0)
 Calculates the consensus ID for a set of peptide identifications of one spectrum or (consensus) feature. More...
 
void apply (std::vector< PeptideIdentification > &ids, Size number_of_runs=0)
 
 ~ConsensusIDAlgorithm () override
 Virtual destructor. More...
 
- Public Member Functions inherited from DefaultParamHandler
 DefaultParamHandler (const String &name)
 Constructor with name that is displayed in error messages. More...
 
 DefaultParamHandler (const DefaultParamHandler &rhs)
 Copy constructor. More...
 
virtual ~DefaultParamHandler ()
 Destructor. More...
 
DefaultParamHandleroperator= (const DefaultParamHandler &rhs)
 Assignment operator. More...
 
virtual bool operator== (const DefaultParamHandler &rhs) const
 Equality operator. More...
 
void setParameters (const Param &param)
 Sets the parameters. More...
 
const ParamgetParameters () const
 Non-mutable access to the parameters. More...
 
const ParamgetDefaults () const
 Non-mutable access to the default parameters. More...
 
const StringgetName () const
 Non-mutable access to the name. More...
 
void setName (const String &name)
 Mutable access to the name. More...
 
const std::vector< String > & getSubsections () const
 Non-mutable access to the registered subsections. More...
 

Private Member Functions

 ConsensusIDAlgorithmAverage (const ConsensusIDAlgorithmAverage &)
 Not implemented. More...
 
ConsensusIDAlgorithmAverageoperator= (const ConsensusIDAlgorithmAverage &)
 Not implemented. More...
 
double getAggregateScore_ (std::vector< double > &scores, bool higher_better) override
 Aggregate peptide scores into one final score (by averaging) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DefaultParamHandler
static void writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const String &key_prefix="")
 Writes all parameters to meta values. More...
 
- Protected Types inherited from ConsensusIDAlgorithm
typedef std::map< AASequence, HitInfoSequenceGrouping
 Mapping: peptide sequence -> (charge, scores) More...
 
- Protected Member Functions inherited from ConsensusIDAlgorithmIdentity
 ConsensusIDAlgorithmIdentity ()
 Default constructor. More...
 
virtual void preprocess_ (std::vector< PeptideIdentification > &ids)
 Preprocessing of peptide IDs (in the beginning of "apply_"). More...
 
- Protected Member Functions inherited from ConsensusIDAlgorithm
 ConsensusIDAlgorithm ()
 Default constructor. More...
 
void updateMembers_ () override
 Docu in base class. More...
 
void compareChargeStates_ (Int &recorded_charge, Int new_charge, const AASequence &peptide)
 Compare (and possibly update) charge state information. More...
 
- Protected Member Functions inherited from DefaultParamHandler
void defaultsToParam_ ()
 Updates the parameters after the defaults have been set in the constructor. More...
 
- Protected Attributes inherited from ConsensusIDAlgorithm
Size considered_hits_
 Number of peptide hits considered per ID run (input parameter) More...
 
Size number_of_runs_
 Number of ID runs. More...
 
double min_support_
 Fraction of required support by other ID runs (input parameter) More...
 
bool count_empty_
 Count empty runs in "min_support" calculation? (input parameter) More...
 
bool keep_old_scores_
 Keep old scores? More...
 
- Protected Attributes inherited from DefaultParamHandler
Param param_
 Container for current parameters. More...
 
Param defaults_
 Container for default parameters. This member should be filled in the constructor of derived classes! More...
 
std::vector< Stringsubsections_
 Container for registered subsections. This member should be filled in the constructor of derived classes! More...
 
String error_name_
 Name that is displayed in error messages during the parameter checking. More...
 
bool check_defaults_
 If this member is set to false no checking if parameters in done;. More...
 
bool warn_empty_defaults_
 If this member is set to false no warning is emitted when defaults are empty;. More...
 

Detailed Description

Calculates a consensus from multiple ID runs by averaging the search scores.

Parameters of this class are:

NameTypeDefaultRestrictionsDescription
filter:considered_hits int0 min: 0The number of top hits in each ID run that are considered for consensus scoring ('0' for all hits).
filter:min_support float0.0 min: 0.0 max: 1.0For each peptide hit from an ID run, the fraction of other ID runs that must support that hit (otherwise it is removed).
filter:count_empty stringfalse true, falseCount empty ID runs (i.e. those containing no peptide hit for the current spectrum) when calculating 'min_support'?
filter:keep_old_scores stringfalse true, falseif set, keeps the original scores as user params

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

Constructor & Destructor Documentation

◆ ConsensusIDAlgorithmAverage() [1/2]

Default constructor.

◆ ConsensusIDAlgorithmAverage() [2/2]

Not implemented.

Member Function Documentation

◆ getAggregateScore_()

double getAggregateScore_ ( std::vector< double > &  scores,
bool  higher_better 
)
overrideprivatevirtual

Aggregate peptide scores into one final score (by averaging)

Implements ConsensusIDAlgorithmIdentity.

◆ operator=()

ConsensusIDAlgorithmAverage& operator= ( const ConsensusIDAlgorithmAverage )
private

Not implemented.