OpenMS  2.8.0
DeNovoIdentification.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: Sandro Andreotti, Andreas Bertsch$
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
40 #include <vector>
41 
42 namespace OpenMS
43 {
51  class OPENMS_DLLAPI DeNovoIdentification :
52  public DefaultParamHandler
53  {
54 public:
55 
61 
64 
68 
71 
73  virtual void getIdentifications(std::vector<PeptideIdentification> & ids, const PeakMap & exp) = 0;
74 
76  virtual void getIdentification(PeptideIdentification & id, const PeakSpectrum & spectrum) = 0;
77 
78  };
79 
80 } // namespace OpenMS
81 
Base class for de novo identification.
Definition: DeNovoIdentification.h:53
DeNovoIdentification & operator=(const DeNovoIdentification &rhs)
assignment operator
DeNovoIdentification()
default constructor
virtual void getIdentification(PeptideIdentification &id, const PeakSpectrum &spectrum)=0
performs an ProteinIdentification run on a PeakSpectrum
virtual void getIdentifications(std::vector< PeptideIdentification > &ids, const PeakMap &exp)=0
performs an ProteinIdentification run on a PeakMap
DeNovoIdentification(const DeNovoIdentification &rhs)
copy constructor
~DeNovoIdentification() override
destructor
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:93
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:73
The representation of a 1D spectrum.
Definition: MSSpectrum.h:70
Represents the peptide hits for a spectrum.
Definition: PeptideIdentification.h:65
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47