Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
CompareFouriertransform.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-2013.
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: Erhan Kenar $
32 // $Authors: Vipul Patel $
33 // --------------------------------------------------------------------------
34 #ifndef OPENMS_COMPARISON_SPECTRA_COMPAREFOURIERTRANSFORM_H
35 #define OPENMS_COMPARISON_SPECTRA_COMPAREFOURIERTRANSFORM_H
36 
39 #include <gsl/gsl_errno.h>
40 #include <gsl/gsl_fft_real.h>
41 
42 namespace OpenMS
43 {
66  class OPENMS_DLLAPI CompareFouriertransform :
68  {
69 public:
70 
71  // @name Constructors and Destructors
72  // @{
75 
78 
80  virtual ~CompareFouriertransform();
81  // @}
82 
83  // @name Operators
84  // @{
86  CompareFouriertransform & operator=(const CompareFouriertransform & source);
87 
93  double operator()(const PeakSpectrum &) const;
102  double operator()(const PeakSpectrum & spec1, const PeakSpectrum & spec2) const;
103 
106 
108  static const String getProductName()
109  {
110  return "CompareFouriertransform";
111  }
112 
119  void transform(PeakSpectrum & spec);
120 protected:
126  UInt searchTransformation_(const PeakSpectrum & spec) const;
127 
128 
129  };
130 
131 }
132 #endif /*OPENMS_COMPARISON_SPECTRA_COMPAREFOURIERTRANSFORM_H*/
static const String getProductName()
Returns the name used in the factory.
Definition: CompareFouriertransform.h:108
A more convenient string class.
Definition: String.h:56
Compare Discrete Cosines value from a Fourier transformation, also known as Discrete Cosines Transfor...
Definition: CompareFouriertransform.h:66
Base class for compare functors of spectra, that return a similiarity value for two spectra...
Definition: PeakSpectrumCompareFunctor.h:53
static PeakSpectrumCompareFunctor * create()
Definition: CompareFouriertransform.h:105

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:12 using doxygen 1.8.5