OpenMS  3.0.0
ConsensusIDAlgorithmSimilarity.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-2022.
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: Hendrik Weisser $
32 // $Authors: Andreas Bertsch, Marc Sturm, Sven Nahnsen, Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 namespace OpenMS
40 {
54  class OPENMS_DLLAPI ConsensusIDAlgorithmSimilarity :
56  {
57  protected:
60 
62  typedef std::map<std::pair<AASequence, AASequence>, double> SimilarityCache;
63 
66 
74  virtual double getSimilarity_(AASequence seq1, AASequence seq2) = 0;
75 
76  private:
79 
82 
84  void apply_(std::vector<PeptideIdentification>& ids,
85  const std::map<String, String>& se_info,
86  SequenceGrouping& results) override;
87  };
88 
89 } // namespace OpenMS
90 
OpenMS::ConsensusIDAlgorithmSimilarity
Abstract base class for ConsensusID algorithms that take peptide similarity into account.
Definition: ConsensusIDAlgorithmSimilarity.h:54
OpenMS::ConsensusIDAlgorithm::SequenceGrouping
std::map< AASequence, HitInfo > SequenceGrouping
Mapping: peptide sequence -> (charge, scores)
Definition: ConsensusIDAlgorithm.h:103
OpenMS::ConsensusIDAlgorithmSimilarity::similarities_
SimilarityCache similarities_
Cache for already computed sequence similarities.
Definition: ConsensusIDAlgorithmSimilarity.h:65
OpenMS::ConsensusIDAlgorithmSimilarity::SimilarityCache
std::map< std::pair< AASequence, AASequence >, double > SimilarityCache
Mapping: pair of peptide sequences -> sequence similarity.
Definition: ConsensusIDAlgorithmSimilarity.h:62
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
ConsensusIDAlgorithm.h
OpenMS::AASequence
Representation of a peptide/protein sequence.
Definition: AASequence.h:111
OpenMS::ConsensusIDAlgorithm
Abstract base class for all ConsensusID algorithms (that calculate a consensus from multiple ID runs)...
Definition: ConsensusIDAlgorithm.h:59