File: StereotaxicSpace.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 (197 lines) | stat: -rw-r--r-- 6,275 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

#ifndef __STEREOTAXIC_SPACE_H__
#define __STEREOTAXIC_SPACE_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 storing a stereotaxic space
class StereotaxicSpace {
   public:
      /// stereotaxic spaces available
      enum SPACE {
         /// unknown space
         SPACE_UNKNOWN,
         /// other space
         SPACE_OTHER,
         /// AFNI Talairach space
         SPACE_AFNI_TALAIRACH,
         /// FLIRT space
         SPACE_FLIRT,
         /// FLIRT 222 space
         SPACE_FLIRT_222,
         /// macaque atlas
         SPACE_MACAQUE_F6,
         /// Macaque F99
         SPACE_MACAQUE_F99,
         /// MRITOTAL space
         SPACE_MRITOTAL,
         /// SPM space
         SPACE_SPM,
         /// SPM 95 space
         SPACE_SPM_95,
         /// SPM 95 space
         SPACE_SPM_96,
         /// SPM 99 Template space
         SPACE_SPM_99,
         /// SPM 2 Template space
         SPACE_SPM_2,
         /// SPM 5 space
         SPACE_SPM_5,
         /// Talairach 88 space (same as AFNI)
         SPACE_T88,
         /// Washington University 711-2B space
         SPACE_WU_7112B,
         /// Washington University 711-2B 1mm voxelspace
         SPACE_WU_7112B_111,
         /// Washington University 711-2B 2mm voxelspace
         SPACE_WU_7112B_222,
         /// Washington University 711-2B 3mm voxelspace
         SPACE_WU_7112B_333,
         /// Washington University 711-2C space
         SPACE_WU_7112C,
         /// Washington University 711-2C 1mm voxelspace
         SPACE_WU_7112C_111,
         /// Washington University 711-2C 2mm voxelspace
         SPACE_WU_7112C_222,
         /// Washington University 711-2C 3mm voxelspace
         SPACE_WU_7112C_333,
         /// Washington University 711-2O space
         SPACE_WU_7112O,
         /// Washington University 711-2O 1mm voxelspace
         SPACE_WU_7112O_111,
         /// Washington University 711-2O 2mm voxelspace
         SPACE_WU_7112O_222,
         /// Washington University 711-2O 3mm voxelspace
         SPACE_WU_7112O_333,
         /// Washington University 711-2Y space
         SPACE_WU_7112Y,
         /// Washington University 711-2Y 1mm voxelspace
         SPACE_WU_7112Y_111,
         /// Washington University 711-2Y 2mm voxelspace
         SPACE_WU_7112Y_222,
         /// Washington University 711-2Y 3mm voxelspace
         SPACE_WU_7112Y_333,
         /// always last
         SPACE_NUMBER_OF_SPACES
      };
      
      /// constructor
      StereotaxicSpace(const SPACE spaceIn);
      
      /// constructor space name
      StereotaxicSpace(const QString& nameIn);
      
      /// constructor
      StereotaxicSpace();
      
      /// destructor
      ~StereotaxicSpace();
      
      /// equality operator 
      bool operator==(const StereotaxicSpace& ss) { return (space == ss.space); }
      
      /// equality operator 
      bool operator!=(const StereotaxicSpace& ss) { return (space != ss.space); }
      
      /// reset
      void reset();
      
      /// is a valid space (not unknown)
      bool isValid() const { return (space != SPACE_UNKNOWN); }
      
      /// get the space
      SPACE getSpace() const { return space; }
      
      /// get the name of the space
      QString getName() const { return name; }
      
      /// get the dimensions of the space
      void getDimensions(int dimensionsOut[3]) const;
      
      /// get the origin of the space
      void getOrigin(float originOut[3]) const;
      
      /// get the voxel size of the space
      void getVoxelSize(float voxelSizeOut[3]) const;
      
      /// get information about a stereotaxic space
      static StereotaxicSpace getStereotaxicSpace(const SPACE space);
      
      /// get information about a stereotaxic space
      static StereotaxicSpace getStereotaxicSpace(const QString& spaceName);
      
      /// get all stereotaxic spaces
      static void getAllStereotaxicSpaces(std::vector<StereotaxicSpace>& allSpacesOut);
      
      /// get teh space from the name
      static QString cleanupSpaceName(const QString& name);
      
      /// get a space from its name
      static SPACE getSpaceFromName(const QString& name);
      
      /// is the name that of a valid stereotaxic space
      static bool validStereotaxicSpaceName(const QString& name);
      
      /// set data from space
      void setDataFromSpace(const SPACE spaceIn);
      
      /// set data from space name
      void setDataFromSpaceName(const QString& spaceNameIn);
      
   protected:
      /// constructor
      StereotaxicSpace(const QString& nameIn,
                       const int dimensionsIn[3],
                       const float originIn[3],
                       const float voxelSizeIn[3]);
                       
      /// set the space data
      void setData(const QString& nameIn,
                  const int dimX, const int dimY, const int dimZ,
                  const float voxSizeX, const float voxSizeY, const float voxSizeZ,
                  const float originX, const float originY, const float originZ);
                       
      /// the space
      SPACE space;
      
      /// name of the space
      QString name;
      
      /// dimensions of the space
      int dimensions[3];
      
      /// origin of the spcae
      float origin[3];
      
      /// voxel size of the space
      float voxelSize[3];
};

#endif // __STEREOTAXIC_SPACE_H__