OpenMS
Fitter1D.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
13 #include <OpenMS/KERNEL/Feature.h>
14 #include <OpenMS/KERNEL/Peak1D.h>
17 #include <memory>
18 
19 namespace OpenMS
20 {
21  class InterpolationModel;
22 
33  class OPENMS_DLLAPI Fitter1D : public DefaultParamHandler, public FeatureFinderDefs
34  {
35  public:
45  typedef Peak1D PeakType;
47  typedef std::vector<PeakType> RawDataArrayType;
49  typedef RawDataArrayType::iterator PeakIterator;
50 
53 
55  Fitter1D(const Fitter1D& source);
56 
58  ~Fitter1D() override;
59 
61  Fitter1D& operator=(const Fitter1D& source);
62 
64  virtual QualityType fit1d(const RawDataArrayType& /* range */, std::unique_ptr<InterpolationModel>& /* model */);
65 
67  static void registerChildren();
68 
69  protected:
76 
77  void updateMembers_() override;
78  };
79 
80 } // namespace OpenMS
float QualityType
Definition: BaseFeature.h:38
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:66
Abstract base class for all 1D-dimensional model fitter.
Definition: Fitter1D.h:34
RawDataArrayType::iterator PeakIterator
Peak type data iterator.
Definition: Fitter1D.h:49
std::vector< PeakType > RawDataArrayType
Peak type data container type using for the temporary storage of the input data.
Definition: Fitter1D.h:47
Fitter1D()
Default constructor.
Fitter1D(const Fitter1D &source)
copy constructor
~Fitter1D() override
destructor
Feature::QualityType QualityType
Quality of a feature.
Definition: Fitter1D.h:43
CoordinateType tolerance_stdev_box_
standard derivation in bounding box
Definition: Fitter1D.h:71
virtual QualityType fit1d(const RawDataArrayType &, std::unique_ptr< InterpolationModel > &)
return interpolation model
Feature::CoordinateType CoordinateType
Single coordinate.
Definition: Fitter1D.h:41
static void registerChildren()
register all derived classes here
CoordinateType interpolation_step_
interpolation step size
Definition: Fitter1D.h:75
void updateMembers_() override
This method is used to update extra member variables at the end of the setParameters() method.
Peak1D PeakType
Peak type data point type.
Definition: Fitter1D.h:45
Fitter1D & operator=(const Fitter1D &source)
assignment operator
Math::BasicStatistics statistics_
basic statistics
Definition: Fitter1D.h:73
IsotopeCluster::ChargedIndexSet ChargedIndexSet
IndexSet with charge information.
Definition: Fitter1D.h:39
IsotopeCluster::IndexSet IndexSet
IndexSet.
Definition: Fitter1D.h:37
Calculates some basic statistical parameters of a distribution: sum, mean, variance,...
Definition: BasicStatistics.h:43
A 1-dimensional raw data point or peak.
Definition: Peak1D.h:28
double CoordinateType
Coordinate type (of the position)
Definition: Peak2D.h:38
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22
The purpose of this struct is to provide definitions of classes and typedefs which are used throughou...
Definition: FeatureFinderDefs.h:25
index set with associated charge estimate
Definition: IsotopeCluster.h:28
std::set< IndexPair > IndexSet
A set of index pairs, usually referring to an MSExperiment.
Definition: IsotopeCluster.h:23