File: BrainModelSurfaceFindExtremum.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 (190 lines) | stat: -rw-r--r-- 6,905 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

#ifndef __BRAIN_MODEL_SURFACE_FIND_EXTREMUM_H__
#define __BRAIN_MODEL_SURFACE_FIND_EXTREMUM_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 <vector>

#include "BrainModelAlgorithm.h"

class BrainModelSurface;
class BrainModelSurfaceROINodeSelection;
class PaintFile;

/// class for starting at a node, moving as far as possible in specified direction along mesh 
class BrainModelSurfaceFindExtremum : public BrainModelAlgorithm {
   public:
      /// direction for search
      enum DIRECTION {
         /// invalid direction
         DIRECTION_INVALID,
         /// move laterally
         DIRECTION_LATERAL,
         /// move medially
         DIRECTION_MEDIAL,
         /// move negative X
         DIRECTION_X_NEGATIVE,
         /// move positive X
         DIRECTION_X_POSITIVE,
         /// move negative Y
         DIRECTION_Y_NEGATIVE,
         /// move positive Y
         DIRECTION_Y_POSITIVE,
         /// move negative Z
         DIRECTION_Z_NEGATIVE,
         /// move positive Z
         DIRECTION_Z_POSITIVE,
      };
      
      /// paint operation
      enum PAINT_OPERATION {
         /// no paint operation
         PAINT_OPERATION_NONE,
         /// move until paint identity changes
         PAINT_OPERATION_STOP_WHEN_PAINT_ID_CHANGES
      };
      
      /// normal restriction
      enum NORMAL_RESTRICTION {
         /// no restriction
         NORMAL_RESTRICTION_NONE,
         /// restrict to negative normals
         NORMAL_RESTRICTION_NEGATIVE,
         /// restrict to positive normals
         NORMAL_RESTRICTION_POSITIVE
      };
      
      // constructor
      BrainModelSurfaceFindExtremum(BrainSet* brainSetIn,
                                    BrainModelSurface* bmsIn,
                                    const DIRECTION searchDirectionIn,
                                    const int startNodeNumberIn,
                                    const float maximumMovementXIn,
                                    const float maximumMovementYIn,
                                    const float maximumMovementZIn);
                                    
      // constructor
      BrainModelSurfaceFindExtremum(BrainSet* brainSetIn,
                                    BrainModelSurface* bmsIn,
                                    const DIRECTION searchDirectionIn,
                                    const float startXYZ[3],
                                    const float maximumMovementXIn,
                                    const float maximumMovementYIn,
                                    const float maximumMovementZIn);
                                    
      // constructor
      BrainModelSurfaceFindExtremum(BrainSet* brainSetIn,
                                    BrainModelSurface* bmsIn,
                                    const DIRECTION searchDirectionIn,
                                    const int startNodeNumberIn,
                                    const float maximumMovementXIn,
                                    const float maximumMovementYIn,
                                    const float maximumMovementZIn,
                                    const PaintFile* paintFileIn,
                                    const int paintColumnNumberIn,
                                    const int paintIndexIn,
                                    const PAINT_OPERATION paintOperationIn);
                                    
      // destructor
      ~BrainModelSurfaceFindExtremum();
      
      // restrict nodes to those in the roi
      void setNodeRestrictionWithROI(const BrainModelSurfaceROINodeSelection* restrictToROIIn);
      
      // restrict nodes to those with normals of specified signs
      void setNodeNormalRestriction(const NORMAL_RESTRICTION xNormalRestrictionIn,
                                    const NORMAL_RESTRICTION yNormalRestrictionIn,
                                    const NORMAL_RESTRICTION zNormalRestrictionIn);
                                    
      // get the extremum node that was found (-1 if invalid)
      int getExtremumNode() const { return extremumNode; }
      
      // get nodes in path to extremum including extremum
      void getNodeInPathToExtremum(std::vector<int>& nodesInPathToExtremumOut) const;
      
      // set a region of interest to nodes in path
      void setRegionOfInterestToNodesInPath(BrainModelSurfaceROINodeSelection& roi) const;
      
      // execute the algorithm
      void execute() throw (BrainModelAlgorithmException);
      
   protected:
      /// see if a node is within maximum movement allowance
      bool withinMovementAllowance(const float x,
                                   const float y,
                                   const float z) const;
      
      /// check the node's normal
      bool checkNodeNormal(const float* normalVector) const;
      
      /// the surface 
      BrainModelSurface* bms;
      
      /// starting node number
      int startNodeNumber;
      
      /// starting XYZ
      float startXYZ[3];
      
      /// direction to search
      DIRECTION searchDirection;
      
      /// the extremum node that was found
      int extremumNode;
      
      /// maximum movement allowed in X direction when searching for extremum
      float maximumMovementX;
      
      /// maximum movement allowed in Y direction when searching for extremum
      float maximumMovementY;
      
      /// maximum movement allowed in Z direction when searching for extremum
      float maximumMovementZ;
      
      /// nodes in path to extremum
      std::vector<int> nodesInPathToExtremum;
      
      /// paint operation
      PAINT_OPERATION paintOperation;
      
      /// paint file
      PaintFile* paintFile;
      
      /// paint column number
      int paintColumnNumber;
      
      /// paint index
      int paintIndex;
      
      /// normal restrictions
      NORMAL_RESTRICTION normalRestriction[3];
      
      /// search ROI restriction
      BrainModelSurfaceROINodeSelection* restrictToROI;
};

#endif // __BRAIN_MODEL_SURFACE_FIND_EXTREMUM_H__