OpenMS  2.7.0
IDRipper.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-2021.
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: Immanuel Luhn $
33 // --------------------------------------------------------------------------
34 #pragma once
35 
39 
40 
41 namespace OpenMS
42 {
52  class OPENMS_DLLAPI IDRipper :
53  public DefaultParamHandler
54  {
55 public:
56 
59 
61  ~IDRipper() override;
62 
73  void rip(std::map<String, std::pair<std::vector<ProteinIdentification>, std::vector<PeptideIdentification> > > & ripped, std::vector<ProteinIdentification> & proteins, std::vector<PeptideIdentification> & peptides);
74 
75 private:
76 
77  //Not implemented
79  IDRipper(const IDRipper & rhs);
80 
81  // Not implemented
83  IDRipper & operator=(const IDRipper & rhs);
84 
86  void getProteinHits_(std::vector<ProteinHit> & result, const std::vector<ProteinHit> & protein_hits, const std::vector<String> & protein_accessions);
88  void getProteinAccessions_(std::vector<String> & result, const std::vector<PeptideHit> & peptide_hits);
90  void getProteinIdentification_(ProteinIdentification & result, PeptideIdentification pep_ident, std::vector<ProteinIdentification> & prot_idents);
91  };
92 
93 } // namespace OpenMS
94 
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:93
Ripping protein/peptide identification according their file origin.
Definition: IDRipper.h:54
IDRipper()
Default constructor.
~IDRipper() override
Destructor.
void getProteinHits_(std::vector< ProteinHit > &result, const std::vector< ProteinHit > &protein_hits, const std::vector< String > &protein_accessions)
helper function, extracts all protein hits that match the protein accession
void rip(std::map< String, std::pair< std::vector< ProteinIdentification >, std::vector< PeptideIdentification > > > &ripped, std::vector< ProteinIdentification > &proteins, std::vector< PeptideIdentification > &peptides)
Ripping protein/peptide identification according their file origin.
void getProteinAccessions_(std::vector< String > &result, const std::vector< PeptideHit > &peptide_hits)
helper function, returns the string representation of the peptide hit accession
IDRipper(const IDRipper &rhs)
Copy constructor.
IDRipper & operator=(const IDRipper &rhs)
Assignment.
void getProteinIdentification_(ProteinIdentification &result, PeptideIdentification pep_ident, std::vector< ProteinIdentification > &prot_idents)
helper function, returns the protein identification for the given peptide identification based on the...
Represents the peptide hits for a spectrum.
Definition: PeptideIdentification.h:65
Representation of a protein identification run.
Definition: ProteinIdentification.h:72
A more convenient string class.
Definition: String.h:61
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47