File: Structure.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 (180 lines) | stat: -rw-r--r-- 7,076 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

#ifndef __STRUCTURE_H__
#define __STRUCTURE_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 structure information
class Structure {
   public:
      /// anatomical structure
      enum STRUCTURE_TYPE {
         /// left cerebral cortex
         STRUCTURE_TYPE_CORTEX_LEFT,
         /// right cerebral cortex
         STRUCTURE_TYPE_CORTEX_RIGHT,
         /// left and right cerebral cortex
         STRUCTURE_TYPE_CORTEX_BOTH,
         /// cerebrellum
         STRUCTURE_TYPE_CEREBELLUM,
         /// cerebral cortex or cerebellum
         STRUCTURE_TYPE_CEREBRUM_CEREBELLUM,
         /// cerebellum or left cerebral cortex (used with foci that could be associated with either)
         STRUCTURE_TYPE_CEREBELLUM_OR_CORTEX_LEFT,
         /// cerebellum or right cerebral cortex (used with foci that could be associated with either)
         STRUCTURE_TYPE_CEREBELLUM_OR_CORTEX_RIGHT,
         /// left cerebral cortex or cerebellum (used with foci that could be associated with either)
         STRUCTURE_TYPE_CORTEX_LEFT_OR_CEREBELLUM,
         /// right cerebral cortex or cerebellum (used with foci that could be associated with either)
         STRUCTURE_TYPE_CORTEX_RIGHT_OR_CEREBELLUM,
         /// subcortical 
         STRUCTURE_TYPE_SUBCORTICAL,
         /// all structures
         STRUCTURE_TYPE_ALL,
         /// invalid
         STRUCTURE_TYPE_INVALID
      };
      
      // constructor
      Structure();
      
      // constructor
      Structure(const STRUCTURE_TYPE st);
      
      // constructor
      Structure(const QString& structureName);
      
      // operator equals
      bool operator==(const Structure& st) const;
      
      // operator not equals
      bool operator!=(const Structure& st) const;
      
      // destructor
      ~Structure();
      
      // get the structure type
      STRUCTURE_TYPE getType() const;
      
      // get the structure type as a string
      QString getTypeAsString() const;
      
      // get the type as a one or two character string
      QString getTypeAsAbbreviatedString() const;
      
      // is left cortex structure
      bool isLeftCortex() const { return (structure == STRUCTURE_TYPE_CORTEX_LEFT); }
      
      // is right cortex structure
      bool isRightCortex() const { return (structure == STRUCTURE_TYPE_CORTEX_RIGHT); }
      
      // is both cortex structure
      bool isBothCortex() const { return (structure == STRUCTURE_TYPE_CORTEX_BOTH); }
      
      // is cerebellum structure
      bool isCerebellum() const { return (structure == STRUCTURE_TYPE_CEREBELLUM); }
      
      // is cerebellum or left cerebral structure
      bool isCerebellumOrLeftCerebral() const { return ((structure == STRUCTURE_TYPE_CEREBELLUM_OR_CORTEX_LEFT) ||
                                                        (structure == STRUCTURE_TYPE_CORTEX_LEFT_OR_CEREBELLUM)); }
      
      // is cerebellum or right cerebral structure
      bool isCerebellumOrRightCerebral() const { return ((structure == STRUCTURE_TYPE_CEREBELLUM_OR_CORTEX_RIGHT) ||
                                                         (structure == STRUCTURE_TYPE_CORTEX_RIGHT_OR_CEREBELLUM)); }
      
      // is invalid structure
      bool isInvalid() const { return (structure == STRUCTURE_TYPE_INVALID); }
      
      // is valid structure
      bool isValid() const { return (structure != STRUCTURE_TYPE_INVALID); }
      
      // set the structure type
      void setType(const STRUCTURE_TYPE st);
      
      // set the structure type from a string (returns true if valid)
      bool setTypeFromString(const QString& hts);
      
      // convert string to type
      static STRUCTURE_TYPE convertStringToType(const QString& s);
      
      // convert type to string
      static QString convertTypeToString(const STRUCTURE_TYPE ht);
      
      // convert type to abbreviated string
      static QString convertTypeToAbbreviatedString(const STRUCTURE_TYPE ht);

      /// get the string value for left cortex structure
      static QString getCortextLeftAsString() { return "left"; }
      
      /// get the string value for right cortex structure
      static QString getCortexRightAsString() { return "right"; }
      
      /// get the string value for cerebellum structure
      static QString getCerebellumAsString() { return "cerebellum"; }
      
      /// get the string value for cerebellum or left cerebral structure
      static QString getCerebellumOrLeftCerebralAsString() { return "cerebellum_or_left_cerebral"; }
      
      /// get the string value for cerebellum or right cerebral structure
      static QString getCerebellumOrRightCerebralAsString() { return "cerebellum_or_right_cerebral"; }
      
      /// get the string value for cerebellum or left cerebral structure
      static QString getLeftCerebralOrCerebellumAsString() { return "left_cerebral_or_cerebellum"; }
      
      /// get the string value for cerebellum or right cerebral structure
      static QString getRightCerebralOrCerebellumAsString() { return "right_cerebral_or_cerebellum"; }
      
      /// get the string value for both (right&left) cortex structure
      static QString getCortexBothAsString() { return "both"; }
      
      /// get the string for cerebrum and cerebellum
      static QString getCerebrumAndCerebellumAsString() { return "cerebrum_cerebellum"; }
      
      /// get the string for subcortical
      static QString getSubCorticalAsString() { return "subcortical"; }
      
      /// get the string for all structures
      static QString getAllAsString() { return "all"; }
      
      /// get the string value for invalid structure
      static QString getInvalidAsString() { return "invalid"; }
      
      /// get all structure types and names
      static void getAllTypesAndNames(std::vector<STRUCTURE_TYPE>& types,
                                      std::vector<QString>& names,
                                      const bool includeInvalid,
                                      const bool includeAmbiguousCerebralOrCerebellum = false);
                                      
   protected:
      /// the structure
      STRUCTURE_TYPE structure;
};

#endif // __STRUCTURE_H__