OpenMS  3.0.0
RANSACModelLinear.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>
39 
40 namespace OpenMS
41 {
42 
43  namespace Math
44  {
45 
51  class OPENMS_DLLAPI RansacModelLinear
52  : public RansacModel<RansacModelLinear>
53  {
54  public:
55  static ModelParameters rm_fit_impl(const DVecIt& begin, const DVecIt& end);
56 
57  static double rm_rsq_impl(const DVecIt& begin, const DVecIt& end);
58 
59  static double rm_rss_impl(const DVecIt& begin, const DVecIt& end, const ModelParameters& coefficients);
60 
61  static DVec rm_inliers_impl(const DVecIt& begin, const DVecIt& end, const ModelParameters& coefficients, double max_threshold);
62 
63  };
64 
65 
66  }
67 
68 
69 }
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< RansacModelLinear >::ModelParameters
std::vector< double > ModelParameters
Definition: RANSACModel.h:64
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Math::RansacModel< RansacModelLinear >::DVecIt
DVec::const_iterator DVecIt
Definition: RANSACModel.h:63
OpenMS::Math::RansacModel< RansacModelLinear >::DVec
std::vector< DPair > DVec
Definition: RANSACModel.h:62
RANSACModel.h
OpenMS::Math::RansacModelLinear
Implementation of a linear RANSAC model fit.
Definition: RANSACModelLinear.h:51