OpenMS  3.0.0
LocalLinearMap.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-2022.
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: Timo Sachsenberg $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 namespace OpenMS
40 {
41 
56  class OPENMS_DLLAPI LocalLinearMap
57  {
58 
59 public:
60 
68  struct OPENMS_DLLAPI LLMParam
69  {
72  double radius;
73  };
74 
78  virtual ~LocalLinearMap();
79 
81  const LLMParam & getLLMParam() const;
83  const Matrix<double> & getCodebooks() const;
85  const Matrix<double> & getMatrixA() const;
87  const std::vector<double> & getVectorWout() const;
89  const Matrix<UInt> & getCord() const;
91  void normalizeVector(std::vector<double> & aaIndexVariables);
93  std::vector<double> neigh(const Matrix<UInt> & cord, Size win, double radius);
94 
95 private:
96 
100  std::vector<double> wout_;
102 
104  Matrix<UInt> genCord_(Size xdim, Size ydim);
106  double dist_(const Matrix<UInt> & u, const Matrix<UInt> & v, Size a, Size b);
107 
111  LocalLinearMap & operator=(const LocalLinearMap & llm);
112 
113  };
114 
115 
116 }
OpenMS::LocalLinearMap::LLMParam::xdim
UInt xdim
Definition: LocalLinearMap.h:70
OpenMS::LocalLinearMap::cord_
Matrix< UInt > cord_
coordinates of codebooks on grid
Definition: LocalLinearMap.h:101
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
Matrix.h
OpenMS::LocalLinearMap::LLMParam
Define parameters needed by the Local Linear Map (LLM) model.
Definition: LocalLinearMap.h:68
OpenMS::LocalLinearMap::A_
Matrix< double > A_
linear mappings
Definition: LocalLinearMap.h:99
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Matrix< double >
OpenMS::LocalLinearMap::LLMParam::radius
double radius
Definition: LocalLinearMap.h:72
OpenMS::LocalLinearMap::LLMParam::ydim
UInt ydim
Definition: LocalLinearMap.h:71
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
OpenMS::LocalLinearMap::code_
Matrix< double > code_
codebook vectors
Definition: LocalLinearMap.h:98
OpenMS::LocalLinearMap::param_
LLMParam param_
parameters of the model
Definition: LocalLinearMap.h:97
OpenMS::LocalLinearMap
Trained Local Linear Map (LLM) model for peak intensity prediction.
Definition: LocalLinearMap.h:56
OpenMS::LocalLinearMap::wout_
std::vector< double > wout_
linear bias
Definition: LocalLinearMap.h:100