File: DisplaySettingsVolume.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 (433 lines) | stat: -rw-r--r-- 16,056 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
/*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*/

#ifndef __DISPLAY_SETTINGS_VOLUME_H__
#define __DISPLAY_SETTINGS_VOLUME_H__

#include "DisplaySettings.h"

class BrainModelSurface;
class TransformationMatrix;
class VolumeFile;

/// Display settings for volumes
class DisplaySettingsVolume : public DisplaySettings {
   public:
      /// anatomy coloring type
      enum ANATOMY_COLORING_TYPE {
         ANATOMY_COLORING_TYPE_0_255,
         ANATOMY_COLORING_TYPE_MIN_MAX,
         ANATOMY_COLORING_TYPE_2_98,
      };
      
      /// segmentation draw type
      enum SEGMENTATION_DRAW_TYPE {
         SEGMENTATION_DRAW_TYPE_BLEND,
         SEGMENTATION_DRAW_TYPE_SOLID,
         SEGMENTATION_DRAW_TYPE_BOX,
         SEGMENTATION_DRAW_TYPE_CROSS
      };
      
      /// coloring for surface outline
      enum SURFACE_OUTLINE_COLOR {
         SURFACE_OUTLINE_COLOR_BLACK,
         SURFACE_OUTLINE_COLOR_BLUE,
         SURFACE_OUTLINE_COLOR_GREEN,
         SURFACE_OUTLINE_COLOR_RED,
         SURFACE_OUTLINE_COLOR_WHITE
      };

      /// misc values
      enum {
         /// maximum number of overlay surfaces
         MAXIMUM_OVERLAY_SURFACES = 9
      };
      
      /// Constructor
      DisplaySettingsVolume(BrainSet* bs);
      
      /// Destructor
      ~DisplaySettingsVolume();

      /// Reinitialize all display settings
      virtual void reset();
      
      /// Update any selections due to changes in loaded volumes
      virtual void update();

      /// get the segmentation draw type
      SEGMENTATION_DRAW_TYPE getSegmentationDrawType() const { return segmentationDrawType; }
      
      /// set the segmentation draw type
      void setSegmentationDrawType(const SEGMENTATION_DRAW_TYPE sdt) { segmentationDrawType = sdt; }
      
      /// get the selected functional volume file for viewing
      int getSelectedFunctionalVolumeView() const { return selectedFunctionalVolumeView; }
      
      /// set the selected functional volume file for viewing
      void setSelectedFunctionalVolumeView(const int index) {
         selectedFunctionalVolumeView = index;
      }
      
      /// set the selected functional volume file for viewing
      void setSelectedFunctionalVolumeView(const QString& name);
      
      /// get the selected functional volume file for thresholding
      int getSelectedFunctionalVolumeThreshold() const { return selectedFunctionalVolumeThreshold; }
      
      /// set the selected functional volume file for thresholding
      void setSelectedFunctionalVolumeThreshold(const int index) {
         selectedFunctionalVolumeThreshold = index;
      }
      
      /// set the selected functional volume file for thresholding
      void setSelectedFunctionalVolumeThreshold(const QString& name);
      
      /// get the selected paint volume file
      int getSelectedPaintVolume() const { return selectedPaintVolume; }
      
      /// set the selected paint volume file
      void setSelectedPaintVolume(const int index) {
         selectedPaintVolume = index;
      }
      
      /// set the selected paint volume file
      void setSelectedPaintVolume(const QString& name);
      
      /// get the selected rgb volume file
      int getSelectedRgbVolume() const { return selectedRgbVolume; }
      
      /// set the selected rgb volume file
      void setSelectedRgbVolume(const int index) {
         selectedRgbVolume = index;
      }
      
      /// set the selected rgb volume file
      void setSelectedRgbVolume(const QString& name);
      
      /// get the selected segmentation volume file
      int getSelectedSegmentationVolume() const { return selectedSegmentationVolume; }
      
      /// set the selected segmentation volume file
      void setSelectedSegmentationVolume(const int index) {
         selectedSegmentationVolume = index;
      }
      
      /// set the selected segmentation volume file
      void setSelectedSegmentationVolume(const QString& name);
      
      /// get the selected anatomy volume file
      int getSelectedAnatomyVolume() const { return selectedAnatomyVolume; }
      
      /// set the selected anatomy volume file
      void setSelectedAnatomyVolume(const int index) {
         selectedAnatomyVolume = index;
      }
      
      /// set the selected anatomy volume file
      void setSelectedAnatomyVolume(const QString& name);
      
      /// get the anatomy volume brightness
      int getAnatomyVolumeBrightness() const { return anatomyVolumeBrightness; }
      
      /// get the anatomy volume contrast
      int getAnatomyVolumeContrast() const { return anatomyVolumeContrast; }
      
      /// set the anatomy volume brightness
      void setAnatomyVolumeBrightness(const int brightness) { 
         anatomyVolumeBrightness = brightness; 
      }
      
