OpenMS
PeakWidthEstimator.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: Lars Nilse $
32 // $Authors: Lars Nilse $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
41 
42 namespace OpenMS
43 {
52  class OPENMS_DLLAPI PeakWidthEstimator
53  {
54 
55  public:
56 
65  PeakWidthEstimator(const PeakMap & exp_picked, const std::vector<std::vector<PeakPickerHiRes::PeakBoundary> > & boundaries);
66 
75  double getPeakWidth(double mz);
76 
81 
82  private:
83 
86 
91 
95  double mz_min_;
96  double mz_max_;
97 
98  };
99 }
100 
b spline interpolation
Definition: BSpline2d.h:58
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:72
Rough estimation of the peak width at m/z.
Definition: PeakWidthEstimator.h:53
PeakWidthEstimator(const PeakMap &exp_picked, const std::vector< std::vector< PeakPickerHiRes::PeakBoundary > > &boundaries)
constructor
BSpline2d * bspline_
B-spline for peak width interpolation.
Definition: PeakWidthEstimator.h:90
double mz_min_
m/z range of peak width interpolation
Definition: PeakWidthEstimator.h:95
virtual ~PeakWidthEstimator()
destructor
PeakWidthEstimator()
hide default constructor
double getPeakWidth(double mz)
returns the estimated peak width at m/z
double mz_max_
Definition: PeakWidthEstimator.h:96
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48