File: GaussianComputation.h

package info (click to toggle)
caret 5.6.4~dfsg.1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 31,904 kB
  • ctags: 28,901
  • sloc: cpp: 378,050; python: 6,718; ansic: 5,507; makefile: 333; sh: 46
file content (133 lines) | stat: -rw-r--r-- 4,494 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

#ifndef __GAUSSIAN_COMPUTATION_H__
#define __GAUSSIAN_COMPUTATION_H__

/*LICENSE_START*/
/*
 *  Copyright 1995-2002 Washington University School of Medicine
 *
 *  http://brainmap.wustl.edu
 *
 *  This file is part of CARET.
 *
 *  CARET is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  CARET is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with CARET; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
/*LICENSE_END*/

#include <QString>
#include <vector>

/// class for gaussian evaluation
class GaussianComputation {
   public:
      /// class for a point that will be evaluated
      class Point3D {
         public:
            /// constructor
            Point3D(const float xyzIn[3],
                    const float valueIn) {
               xyz[0] = xyzIn[0];
               xyz[1] = xyzIn[1];
               xyz[2] = xyzIn[2];
               value  = valueIn;
               weight = 0.0;
            }
                    
            /// Destructor
            ~Point3D() { }
            
            /// get the weight
            float getWeight() const { return weight; }
         
         protected:
            /// coordinate
            float xyz[3];
            
            /// value
            float value;
            
            /// weight
            float weight;
            
         friend class GaussianComputation;
      };
      
      /// Constructor
      GaussianComputation(const float normBelowCutoffIn = 2.0,
                          const float normAboveCutoffIn = 2.0,
                          const float sigmaNormIn = 2.0,
                          const float sigmaTangIn = 2.0,
                          const float tangentCutoffIn = 3.0);
               
      /// destructor
      ~GaussianComputation();
      
      /// evaluate for a point related to the reference point(returns weight)
      float evaluate(const float referencePointXYZ[3],
                     const float referencePointNormal[3],
                     const float evaluationPoint[3]) const;
                     
      /// evaluate for a set of points related to the reference point
      /// returns gaussian computed from all points.  Each "points" 
      /// weight will also be set.
      float evaluate(const float referencePointXYZ[3],
                     const float referencePointNormal[3],
                     std::vector<Point3D>& points) const;
                     
      /// tooltip text for norm below cutoff parameter
      static QString tooltipTextForNormBelowCutoff();
   
      /// tooltip text for norm above cutoff parameter
      static QString tooltipTextForNormAboveCutoff();
   
      /// tooltip text for tangent cutoff parameter
      static QString tooltipTextForTangentCutoff();
   
      /// tooltip text for sigma norm parameter
      static QString tooltipTextForSigmaNorm();
   
      /// tooltip text for sigma tang parameter
      static QString tooltipTextForSigmaTang();
   
      /// get default parameters
      static void getDefaultParameters(float& normBelowCutoffOut,
                                       float& normAboveCutoffOut,
                                       float& sigmaNormOut,
                                       float& sigmaTangOut,
                                       float& tangentCutoffOut);

   protected:
      /// cutoff distance in direction opposite normal
      /// ("under" a plane tangent to the reference point)
      float normBelowCutoff;
      
      /// cutoff distance in direction of normal 
      /// ("above" a plane tangent to the reference point)
      float normAboveCutoff;
      
      /// cutoff for distance along a plane tangent to the reference point
      float tangentCutoff;
      
      /// standard deviation for gaussian along the normal vector
      float sigmaNorm;
      
      /// standard deviation for gaussian along plane tangent to the reference point
      float sigmaTang;
};
      

#endif //  __GAUSSIAN_COMPUTATION_H__