OpenMS
PepNovoOutfile.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2023.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Sandro Andreotti, Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
40 
41 #include <vector>
42 #include <map>
43 
44 namespace OpenMS
45 {
46  class ProteinIdentification;
47 
56  class OPENMS_DLLAPI PepNovoOutfile
57  {
58 public:
59 
60  typedef std::map<Size, std::pair<double, double> > IndexPosMappingType;
61 
64 
66  PepNovoOutfile(const PepNovoOutfile & pepnovo_outfile);
67 
69  virtual ~PepNovoOutfile();
70 
72  PepNovoOutfile & operator=(const PepNovoOutfile & pepnovo_outfile);
73 
75  bool operator==(const PepNovoOutfile & pepnovo_outfile) const;
76 
89  void load(const std::string & result_filename, std::vector<PeptideIdentification> & peptide_identifications,
90  ProteinIdentification & protein_identification,
91  const double & score_threshold,
92  const IndexPosMappingType & id_rt_mz,
93  const std::map<String, String> & mod_id_map);
94 
102  void getSearchEngineAndVersion(const String & pepnovo_output_without_parameters_filename, ProteinIdentification & protein_identification);
103 
104  };
105 
106 } //namespace OpenMS
107 
Representation of a PepNovo output file.
Definition: PepNovoOutfile.h:57
void getSearchEngineAndVersion(const String &pepnovo_output_without_parameters_filename, ProteinIdentification &protein_identification)
get the search engine version and search parameters from a PepNovo output file
PepNovoOutfile & operator=(const PepNovoOutfile &pepnovo_outfile)
assignment operator
std::map< Size, std::pair< double, double > > IndexPosMappingType
Definition: PepNovoOutfile.h:60
virtual ~PepNovoOutfile()
destructor
void load(const std::string &result_filename, std::vector< PeptideIdentification > &peptide_identifications, ProteinIdentification &protein_identification, const double &score_threshold, const IndexPosMappingType &id_rt_mz, const std::map< String, String > &mod_id_map)
loads data from a PepNovo outfile
bool operator==(const PepNovoOutfile &pepnovo_outfile) const
equality operator
PepNovoOutfile()
Constructor.
PepNovoOutfile(const PepNovoOutfile &pepnovo_outfile)
copy constructor
Representation of a protein identification run.
Definition: ProteinIdentification.h:76
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48