File: BrainModelSurfaceFindExtremum.cxx

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 (478 lines) | stat: -rw-r--r-- 15,218 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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478

/*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 <cmath>

#include "BrainModelSurface.h"
#include "BrainModelSurfaceFindExtremum.h"
#include "BrainModelSurfaceROINodeSelection.h"
#include "PaintFile.h"
#include "TopologyFile.h"
#include "TopologyHelper.h"

/**
 * constructor.
 */
BrainModelSurfaceFindExtremum::BrainModelSurfaceFindExtremum(BrainSet* brainSetIn,
                              BrainModelSurface* bmsIn,
                              const DIRECTION searchDirectionIn,
                              const int startNodeNumberIn,
                              const float maximumMovementXIn,
                              const float maximumMovementYIn,
                              const float maximumMovementZIn)
   : BrainModelAlgorithm(brainSetIn)
{
   bms = bmsIn;
   startNodeNumber = startNodeNumberIn;
   searchDirection = searchDirectionIn;
   startXYZ[0] = 0.0;
   startXYZ[1] = 0.0;
   startXYZ[2] = 0.0;
   extremumNode = -1;
   maximumMovementX = maximumMovementXIn;
   maximumMovementY = maximumMovementYIn;
   maximumMovementZ = maximumMovementZIn;
   paintOperation = PAINT_OPERATION_NONE;
   normalRestriction[0] = NORMAL_RESTRICTION_NONE;
   normalRestriction[1] = NORMAL_RESTRICTION_NONE;
   normalRestriction[2] = NORMAL_RESTRICTION_NONE;
   restrictToROI = NULL;
}
                              
/**
 * constructor.
 */
BrainModelSurfaceFindExtremum::BrainModelSurfaceFindExtremum(BrainSet* brainSetIn,
                              BrainModelSurface* bmsIn,
                              const DIRECTION searchDirectionIn,
                              const float startXYZIn[3],
                              const float maximumMovementXIn,
                              const float maximumMovementYIn,
                              const float maximumMovementZIn)
   : BrainModelAlgorithm(brainSetIn)
{
   bms = bmsIn;
   startNodeNumber = -1;
   searchDirection = searchDirectionIn;
   startXYZ[0] = startXYZIn[0];
   startXYZ[1] = startXYZIn[1];
   startXYZ[2] = startXYZIn[2];
   extremumNode = -1;
   maximumMovementX = maximumMovementXIn;
   maximumMovementY = maximumMovementYIn;
   maximumMovementZ = maximumMovementZIn;
   paintOperation = PAINT_OPERATION_NONE;
   normalRestriction[0] = NORMAL_RESTRICTION_NONE;
   normalRestriction[1] = NORMAL_RESTRICTION_NONE;
   normalRestriction[2] = NORMAL_RESTRICTION_NONE;
   restrictToROI = NULL;
}

/**
 * constructor.
 */
BrainModelSurfaceFindExtremum::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)
   : BrainModelAlgorithm(brainSetIn)
{
   bms = bmsIn;
   startNodeNumber = startNodeNumberIn;
   searchDirection = searchDirectionIn;
   startXYZ[0] = 0.0;
   startXYZ[1] = 0.0;
   startXYZ[2] = 0.0;
   extremumNode = -1;
   maximumMovementX = maximumMovementXIn;
   maximumMovementY = maximumMovementYIn;
   maximumMovementZ = maximumMovementZIn;
   paintFile = (PaintFile*)paintFileIn;
   paintColumnNumber = paintColumnNumberIn;
   paintIndex = paintIndexIn;
   paintOperation = paintOperationIn;
   normalRestriction[0] = NORMAL_RESTRICTION_NONE;
   normalRestriction[1] = NORMAL_RESTRICTION_NONE;
   normalRestriction[2] = NORMAL_RESTRICTION_NONE;
   restrictToROI = NULL;
}
                                    
                              
/**
 * destructor.
 */
BrainModelSurfaceFindExtremum::~BrainModelSurfaceFindExtremum()
{
}

/**
 * execute the algorithm.
 */
