OpenMS
ElutionModelFitter.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: Hendrik Weisser $
32 // $Authors: Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
41 
42 namespace OpenMS
43 {
49  class OPENMS_DLLAPI ElutionModelFitter :
50  public DefaultParamHandler
51  {
52 
53  public:
56 
58  ~ElutionModelFitter() override;
59 
71  void fitElutionModels(FeatureMap& features);
72 
73  protected:
76 
78  double calculateFitQuality_(const TraceFitter* fitter,
79  const MassTraces& traces);
80 
83  Feature& feature, double region_start,
84  double region_end, bool asymmetric,
85  double area_limit, double check_boundaries);
86  };
87 }
88 
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
Helper class for fitting elution models to features.
Definition: ElutionModelFitter.h:51
FeatureFinderAlgorithmPickedHelperStructs::MassTraces MassTraces
Definition: ElutionModelFitter.h:75
void fitAndValidateModel_(TraceFitter *fitter, MassTraces &traces, Feature &feature, double region_start, double region_end, bool asymmetric, double area_limit, double check_boundaries)
Helper function to fit (and validate) a model for one set of mass traces.
ElutionModelFitter()
Default constructor.
~ElutionModelFitter() override
Destructor.
void fitElutionModels(FeatureMap &features)
Fit models of elution profiles to all features (and validate them)
double calculateFitQuality_(const TraceFitter *fitter, const MassTraces &traces)
Calculate quality of model fit (mean relative error)
FeatureFinderAlgorithmPickedHelperStructs::MassTrace MassTrace
Definition: ElutionModelFitter.h:74
A container for features.
Definition: FeatureMap.h:106
An LC-MS feature.
Definition: Feature.h:72
Abstract fitter for RT profile fitting.
Definition: TraceFitter.h:64
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
Helper struct for mass traces used in FeatureFinderAlgorithmPicked.
Definition: FeatureFinderAlgorithmPickedHelperStructs.h:80
Helper struct for a collection of mass traces used in FeatureFinderAlgorithmPicked.
Definition: FeatureFinderAlgorithmPickedHelperStructs.h:111