      /// set the anatomy volume contrast
      void setAnatomyVolumeContrast(const int contrast)  { 
         anatomyVolumeContrast = contrast; 
      }
      
      /// get the selected vector volume file
      int getSelectedVectorVolume() const { return selectedVectorVolume; }
      
      /// set the selected vector volume file
      void setSelectedVectorVolume(const int index) {
         selectedVectorVolume = index;
      }
      
      /// set the selected vector volume file
      void setSelectedVectorVolume(const QString& name);
      
      /// get vector volume sparsity
      int getVectorVolumeSparsity() const { return vectorVolumeSparsity; }
      
      /// set vector volume sparsity
      void setVectorVolumeSparsity(const int vvs) { vectorVolumeSparsity = vvs; }
      
      /// get display the crosshair coordinates
      bool getDisplayCrosshairCoordinates() const { return displayCrosshairCoordinates; }
      
      /// set display the crosshair coordinates
      void setDisplayCrosshairCoordinates(const bool d) { displayCrosshairCoordinates = d; }

      /// get display the crosshairs
      bool getDisplayCrosshairs() const { return displayCrosshairs; }
      
      /// set display the crosshairss
      void setDisplayCrosshairs(const bool d) { displayCrosshairs = d; }

      /// get display the orientation labels
      bool getDisplayOrientationLabels() const { return displayOrientationLabels; }
      
      /// set display the orientation labels
      void setDisplayOrientationLabels(const bool d) { displayOrientationLabels = d; }
      
      /// get the anatomical volume coloring type
      ANATOMY_COLORING_TYPE getAnatomyVolumeColoringType() const { return anatomyColoringType; }
      
      /// set the anatomy volume coloring type
      void setAnatomyVolumeColoringType(const ANATOMY_COLORING_TYPE act)
         { anatomyColoringType = act; };
         
      /// set the cropping slices valid
      void setCroppingSlicesValid(const bool b) { croppingSlicesValid = b; }
      
      /// get the cropping slices valid
      bool getCroppingSlicesValid() const { return croppingSlicesValid; }
   
      /// set the cropping slices
      void setCroppingSlices(const int slices[6]);
      
      /// get the cropping slices
      void getCroppingSlices(int slices[6]) const;
      
      /// get the anatomy thresholding valid
      bool getAnatomyThresholdValid() const { return anatomyThresholdValid; }
      
      /// set the anatomy thresholding valid
      void setAnatomyThresholdValid(const bool b) { anatomyThresholdValid = b; }
      
      /// get the anatomy threshold value
      void getAnatomyThreshold(float& minThresh, float& maxThresh) const;
      
      /// set the anatomy threshold value
      void setAnatomyThreshold(const float minThresh,
                               const float maxThresh = 1.0e10);
      
      /// get the segmentation translucency
      float getSegmentationTranslucency() const { return segmentationTranslucency; }
      
      /// set the segmentation translucency
      void setSegmentationTranslucency(const float st) { segmentationTranslucency = st; }
      
      /// get montage view selected
      bool getMontageViewSelected() const { return montageViewSelected; }
      
      /// set montage view selected
      void setMontageViewSelected(const int b) { montageViewSelected = b; }
      
      /// get volume montage settings (returns true if montage on)
      void getMontageViewSettings(int& numRows, int& numSlices, int& sliceIncrement) const;
      
      /// set volume montage settings 
      void setMontageViewSettings(const int numRows, const int numCols, 
                                  const int sliceIncrement);
      
      /// apply a scene (set display settings)
      virtual void showScene(const SceneFile::Scene& scene, QString& errorMessage) ;
      
      /// create a scene (read display settings)
      virtual void saveScene(SceneFile::Scene& scene, const bool onlyIfSelected,
                             QString& errorMessage);
                     
      /// get the overlay opacity
      float getOverlayOpacity() const { return overlayOpacity; }
      
      /// set the overlay opacity
      void setOverlayOpacity(const float oo) { overlayOpacity = oo; }
      
      /// get show palette color bar
      bool getDisplayColorBar() const { return displayColorBar; }
      
      /// set show palette color bar
      void setDisplayColorBar(const bool showIt) { displayColorBar = showIt; }
      
      /// get the oblique slices transformation matrix
      TransformationMatrix* getObliqueSlicesTransformationMatrix()
          { return obliqueTransform; }
          
      /// set the oblique slices transformation matrix
      void setObliqueSlicesTransformationMatrix(TransformationMatrix* tm)
          { obliqueTransform = tm; }
          
      /// get the oblique slices sampling size
      float getObliqueSlicesSamplingSize() const { return obliqueSlicesSamplingSize; }
      
      /// set the oblique slices samping size
      void setObliqueSlicesSamplingSize(const float ss)
              { obliqueSlicesSamplingSize = ss; }
         