void 
BrainModelSurfaceFindExtremum::execute() throw (BrainModelAlgorithmException)
{
   nodesInPathToExtremum.clear();
   
   if (searchDirection == DIRECTION_INVALID) {
      throw BrainModelAlgorithmException("Search direction is invalid.");
   }
   if (bms == NULL) {
      throw BrainModelAlgorithmException("Surface is invalid.");
   }
   const CoordinateFile* cf = bms->getCoordinateFile();
   const int numNodes = bms->getNumberOfNodes();
   if (numNodes <= 0) {
      throw BrainModelAlgorithmException("Surface contains no nodes.");
   }
   const TopologyFile* tf = bms->getTopologyFile();
   if (tf == NULL) {
      throw BrainModelAlgorithmException("Surface has no topology.");
   }
   const TopologyHelper* th = tf->getTopologyHelper(false, true, false);
   
   switch (paintOperation) {
      case PAINT_OPERATION_NONE:
         break;
      case PAINT_OPERATION_STOP_WHEN_PAINT_ID_CHANGES:
         if (paintFile == NULL) {
            throw BrainModelAlgorithmException("Paint file is invalid.");
         }
         if ((paintColumnNumber < 0) ||
             (paintColumnNumber >= paintFile->getNumberOfColumns())) {
            throw BrainModelAlgorithmException("Paint column number is invalid.");
         }
         break;
   }
   //
   // Convert lateral/medial search to negative or positive X search
   //
   if (searchDirection == DIRECTION_LATERAL) {
      if (bms->getStructure().getType() == Structure::STRUCTURE_TYPE_CORTEX_LEFT) {
         searchDirection = DIRECTION_X_NEGATIVE;
      }
      else if (bms->getStructure().getType() == Structure::STRUCTURE_TYPE_CORTEX_RIGHT) {
         searchDirection = DIRECTION_X_POSITIVE;
      }
      else {
         throw BrainModelAlgorithmException(
            "Surface has invalid structure need to for lateral search.");
      }
   }
   else if (searchDirection == DIRECTION_MEDIAL) {
      if (bms->getStructure().getType() == Structure::STRUCTURE_TYPE_CORTEX_LEFT) {
         searchDirection = DIRECTION_X_POSITIVE;
      }
      else if (bms->getStructure().getType() == Structure::STRUCTURE_TYPE_CORTEX_RIGHT) {
         searchDirection = DIRECTION_X_NEGATIVE;
      }
      else {
         throw BrainModelAlgorithmException(
            "Surface has invalid structure need to for lateral search.");
      }
   }
   
   //
   // If extremum node was not set, find node closest to start XYZ
   //
   if (startNodeNumber < 0) {
      startNodeNumber = bms->getNodeClosestToPoint(startXYZ);
   }
   else {
      cf->getCoordinate(startNodeNumber, startXYZ);
   }
   extremumNode = startNodeNumber;
   if (extremumNode < 0) {
      throw BrainModelAlgorithmException("Unable to determine starting node from XYZ.");
   }
   
   //
   // add nodes to path
   //
   nodesInPathToExtremum.push_back(extremumNode);

   //
   // Search surface until unable to proceed any further
   //
   bool done = false;
   while (done == false) {
      //
      // node's XYZ
      //
      float x, y, z;
      cf->getCoordinate(extremumNode, x, y, z);
      
      //
      // Get the neighbors of the current node
      //
      int numNeighbors = 0;
      const int* neighbors = th->getNodeNeighbors(extremumNode, 
                                                  numNeighbors);
      
      //
      // next node and value for searching
      //
      int nextNode = -1;
      float nextValue = 0.0;
      
      //
      // Loop through neighbors
      //
      for (int j = 0; j < numNeighbors; j++) {
         const int neighborNode = neighbors[j];
         float nx, ny, nz;
         cf->getCoordinate(neighborNode, nx, ny, nz);
         
         if (restrictToROI != NULL) {
            if (restrictToROI->getNodeSelected(neighborNode) == false) {
               continue;
            }
         }
         
         if (checkNodeNormal(bms->getNormal(neighborNode))) {
            switch (searchDirection) {
               case DIRECTION_INVALID:
                  break;
               case DIRECTION_LATERAL:
                  break;
               case DIRECTION_MEDIAL:
                  break;
               case DIRECTION_X_NEGATIVE:
                  if (nx < x) {
                     if ((nextNode < 0) ||
                         (nx < nextValue)) {
                        if (withinMovementAllowance(nx, ny, nz)) {
                           nextNode = neighborNode;
                           nextValue = nx;
                        }
                     }
                  }
                  break;
               case DIRECTION_X_POSITIVE:
                  if (nx > x) {
                     if ((nextNode < 0) ||
                         (nx > nextValue)) {
                        if (withinMovementAllowance(nx, ny, nz)) {
                           nextNode = neighborNode;
                           nextValue = nx;
                        }
                     }
                  }
                  break;
               case DIRECTION_Y_NEGATIVE:
                  if (ny < y) {
                     if ((nextNode < 0) ||
                         (ny < nextValue)) {
                        if (withinMovementAllowance(nx, ny, nz)) {
                           nextNode = neighborNode;
                           nextValue = ny;
                        }
                     }
                  }
                  break;
               case DIRECTION_Y_POSITIVE:
                  if (ny > y) {
                     if ((nextNode < 0) ||
                         (ny > nextValue)) {
                        if (withinMovementAllowance(nx, ny, nz)) {
                           nextNode = neighborNode;
                           nextValue = ny;
                        }
                     }
                  }
                  break;
               case DIRECTION_Z_NEGATIVE:
                  if (nz < z) {
                     if ((nextNode < 0) ||
                         (nz < nextValue)) {
                        if (withinMovementAllowance(nx, ny, nz)) {
                           nextNode = neighborNode;
                           nextValue = nz;
                        }
                     }
                  }
                  break;
               case DIRECTION_Z_POSITIVE:
                  if (nz > z) {
                     if ((nextNode < 0) ||
                         (nz > nextValue)) {
                        if (withinMovementAllowance(nx, ny, nz)) {
                           nextNode = neighborNode;
                           nextValue = nz;
                        }
                     }
                  }
                  break;
            }
         }
      }
      
      //
      // Was next node found ?
      //
      if (nextNode >= 0) {
         //
         // Check paint ?
         //
         switch (paintOperation) {
            case PAINT_OPERATION_NONE:
               break;
            case PAINT_OPERATION_STOP_WHEN_PAINT_ID_CHANGES:
               //
               // Did paint change?
               //
               if (paintFile->getPaint(nextNode, paintColumnNumber)
                   != paintIndex) {
                  done = true;
               }
               break;
         }
         if (done == false) {
            //
            // move to next node
            //
            extremumNode = nextNode;
         
            //
            // add nodes to path
            //
            nodesInPathToExtremum.push_back(extremumNode);
         }
      }
      else {
         //
         // done
         //
         done = true;
      }
   }
}
      
