Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
SpectrumAlignmentScore.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-2017.
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: $
33 // --------------------------------------------------------------------------
34 //
35 #ifndef OPENMS_COMPARISON_SPECTRA_SPECTRUMALIGNMENTSCORE_H
36 #define OPENMS_COMPARISON_SPECTRA_SPECTRUMALIGNMENTSCORE_H
37 
39 #include <OpenMS/KERNEL/Peak1D.h>
44 
45 #include <boost/math/special_functions/erf.hpp>
46 #include <cmath>
47 
48 namespace OpenMS
49 {
50 
70  class OPENMS_DLLAPI SpectrumAlignmentScore :
72  {
73 public:
74 
75  // @name Constructors and Destructors
76  // @{
79 
82 
84  virtual ~SpectrumAlignmentScore();
85  // @}
86 
87  // @name Operators
88  // @{
90  SpectrumAlignmentScore & operator=(const SpectrumAlignmentScore & source);
91 
93  double operator()(const PeakSpectrum & spec1, const PeakSpectrum & spec2) const;
94 
95  double operator()(const PeakSpectrum & spec) const;
96  // @}
97 
98  // @name Accessors
99  // @{
102 
104  static const String getProductName()
105  {
106  return "SpectrumAlignmentScore";
107  }
108 
109  // @}
110 
111 protected:
112 
114  double getFactor_(double mz_tolerance, double mz_difference, bool is_gaussian = false) const;
115  };
116 
117 }
118 #endif //OPENMS_COMPARISON_SPECTRA_SPECTRUMALIGNMENTSCORE_H
A more convenient string class.
Definition: String.h:57
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
static const String getProductName()
Definition: SpectrumAlignmentScore.h:104
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
Similarity score via spectra alignment.
Definition: SpectrumAlignmentScore.h:70
Base class for compare functors of spectra, that return a similarity value for two spectra...
Definition: PeakSpectrumCompareFunctor.h:53
static PeakSpectrumCompareFunctor * create()
Definition: SpectrumAlignmentScore.h:101

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:04 using doxygen 1.8.13