Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2017.
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 #ifndef OPENMS_ANALYSIS_PIP_LOCALLINEARMAP_H
36 #define OPENMS_ANALYSIS_PIP_LOCALLINEARMAP_H
37 
39 
40 namespace OpenMS
41 {
42 
57  class OPENMS_DLLAPI LocalLinearMap
58  {
59 
60 public:
61 
69  struct OPENMS_DLLAPI LLMParam
70  {
73  double radius;
74  };
75 
79  virtual ~LocalLinearMap();
80 
82  const LLMParam & getLLMParam() const;
84  const Matrix<double> & getCodebooks() const;
86  const Matrix<double> & getMatrixA() const;
88  const std::vector<double> & getVectorWout() const;
90  const Matrix<UInt> & getCord() const;
92  void normalizeVector(std::vector<double> & aaIndexVariables);
94  std::vector<double> neigh(const Matrix<UInt> & cord, Size win, double radius);
95 
96 private:
97 
101  std::vector<double> wout_;
103 
105  Matrix<UInt> genCord_(Size xdim, Size ydim);
107  double dist_(const Matrix<UInt> & u, const Matrix<UInt> & v, Size a, Size b);
108 
112  LocalLinearMap & operator=(const LocalLinearMap & llm);
113 
114  };
115 
116 
117 }
118 #endif
unsigned int UInt
Unsigned integer type.
Definition: Types.h:95
Define parameters needed by the Local Linear Map (LLM) model.
Definition: LocalLinearMap.h:69
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Matrix< double > A_
linear mappings
Definition: LocalLinearMap.h:100
UInt xdim
Definition: LocalLinearMap.h:71
Matrix< UInt > cord_
coordinates of codebooks on grid
Definition: LocalLinearMap.h:102
LLMParam param_
parameters of the model
Definition: LocalLinearMap.h:98
double radius
Definition: LocalLinearMap.h:73
Trained Local Linear Map (LLM) model for peak intensity prediction.
Definition: LocalLinearMap.h:57
std::vector< double > wout_
linear bias
Definition: LocalLinearMap.h:101
Matrix< double > code_
codebook vectors
Definition: LocalLinearMap.h:99
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:128
UInt ydim
Definition: LocalLinearMap.h:72

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:01 using doxygen 1.8.13