OpenMS  3.0.0
OpenPepXLLFAlgorithm.h
Go to the documentation of this file.
1 
2 // --------------------------------------------------------------------------
3 // OpenMS -- Open-Source Mass Spectrometry
4 // --------------------------------------------------------------------------
5 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
6 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
7 //
8 // This software is released under a three-clause BSD license:
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 // * Redistributions in binary form must reproduce the above copyright
12 // notice, this list of conditions and the following disclaimer in the
13 // documentation and/or other materials provided with the distribution.
14 // * Neither the name of any author or any participating institution
15 // may be used to endorse or promote products derived from this software
16 // without specific prior written permission.
17 // For a full list of authors, refer to the file AUTHORS.
18 // --------------------------------------------------------------------------
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
23 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 //
31 // --------------------------------------------------------------------------
32 // $Maintainer: Eugen Netz $
33 // $Authors: Eugen Netz $
34 // --------------------------------------------------------------------------
35 
36 #pragma once
37 
43 
44 namespace OpenMS
45 {
46 
47  //-------------------------------------------------------------
48  //Doxygen docu
49  //-------------------------------------------------------------
50 
103  class OPENMS_DLLAPI OpenPepXLLFAlgorithm :
104  public DefaultParamHandler, public ProgressLogger
105  {
106 public:
107 
110  {
114  INCOMPATIBLE_INPUT_DATA
115  };
116 
119 
121  ~OpenPepXLLFAlgorithm() override;
122 
135  ExitCodes run(PeakMap& unprocessed_spectra, std::vector<FASTAFile::FASTAEntry>& fasta_db, std::vector<ProteinIdentification>& protein_ids, std::vector<PeptideIdentification>& peptide_ids, std::vector< std::vector< OPXLDataStructs::CrossLinkSpectrumMatch > >& all_top_csms, PeakMap& spectra);
136 
137 private:
138  void updateMembers_() override;
139 
142 
148 
152 
158 
165 
170 
178  };
179 }
OpenMS::OpenPepXLLFAlgorithm::add_y_ions_
String add_y_ions_
Definition: OpenPepXLLFAlgorithm.h:171
DefaultParamHandler.h
OpenMS::OpenPepXLLFAlgorithm::cross_link_mass_mono_link_
DoubleList cross_link_mass_mono_link_
Definition: OpenPepXLLFAlgorithm.h:156
OpenMS::OpenPepXLLFAlgorithm::fragment_mass_tolerance_
double fragment_mass_tolerance_
Definition: OpenPepXLLFAlgorithm.h:149
ConsensusXMLFile.h
OpenMS::TOPPBase
Base class for TOPP applications.
Definition: TOPPBase.h:147
OpenMS::MzIdentMLFile::store
void store(const String &filename, const std::vector< ProteinIdentification > &poid, const std::vector< PeptideIdentification > &peid) const
Stores the identifications in a MzIdentML file.
OpenMS::OpenPepXLLFAlgorithm::use_sequence_tags_
bool use_sequence_tags_
Definition: OpenPepXLLFAlgorithm.h:168
OpenMS::OpenPepXLLFAlgorithm::deisotope_mode_
String deisotope_mode_
Definition: OpenPepXLLFAlgorithm.h:167
OpenMS::OpenPepXLLFAlgorithm::fragment_mass_tolerance_xlinks_
double fragment_mass_tolerance_xlinks_
Definition: OpenPepXLLFAlgorithm.h:150
XQuestResultXMLFile.h
VersionInfo.h
OpenMS::OpenPepXLLFAlgorithm::add_z_ions_
String add_z_ions_
Definition: OpenPepXLLFAlgorithm.h:176
OpenMS::IdXMLFile::store
void store(const String &filename, const std::vector< ProteinIdentification > &protein_ids, const std::vector< PeptideIdentification > &peptide_ids, const String &document_id="")
Stores the data in an idXML file.
OpenMS::OpenPepXLLFAlgorithm::precursor_correction_steps_
IntList precursor_correction_steps_
Definition: OpenPepXLLFAlgorithm.h:147
OpenMS::FASTAFile
This class serves for reading in and writing FASTA files If the protein/gene sequence contains unusua...
Definition: FASTAFile.h:60
OpenMS::OpenPepXLLFAlgorithm
Search for cross-linked peptide pairs in tandem MS spectra.
Definition: OpenPepXLLFAlgorithm.h:103
OpenMS::MzMLFile
File adapter for MzML files.
Definition: MzMLFile.h:57
OpenMS::OpenPepXLLFAlgorithm::add_x_ions_
String add_x_ions_
Definition: OpenPepXLLFAlgorithm.h:173
OpenMS::String
A more convenient string class.
Definition: String.h:58
MzMLFile.h
OpenMS::DoubleList
std::vector< double > DoubleList
Vector of double precision real types.
Definition: ListUtils.h:62
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:70
OpenMS::PeakFileOptions::addMSLevel
void addMSLevel(int level)
adds a desired MS level for peaks to load
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
IdXMLFile.h
OpenMS::OpenPepXLLFAlgorithm::sequence_tag_min_length_
Size sequence_tag_min_length_
Definition: OpenPepXLLFAlgorithm.h:169
OpenMS::OpenPepXLLFAlgorithm::cross_link_residue1_
StringList cross_link_residue1_
Definition: OpenPepXLLFAlgorithm.h:153
OpenMS::ProgressLogger::startProgress
void startProgress(SignedSize begin, SignedSize end, const String &label) const
Initializes the progress display.
OpenMS::IntList
std::vector< Int > IntList
Vector of signed integers.
Definition: ListUtils.h:55
OpenMS::OpenPepXLLFAlgorithm::number_top_hits_
Int number_top_hits_
Definition: OpenPepXLLFAlgorithm.h:166
OpenMS::OpenPepXLLFAlgorithm::precursor_mass_tolerance_unit_ppm_
bool precursor_mass_tolerance_unit_ppm_
Definition: OpenPepXLLFAlgorithm.h:146
OpenMS::OpenPepXLLFAlgorithm::add_b_ions_
String add_b_ions_
Definition: OpenPepXLLFAlgorithm.h:172
OpenMS::ProgressLogger::endProgress
void endProgress() const
Ends the progress display.
OpenMS::OpenPepXLLFAlgorithm::add_losses_
String add_losses_
Definition: OpenPepXLLFAlgorithm.h:177
OpenMS::OpenPepXLLFAlgorithm::decoy_string_
String decoy_string_
Definition: OpenPepXLLFAlgorithm.h:140
OpenMS::OpenPepXLLFAlgorithm::cross_link_name_
String cross_link_name_
Definition: OpenPepXLLFAlgorithm.h:157
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
OpenMS::OpenPepXLLFAlgorithm::enzyme_name_
String enzyme_name_
Definition: OpenPepXLLFAlgorithm.h:164
OpenMS::OpenPepXLLFAlgorithm::run
ExitCodes run(PeakMap &unprocessed_spectra, std::vector< FASTAFile::FASTAEntry > &fasta_db, std::vector< ProteinIdentification > &protein_ids, std::vector< PeptideIdentification > &peptide_ids, std::vector< std::vector< OPXLDataStructs::CrossLinkSpectrumMatch > > &all_top_csms, PeakMap &spectra)
Performs the main function of this class, the search for cross-linked peptides.
OpenMS::OpenPepXLLFAlgorithm::decoy_prefix_
bool decoy_prefix_
Definition: OpenPepXLLFAlgorithm.h:141
OPXLDataStructs.h
OpenMS::MzIdentMLFile
File adapter for MzIdentML files.
Definition: MzIdentMLFile.h:67
OpenMS::Int
int Int
Signed integer type.
Definition: Types.h:102
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::XQuestResultXMLFile
Used to load and store xQuest result files.
Definition: XQuestResultXMLFile.h:55
OpenMS::OpenPepXLLFAlgorithm::ILLEGAL_PARAMETERS
Definition: OpenPepXLLFAlgorithm.h:112
OpenMS::ProgressLogger
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:52
OpenMS::OpenPepXLLFAlgorithm::fixedModNames_
StringList fixedModNames_
Definition: OpenPepXLLFAlgorithm.h:159
OpenMS::MetaInfoInterface::setMetaValue
void setMetaValue(const String &name, const DataValue &value)
Sets the DataValue corresponding to a name.
OpenMS::DataValue
Class to hold strings, numeric values, lists of strings and lists of numeric values.
Definition: DataValue.h:58
ProgressLogger.h
OpenMS::MzMLFile::load
void load(const String &filename, PeakMap &map)
Loads a map from a MzML file. Spectra and chromatograms are sorted by default (this can be disabled u...
FASTAFile.h
OpenMS::ProteinIdentification::SearchParameters::db
String db
The used database.
Definition: ProteinIdentification.h:261
OpenMS::OpenPepXLLFAlgorithm::cross_link_mass_
double cross_link_mass_
Definition: OpenPepXLLFAlgorithm.h:155
OpenMS::OpenPepXLLFAlgorithm::add_a_ions_
String add_a_ions_
Definition: OpenPepXLLFAlgorithm.h:174
OpenMS::OpenPepXLLFAlgorithm::cross_link_residue2_
StringList cross_link_residue2_
Definition: OpenPepXLLFAlgorithm.h:154
OpenMS::OpenPepXLLFAlgorithm::add_c_ions_
String add_c_ions_
Definition: OpenPepXLLFAlgorithm.h:175
OpenMS::DefaultParamHandler::setParameters
void setParameters(const Param &param)
Sets the parameters.
OpenMS::OpenPepXLLFAlgorithm::min_precursor_charge_
Int min_precursor_charge_
Definition: OpenPepXLLFAlgorithm.h:143
OpenMS::OpenPepXLLFAlgorithm::EXECUTION_OK
Definition: OpenPepXLLFAlgorithm.h:111
OpenMS::DefaultParamHandler::getParameters
const Param & getParameters() const
Non-mutable access to the parameters.
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:82
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
ModificationsDB.h
main
int main(int argc, const char **argv)
Definition: INIFileEditor.cpp:71
OpenMS::Param::update
bool update(const Param &p_outdated, const bool add_unknown=false)
Rescue parameter values from p_outdated to current param.
OpenMS::OpenPepXLLFAlgorithm::peptide_min_size_
Size peptide_min_size_
Definition: OpenPepXLLFAlgorithm.h:162
OpenMS::OpenMS_Log_debug
Logger::LogStream OpenMS_Log_debug
Global static instance of a LogStream to capture messages classified as debug output....
OpenMS::OpenPepXLLFAlgorithm::max_variable_mods_per_peptide_
Size max_variable_mods_per_peptide_
Definition: OpenPepXLLFAlgorithm.h:161
OpenMS::FASTAFile::load
void load(const String &filename, std::vector< FASTAEntry > &data) const
loads a FASTA file given by 'filename' and stores the information in 'data' This uses more RAM than r...
OpenMS::OpenPepXLLFAlgorithm::precursor_mass_tolerance_
double precursor_mass_tolerance_
Definition: OpenPepXLLFAlgorithm.h:145
OpenMS::PeakFileOptions
Options for loading files containing peak data.
Definition: PeakFileOptions.h:47
OpenMS::PeakFileOptions::clearMSLevels
void clearMSLevels()
clears the MS levels
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:69
OpenMS::OpenPepXLLFAlgorithm::fragment_mass_tolerance_unit_ppm_
bool fragment_mass_tolerance_unit_ppm_
Definition: OpenPepXLLFAlgorithm.h:151
OpenPepXLLFAlgorithm.h
OPENMS_LOG_INFO
#define OPENMS_LOG_INFO
Macro if a information, e.g. a status should be reported.
Definition: LogStream.h:465
OpenMS::XQuestResultXMLFile::store
void store(const String &filename, const std::vector< ProteinIdentification > &poid, const std::vector< PeptideIdentification > &peid) const
Stores the identifications in a xQuest XML file.
OpenMS::ProteinIdentification::SearchParameters
Search parameters of the DB search.
Definition: ProteinIdentification.h:258
StandardTypes.h
File.h
OpenMS::OpenPepXLLFAlgorithm::max_precursor_charge_
Int max_precursor_charge_
Definition: OpenPepXLLFAlgorithm.h:144
MzIdentMLFile.h
OpenMS::MzMLFile::getOptions
PeakFileOptions & getOptions()
Mutable access to the options for loading/storing.
OpenMS::ProgressLogger::setLogType
void setLogType(LogType type) const
Sets the progress log that should be used. The default type is NONE!
TOPPBase.h
OpenMS::OpenPepXLLFAlgorithm::missed_cleavages_
Size missed_cleavages_
Definition: OpenPepXLLFAlgorithm.h:163
OpenMS::ConsensusXMLFile
This class provides Input functionality for ConsensusMaps and Output functionality for alignments and...
Definition: ConsensusXMLFile.h:58
OpenMS::IdXMLFile
Used to load and store idXML files.
Definition: IdXMLFile.h:68
OpenMS::OpenPepXLLFAlgorithm::UNEXPECTED_RESULT
Definition: OpenPepXLLFAlgorithm.h:113
OpenMS::OpenPepXLLFAlgorithm::ExitCodes
ExitCodes
Exit codes.
Definition: OpenPepXLLFAlgorithm.h:109
OpenMS::OpenPepXLLFAlgorithm::varModNames_
StringList varModNames_
Definition: OpenPepXLLFAlgorithm.h:160