OpenMS  3.0.0
RANSACModel.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: George Rosenberger $
32 // $Authors: George Rosenberger, Hannes Roest, Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/config.h>
38 
39 #include <cstddef> // for size_t & ptrdiff_t
40 #include <vector>
41 #include <string>
42 
43 namespace OpenMS
44 {
45 
46  namespace Math
47  {
48 
57  template<class ModelT = int> // dummy default to allow easy access to public typedefs
59  {
60  public:
61  typedef std::pair<double, double> DPair;
62  typedef std::vector<DPair> DVec;
63  typedef DVec::const_iterator DVecIt;
64  typedef std::vector<double> ModelParameters;
65 
66 
68  ModelParameters rm_fit(const DVecIt& begin, const DVecIt& end) const
69  {
70  return static_cast<const ModelT*>(this)->rm_fit_impl(begin, end);
71  }
72 
82  double rm_rsq(const DVecIt& begin, const DVecIt& end) const
83  {
84  return static_cast<const ModelT*>(this)->rm_rsq_impl(begin, end);
85  }
86 
88  double rm_rss(const DVecIt& begin, const DVecIt& end, const ModelParameters& coefficients) const
89  {
90  return static_cast<const ModelT*>(this)->rm_rss_impl(begin, end, coefficients);
91  }
92 
95  DVec rm_inliers(const DVecIt& begin, const DVecIt& end, const ModelParameters& coefficients, double max_threshold) const
96  {
97  return static_cast<const ModelT*>(this)->rm_inliers_impl(begin, end, coefficients, max_threshold);
98  }
99  };
100 
101  }
102 
103 
104 }
OpenMS::Math::RansacModel::rm_rss
double rm_rss(const DVecIt &begin, const DVecIt &end, const ModelParameters &coefficients) const
calculates the residual sum of squares of the input points according to the model
Definition: RANSACModel.h:88
OpenMS::Math::RansacModel
Generic plug-in template base class using 'Curiously recurring template pattern' (CRTP) to allow for ...
Definition: RANSACModel.h:58
OpenMS::Math::RansacModel::ModelParameters
std::vector< double > ModelParameters
Definition: RANSACModel.h:64
OpenMS::Math::RansacModel::rm_rsq
double rm_rsq(const DVecIt &begin, const DVecIt &end) const
Returns the R-squared of the data applied to the model (computed on-the-fly).
Definition: RANSACModel.h:82
OpenMS::Math::RansacModel::rm_fit
ModelParameters rm_fit(const DVecIt &begin, const DVecIt &end) const
fit a model and return its parameters
Definition: RANSACModel.h:68
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Math::RansacModel::rm_inliers
DVec rm_inliers(const DVecIt &begin, const DVecIt &end, const ModelParameters &coefficients, double max_threshold) const
Definition: RANSACModel.h:95
OpenMS::Math::RansacModel::DVecIt
DVec::const_iterator DVecIt
Definition: RANSACModel.h:63
OpenMS::Math::RansacModel::DVec
std::vector< DPair > DVec
Definition: RANSACModel.h:62
OpenMS::Math::RansacModel::DPair
std::pair< double, double > DPair
Definition: RANSACModel.h:61