This class actually implements a complete ProteinIdentification run with PILIS. More...
#include <OpenMS/ANALYSIS/ID/PILISIdentification.h>
 
  
 | Public Member Functions | |
| PILISIdentification & | operator= (const PILISIdentification &source) | 
| constructors and destructors | |
| PILISIdentification () | |
| default constructor  More... | |
| PILISIdentification (const PILISIdentification &source) | |
| copy constructor  More... | |
| virtual | ~PILISIdentification () | 
| destructor  More... | |
| Accessors | |
| void | setModel (PILISModel *hmm_model) | 
| sets the sequence DB to be used for the ProteinIdentification runs  More... | |
| void | getIdentifications (const std::vector< std::map< String, UInt > > &candidates, std::vector< PeptideIdentification > &ids, const RichPeakMap &exp) | 
| performs an ProteinIdentification run on a RichPeakMap  More... | |
| void | getIdentification (const std::map< String, UInt > &candidates, PeptideIdentification &id, const RichPeakSpectrum &spectrum) | 
| performs an ProteinIdentification run on a PeakSpectrum  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... | |
| virtual DefaultParamHandler & | operator= (const DefaultParamHandler &rhs) | 
| Assignment operator.  More... | |
| virtual bool | operator== (const DefaultParamHandler &rhs) const | 
| Equality operator.  More... | |
| void | setParameters (const Param ¶m) | 
| Sets the parameters.  More... | |
| const Param & | getParameters () const | 
| Non-mutable access to the parameters.  More... | |
| const Param & | getDefaults () const | 
| Non-mutable access to the default parameters.  More... | |
| const String & | getName () 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... | |
| Protected Member Functions | |
| void | getSpectrum_ (RichPeakSpectrum &spec, const String &sequence, int charge) | 
| fast method to create spectra for pre-scoring  More... | |
| void | getPreIdentification_ (PeptideIdentification &id, const RichPeakSpectrum &spec, const std::map< String, UInt > &cand_peptides) | 
| performs a pre-scoring of the given spec with very simple spectra from the candidate peptides  More... | |
| void | getFinalIdentification_ (PeptideIdentification &id, const RichPeakSpectrum &spec, const PeptideIdentification &pre_id) | 
| performs a ProteinIdentification via spectra comparison with the PILISModel spectrum generator  More... | |
| PILISModel * | getPILISModel_ () | 
| returns the model pointer  More... | |
| void | updateMembers_ () | 
| update members method from DefaultParamHandler to update the members  More... | |
|  Protected Member Functions inherited from DefaultParamHandler | |
| void | defaultsToParam_ () | 
| Updates the parameters after the defaults have been set in the constructor.  More... | |
| Protected Attributes | |
| PILISModel * | hmm_model_ | 
| returns the sequence database pointer  More... | |
| Map< char, double > | aa_weight_ | 
| amino acids weights for the simple spectra generator  More... | |
| PeakSpectrumCompareFunctor * | pre_scorer_ | 
| scorer for pre comparison  More... | |
| PeakSpectrumCompareFunctor * | scorer_ | 
| scorer for spectra comparison  More... | |
| RichPeak1D | p_ | 
| a peaks, just to not instantiate it over and over again  More... | |
| std::vector< RichPeakSpectrum > | sim_specs_ | 
| bool | own_sequence_db_ | 
| flag whether the istance has a internal sequence db  More... | |
| bool | own_model_ | 
| flag whether the istance has a internal model  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< String > | subsections_ | 
| 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... | |
This class actually implements a complete ProteinIdentification run with PILIS.
The PILISIdentification class needs a PILISModel and a PILISSequenceDB to generate identifications. Simply call getIdentifications with a RichPeakMap.
Parameters of this class are:| Name | Type | Default | Restrictions | Description | 
|---|---|---|---|---|
| precursor_mass_tolerance | float | 3 | Precursor mass tolerance which is used to query the peptide database for peptides | |
| peak_mass_tolerance | float | 0.3 | Peak mass tolerance to align the simulated and experimental spectra | |
| max_candidates | int | 200 | Number of candidates which are kept at the end of the identification | |
| pre_score_name | string | ZhangSimilarityScore | The prescoring which is used | |
| score_name | string | ZhangSimilarityScore | The scoring for the comparison of simulated and experimental spectrum | |
| use_evalue_scoring | int | 1 | If set to 1 EValue scoring as described in PILISScoring is used, otherwise similarity scores are directly reported | |
| fixed_modifications | string | fixed modifications to used in the format 57.001@@C | 
default constructor
| PILISIdentification | ( | const PILISIdentification & | source | ) | 
copy constructor
| 
 | virtual | 
destructor
| 
 | protected | 
performs a ProteinIdentification via spectra comparison with the PILISModel spectrum generator
| void getIdentification | ( | const std::map< String, UInt > & | candidates, | 
| PeptideIdentification & | id, | ||
| const RichPeakSpectrum & | spectrum | ||
| ) | 
performs an ProteinIdentification run on a PeakSpectrum
| void getIdentifications | ( | const std::vector< std::map< String, UInt > > & | candidates, | 
| std::vector< PeptideIdentification > & | ids, | ||
| const RichPeakMap & | exp | ||
| ) | 
performs an ProteinIdentification run on a RichPeakMap
| 
 | protected | 
returns the model pointer
| 
 | protected | 
performs a pre-scoring of the given spec with very simple spectra from the candidate peptides
| 
 | protected | 
fast method to create spectra for pre-scoring
| PILISIdentification& operator= | ( | const PILISIdentification & | source | ) | 
| void setModel | ( | PILISModel * | hmm_model | ) | 
sets the sequence DB to be used for the ProteinIdentification runs
sets the model to be used for the ProteinIdentification run
| 
 | protectedvirtual | 
update members method from DefaultParamHandler to update the members
Reimplemented from DefaultParamHandler.
| 
 | protected | 
returns the sequence database pointer
the sequence database for the candidate peptides the model for spectra simulation
| 
 | protected | 
flag whether the istance has a internal model
| 
 | protected | 
flag whether the istance has a internal sequence db
| 
 | protected | 
a peaks, just to not instantiate it over and over again
| 
 | protected | 
scorer for pre comparison
| 
 | protected | 
scorer for spectra comparison
| 
 | protected | 
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:26 using doxygen 1.8.5 |