      ///  Get one of the "overlay" surfaces.
      BrainModelSurface* getOverlaySurface(const int overlaySurfaceNumber);

      /// Set one of the "overlay" surfaces.
      void setOverlaySurface(const int overlaySurfaceNumber,
                             BrainModelSurface* bms);
                            
      /// get display overlay surface over the volume
      bool getDisplayOverlaySurfaceOutline(const int overlaySurfaceNumber) const
                               { return displayOverlaySurfaceOutline[overlaySurfaceNumber]; }
      
      /// set display overlay surface over the volume
      void setDisplayOverlaySurfaceOutline(const int overlaySurfaceNumber,
                                           const bool dso)
                                 { displayOverlaySurfaceOutline[overlaySurfaceNumber] = dso; }
      
      /// get the overlay surface outline color
      SURFACE_OUTLINE_COLOR getOverlaySurfaceOutlineColor(const int overlaySurfaceNumber) const
                              { return overlaySurfaceOutlineColor[overlaySurfaceNumber]; } 

      /// set the overlay surface outline color
      void setOverlaySurfaceOutlineColor(const int overlaySurfaceNumber,
                             const SURFACE_OUTLINE_COLOR soc)
                              { overlaySurfaceOutlineColor[overlaySurfaceNumber] = soc; } 

      /// get the overlay surface outline thickness
      float getOverlaySurfaceOutlineThickness(const int overlaySurfaceNumber) const 
                                 { return overlaySurfaceOutlineThickness[overlaySurfaceNumber]; }
      
      /// set the overlay surface outline thickness
      void setOverlaySurfaceOutlineThickness(const int overlaySurfaceNumber,
                                             const float sot) 
                                    { overlaySurfaceOutlineThickness[overlaySurfaceNumber] = sot; }
      
   private:
      /// file selection helper
      int fileSelectionHelper(const std::vector<VolumeFile*>& files,
                              const QString& fileName);
                              
      /// help save volume file for scene
      void sceneSelectedVolumeHelper(SceneFile::SceneClass& sceneClass,
                                     const QString& infoName,
                                     const VolumeFile* vf);
      
      /// anatomy threshold valid
      bool anatomyThresholdValid;
      
      /// anatomy threshold
      float anatomyThreshold[2];
      
      /// cropping slices are valid
      bool croppingSlicesValid;
      
      /// the cropping slices
      int croppingSlices[6];
      
      /// update the selection index for a file type
      void updateFileType(const int numFiles, int& selectedIndex);
      
      /// selected functional volume file for viewing
      int selectedFunctionalVolumeView;
      
      /// selected functional volume file for thresholding
      int selectedFunctionalVolumeThreshold;
      
      /// selected paint volume file
      int selectedPaintVolume;
      
      /// selected rgb volume file
      int selectedRgbVolume;
      
      /// selected segmentation volume file
      int selectedSegmentationVolume;
      
      /// selected vector volume file
      int selectedVectorVolume;
      
      /// selected anatomy volume file
      int selectedAnatomyVolume;
      
      /// anatomy volume brightness
      int anatomyVolumeBrightness;
      
      /// anatomy volume contrast
      int anatomyVolumeContrast;
      
      /// display the crosshair coordinates
      bool displayCrosshairCoordinates;
      
      /// display the crosshairs
      bool displayCrosshairs;
      
      /// display the orientation labels
      bool displayOrientationLabels;
      
      /// anatomy coloring type
      ANATOMY_COLORING_TYPE anatomyColoringType;
      
      /// segmentation draw type
      SEGMENTATION_DRAW_TYPE segmentationDrawType;
      
      /// segmentation translucency
      float segmentationTranslucency;

      /// montage view selected
      bool montageViewSelected;
      
      /// montage view number of rows
      int montageViewNumberOfRows;
      
      /// montage view number of columns
      int montageViewNumberOfColumns;
      
      /// montage slice increment
      int montageSliceIncrement;
      
      /// overlay opacity
      float overlayOpacity;
      
      /// show color palette color bar
      bool displayColorBar;
      
      /// vector volume sparsity
      int vectorVolumeSparsity;
      
      /// oblique slices transform
      TransformationMatrix* obliqueTransform;
      
      /// oblique slices sampling size
      float obliqueSlicesSamplingSize;
      
      /// surface outlines overlayed on volume slices
      BrainModelSurface* overlaySurface[MAXIMUM_OVERLAY_SURFACES];
      
      /// display overlay surface outline over the volume
      bool displayOverlaySurfaceOutline[MAXIMUM_OVERLAY_SURFACES];
      
      /// surface overlay outline color
      SURFACE_OUTLINE_COLOR overlaySurfaceOutlineColor[MAXIMUM_OVERLAY_SURFACES];
      
      /// surface overlay outline thickness
      float overlaySurfaceOutlineThickness[MAXIMUM_OVERLAY_SURFACES];
      
};

#endif // __DISPLAY_SETTINGS_VOLUME_H__