OpenMS
MaxLikeliFitter1D.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-2023.
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 #pragma once
36 
38 
39 namespace OpenMS
40 {
41  class InterpolationModel;
42 
46  class OPENMS_DLLAPI MaxLikeliFitter1D : public Fitter1D
47  {
48  public:
51  {
52  }
53 
55  MaxLikeliFitter1D(const MaxLikeliFitter1D& source) : Fitter1D(source)
56  {
57  }
58 
60  ~MaxLikeliFitter1D() override
61  {
62  }
63 
66  {
67  if (&source == this)
68  return *this;
69 
70  Fitter1D::operator=(source);
71 
72  return *this;
73  }
74 
75  protected:
77  QualityType fitOffset_(std::unique_ptr<InterpolationModel>& model, const RawDataArrayType& set, const CoordinateType stdev1, const CoordinateType stdev2, const CoordinateType offset_step) const;
78 
79  void updateMembers_() override;
80  };
81 } // namespace OpenMS
Abstract base class for all 1D-dimensional model fitter.
Definition: Fitter1D.h:60
std::vector< PeakType > RawDataArrayType
Peak type data container type using for the temporary storage of the input data.
Definition: Fitter1D.h:73
Feature::QualityType QualityType
Quality of a feature.
Definition: Fitter1D.h:69
Feature::CoordinateType CoordinateType
Single coordinate.
Definition: Fitter1D.h:67
Fitter1D & operator=(const Fitter1D &source)
assignment operator
Abstract base class for all 1D-model fitters using maximum likelihood optimization.
Definition: MaxLikeliFitter1D.h:47
MaxLikeliFitter1D(const MaxLikeliFitter1D &source)
copy constructor
Definition: MaxLikeliFitter1D.h:55
MaxLikeliFitter1D()
default constructor
Definition: MaxLikeliFitter1D.h:50
MaxLikeliFitter1D & operator=(const MaxLikeliFitter1D &source)
assignment operator
Definition: MaxLikeliFitter1D.h:65
void updateMembers_() override
This method is used to update extra member variables at the end of the setParameters() method.
QualityType fitOffset_(std::unique_ptr< InterpolationModel > &model, const RawDataArrayType &set, const CoordinateType stdev1, const CoordinateType stdev2, const CoordinateType offset_step) const
fit an offset on the basis of the Pearson correlation coefficient
~MaxLikeliFitter1D() override
destructor
Definition: MaxLikeliFitter1D.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48