OpenMS  3.0.0
Fitter1D.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: Timo Sachsenberg $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 #include <OpenMS/KERNEL/Feature.h>
40 #include <OpenMS/KERNEL/Peak1D.h>
43 #include <memory>
44 
45 namespace OpenMS
46 {
47  class InterpolationModel;
48 
59  class OPENMS_DLLAPI Fitter1D :
60  public DefaultParamHandler,
61  public FeatureFinderDefs
62  {
63 public:
64 
74  typedef Peak1D PeakType;
76  typedef std::vector<PeakType> RawDataArrayType;
78  typedef RawDataArrayType::iterator PeakIterator;
79 
81  Fitter1D();
82 
84  Fitter1D(const Fitter1D& source);
85 
87  ~Fitter1D() override;
88 
90  virtual Fitter1D& operator=(const Fitter1D& source);
91 
93  virtual QualityType fit1d(const RawDataArrayType& /* range */, std::unique_ptr<InterpolationModel>& /* model */);
94 
96  static void registerChildren();
97 
98 protected:
99 
106 
107  void updateMembers_() override;
108 
109  };
110 
111 }
112 
DefaultParamHandler.h
OpenMS::Fitter1D::QualityType
Feature::QualityType QualityType
Quality of a feature.
Definition: Fitter1D.h:72
OpenMS::FeatureFinderDefs
The purpose of this struct is to provide definitions of classes and typedefs which are used throughou...
Definition: FeatureFinderDefs.h:50
OpenMS::IsotopeCluster::ChargedIndexSet
index set with associated charge estimate
Definition: IsotopeCluster.h:52
Peak1D.h
BasicStatistics.h
Feature.h
OpenMS::Fitter1D::ChargedIndexSet
IsotopeCluster::ChargedIndexSet ChargedIndexSet
IndexSet with charge information.
Definition: Fitter1D.h:68
OpenMS::Peak2D::CoordinateType
double CoordinateType
Coordinate type (of the position)
Definition: Peak2D.h:64
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
OpenMS::Fitter1D::IndexSet
IsotopeCluster::IndexSet IndexSet
IndexSet.
Definition: Fitter1D.h:66
OpenMS::Fitter1D::statistics_
Math::BasicStatistics statistics_
basic statistics
Definition: Fitter1D.h:103
OpenMS::IsotopeCluster::IndexSet
std::set< IndexPair > IndexSet
A set of index pairs, usually referring to an MSExperiment.
Definition: IsotopeCluster.h:49
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Fitter1D::interpolation_step_
CoordinateType interpolation_step_
interpolation step size
Definition: Fitter1D.h:105
OpenMS::Fitter1D::PeakType
Peak1D PeakType
Peak type data point type.
Definition: Fitter1D.h:74
OpenMS::Math::BasicStatistics
Calculates some basic statistical parameters of a distribution: sum, mean, variance,...
Definition: BasicStatistics.h:67
OpenMS::Fitter1D
Abstract base class for all 1D-dimensional model fitter.
Definition: Fitter1D.h:59
OpenMS::Peak1D
A 1-dimensional raw data point or peak.
Definition: Peak1D.h:53
FeatureFinderDefs.h
OpenMS::Fitter1D::CoordinateType
Feature::CoordinateType CoordinateType
Single coordinate.
Definition: Fitter1D.h:70
float
OpenMS::Fitter1D::PeakIterator
RawDataArrayType::iterator PeakIterator
Peak type data iterator.
Definition: Fitter1D.h:78
OpenMS::Fitter1D::RawDataArrayType
std::vector< PeakType > RawDataArrayType
Peak type data container type using for the temporary storage of the input data.
Definition: Fitter1D.h:76
IsotopeCluster.h
OpenMS::Fitter1D::tolerance_stdev_box_
CoordinateType tolerance_stdev_box_
standard derivation in bounding box
Definition: Fitter1D.h:101