OpenMS
3.0.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
TransformationModelLowess.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: Hannes Roest $
32
// $Authors: Hannes Roest $
33
// --------------------------------------------------------------------------
34
35
#pragma once
36
37
#include <OpenMS/config.h>
// is this needed?
38
#include <
OpenMS/ANALYSIS/MAPMATCHING/TransformationModel.h
>
39
#include <
OpenMS/ANALYSIS/MAPMATCHING/TransformationModelInterpolated.h
>
40
41
namespace
OpenMS
42
{
43
49
class
OPENMS_DLLAPI
TransformationModelLowess
:
50
public
TransformationModel
51
{
52
public
:
58
TransformationModelLowess
(
const
DataPoints
& data,
const
Param
& params);
59
61
~TransformationModelLowess
()
override
;
62
64
double
evaluate
(
double
value)
const override
65
{
66
return
model_->evaluate(value);
67
}
68
69
using
TransformationModel::getParameters
;
70
72
static
void
getDefaultParameters
(
Param
& params);
73
74
protected
:
76
TransformationModelInterpolated
*
model_
;
77
78
};
79
}
// namespace
80
TransformationModelInterpolated.h
TransformationModel.h
OpenMS::Param
Management and storage of parameters / INI files.
Definition:
Param.h:70
OpenMS::TransformationModelInterpolated
Interpolation model for transformations.
Definition:
TransformationModelInterpolated.h:71
OpenMS::TransformationModelLowess
Lowess (non-linear) model for transformations.
Definition:
TransformationModelLowess.h:51
OpenMS::TransformationModelLowess::TransformationModelLowess
TransformationModelLowess(const DataPoints &data, const Param ¶ms)
Constructor.
OpenMS::TransformationModelLowess::getDefaultParameters
static void getDefaultParameters(Param ¶ms)
Gets the default parameters.
OpenMS::TransformationModelLowess::~TransformationModelLowess
~TransformationModelLowess() override
Destructor.
OpenMS::TransformationModelLowess::evaluate
double evaluate(double value) const override
Evaluates the model at the given value.
Definition:
TransformationModelLowess.h:64
OpenMS::TransformationModelLowess::model_
TransformationModelInterpolated * model_
Pointer to the underlying interpolation.
Definition:
TransformationModelLowess.h:76
OpenMS::TransformationModel
Base class for transformation models.
Definition:
TransformationModel.h:55
OpenMS::TransformationModel::getParameters
const Param & getParameters() const
Gets the (actual) parameters.
OpenMS::TransformationModel::DataPoints
std::vector< DataPoint > DataPoints
Vector of coordinate pairs.
Definition:
TransformationModel.h:91
OpenMS
Main OpenMS namespace.
Definition:
FeatureDeconvolution.h:48
OpenMS
ANALYSIS
MAPMATCHING
TransformationModelLowess.h
Generated on Fri Jul 14 2023 13:07:16 for OpenMS by
1.9.1