/**
 * see if a node is within maximum movement allowance.
 */
bool 
BrainModelSurfaceFindExtremum::withinMovementAllowance(const float x,
                                                       const float y,
                                                       const float z) const
{
   const float dx = std::fabs(x - startXYZ[0]);
   const float dy = std::fabs(y - startXYZ[1]);
   const float dz = std::fabs(z - startXYZ[2]);
   
   //std::cout << "y: " << y 
   //          << "  dy: " << dy
   //          << "  maximumMovementY: " << maximumMovementY
   //          << std::endl;
   if ((dx < maximumMovementX) &&
       (dy < maximumMovementY) &&
       (dz < maximumMovementZ)) {
      return true;
   }
   
   return false;
}
      
/**
 * check the node's normal.
 */
bool 
BrainModelSurfaceFindExtremum::checkNodeNormal(const float* normalVector) const
{
   for (int i = 0; i < 3; i++) {
      switch (normalRestriction[i]) {
         case NORMAL_RESTRICTION_NONE:
            break;
         case NORMAL_RESTRICTION_NEGATIVE:
            if (normalVector[i] >= 0.0) {
               return false;
            }
         case NORMAL_RESTRICTION_POSITIVE:
            if (normalVector[i] <= 0.0) {
               return false;
            }
      }
   }
   
   return true;
}
      
/**
 * get nodes in path to extremum including extremum.
 */
void 
BrainModelSurfaceFindExtremum::getNodeInPathToExtremum(std::vector<int>& nodesInPathToExtremumOut) const
{
   nodesInPathToExtremumOut = nodesInPathToExtremum;
}
      
/**
 * set a region of interest to nodes in path.
 */
void 
BrainModelSurfaceFindExtremum::setRegionOfInterestToNodesInPath(BrainModelSurfaceROINodeSelection& roi) const
{
   roi.update();
   
   roi.deselectAllNodes();
   
   const int num = nodesInPathToExtremum.size();
   for (int i = 0; i < num; i++) {
      roi.setNodeSelected(nodesInPathToExtremum[i], 1);
   }
}
      
/**
 * restrict nodes to those with normals of specified signs.
 */
void 
BrainModelSurfaceFindExtremum::setNodeNormalRestriction(
                                 const NORMAL_RESTRICTION xNormalRestrictionIn,
                                 const NORMAL_RESTRICTION yNormalRestrictionIn,
                                 const NORMAL_RESTRICTION zNormalRestrictionIn)
{
   normalRestriction[0] = xNormalRestrictionIn;
   normalRestriction[1] = yNormalRestrictionIn;
   normalRestriction[2] = zNormalRestrictionIn;
}                                    

/**
 * restrict nodes to those in the roi.
 */
void 
BrainModelSurfaceFindExtremum::setNodeRestrictionWithROI(
   const BrainModelSurfaceROINodeSelection* restrictToROIIn)
{
   restrictToROI = (BrainModelSurfaceROINodeSelection*)restrictToROIIn;
}