| OpenMS 2.5.0

FastLowessSmoothing.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-2020.
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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34
35
36 #pragma once
37
38 #include <OpenMS/CONCEPT/Macros.h>
39 #include <vector>
40 #include <algorithm> // std::min, std::max
41 #include <functional>
42
43 namespace OpenMS
44 {
45
63 namespace FastLowessSmoothing
64 {
65
101 int OPENMS_DLLAPI lowess(const std::vector<double>& x, const std::vector<double>& y,
102 double f, int nsteps, double delta, std::vector<double>& result);
103
116 inline int OPENMS_DLLAPI lowess(const std::vector<double>& x, const std::vector<double>& y,
117 std::vector<double>& result)
118 {
119 OPENMS_PRECONDITION(x.size() == y.size(), "Vectors x and y must have the same length")
120 OPENMS_PRECONDITION(x.size() >= 2, "Need at least two points for smoothing")
121 OPENMS_PRECONDITION(std::adjacent_find(x.begin(), x.end(), std::greater<double>()) == x.end(),
122 "The vector x needs to be sorted")
123
124 double delta = 0.01 * (x[ x.size()-1 ] - x[0]); // x is sorted
125 return lowess(x, y, 2.0/3, 3, delta, result);
126 }
127 }
128
129 } // namespace OpenMS
OPENMS_PRECONDITION
#define OPENMS_PRECONDITION(condition, message)
Precondition macro.
Definition: openms/include/OpenMS/CONCEPT/Macros.h:136
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::FastLowessSmoothing::lowess
int lowess(const std::vector< double > &x, const std::vector< double > &y, double f, int nsteps, double delta, std::vector< double > &result)
Computes a lowess smoothing fit on the input vectors.
Macros.h