File: CommandSurfaceSulcalIdentificationProbabilistic.cxx

package info (click to toggle)
caret 5.6.1.3~dfsg.1-4
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 23,352 kB
  • ctags: 27,394
  • sloc: cpp: 363,314; python: 6,718; ansic: 5,507; makefile: 227; sh: 9
file content (303 lines) | stat: -rw-r--r-- 12,607 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
/*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 "AreaColorFile.h"
#include "BrainModelSurface.h"
#include "BrainModelSurfaceSulcalIdentificationProbabilistic.h"
#include "BrainSet.h"
#include "CommandSurfaceSulcalIdentificationProbabilistic.h"
#include "FileFilters.h"
#include "PaintFile.h"
#include "ProgramParameters.h"
#include "SpecFile.h"
#include "SurfaceShapeFile.h"

/**
 * constructor.
 */
CommandSurfaceSulcalIdentificationProbabilistic::CommandSurfaceSulcalIdentificationProbabilistic()
   : CommandBase("-surface-sulcal-identification-probabilistic",
                 "SURFACE SULCAL IDENTIFICATION PROBABILISTIC")
{
}

/**
 * destructor.
 */
CommandSurfaceSulcalIdentificationProbabilistic::~CommandSurfaceSulcalIdentificationProbabilistic()
{
}

/**
 * get the script builder parameters.
 */
void
CommandSurfaceSulcalIdentificationProbabilistic::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{
   paramsOut.clear();
   paramsOut.addFile("Input Fiducial Coord File Name",
                     FileFilters::getCoordinateFiducialFileFilter());
   paramsOut.addFile("Input Inflated Coord File Name",
                     FileFilters::getCoordinateInflatedFileFilter());
   paramsOut.addFile("Input Very Inflated Coord File Name",
                     FileFilters::getCoordinateVeryInflatedFileFilter());
   paramsOut.addFile("Input Closed Topology File Name",
                     FileFilters::getTopologyClosedFileFilter());
   paramsOut.addFile("Input Paint File Name",
                     FileFilters::getPaintFileFilter());
   paramsOut.addFile("Output Paint File Name",
                     FileFilters::getPaintFileFilter());
   paramsOut.addFile("Input Area Color File Name",
                     FileFilters::getAreaColorFileFilter());
   paramsOut.addFile("Output Area Color File Name",
                     FileFilters::getAreaColorFileFilter());
   paramsOut.addString("Input Paint Geography Column");
   paramsOut.addFile("Input Surface Shape File Name",
                     FileFilters::getSurfaceShapeFileFilter());
   paramsOut.addString("Input Surface Shape Depth Column");
   paramsOut.addFile("Probabilistic Sulcus Volume list",
                     "*.csv");
   paramsOut.addFloat("Post Central Sulcus Offset", 25.0);
   paramsOut.addFloat("Post Central Sulcus Std Dev Squared", 100.0);
   paramsOut.addFloat("Post Central Sulcus Split", 5.0);
}

/**
 * get full help information.
 */
QString 
CommandSurfaceSulcalIdentificationProbabilistic::getHelpInformation() const
{
   QString helpInfo =
      (indent3 + getShortDescription() + "\n"
       + indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + "  \n"
       + indent9 + "<input-fiducial-coord-file-name>  \n"
       + indent9 + "<input-inflated-coord-file-name> \n"
       + indent9 + "<input-very-inflated-coord-file-name> \n"
       + indent9 + "<input-closed-topo-file-name>  \n"
       + indent9 + "<input-paint-file-name>  \n"
       + indent9 + "<output-paint-file-name> \n" 
       + indent9 + "<input-paint-file-geography-column-name-or-number>  \n"
       + indent9 + "<input-area-color-file-name>  \n"
       + indent9 + "<output-area-color-file-name> \n" 
       + indent9 + "<input-surface-shape-file-name>  \n"
       + indent9 + "<input-surface-shape-file-depth-column-name-or-number>  \n"
       + indent9 + "<input-probabilistic-suclus-volume-list-file.csv>  \n"
       + indent9 + "<input-post-central-sulcus-offset>  \n" 
       + indent9 + "<input-post-central-sulcus-std-dev-squared>  \n" 
       + indent9 + "<input-post-central-sulcus-split>  \n" 
       + indent9 + "\n" 
       + indent9 + "Identify sulci on a surface by mapping a probabilistic volume. \n" 
       + indent9 + "\n"
       + indent9 + "Note: Paint and Surface Shape file column numbers start at one. \n"
       + indent9 + "\n");
      
   return helpInfo;
}

/**
 * execute the command.
 */
void 
CommandSurfaceSulcalIdentificationProbabilistic::executeCommand() throw (BrainModelAlgorithmException,
                                     CommandException,
                                     FileException,
                                     ProgramParametersException,
                                     StatisticException)
{
   //
   // Get the parameters from those passed to base class
   //
   const QString fiducialCoordFileName = 
      parameters->getNextParameterAsString("Input Fiducial Coord File Name");
   const QString inflatedCoordFileName =
      parameters->getNextParameterAsString("Input Inflated Coord File Name");
   const QString veryInflatedCoordFileName =
      parameters->getNextParameterAsString("Input Very Inflated Coord File Name");
   const QString inputTopoFileName =
      parameters->getNextParameterAsString("Input Closed Topology File Name");
   const QString paintFileName = 
      parameters->getNextParameterAsString("Input Paint File Name");
   const QString outputPaintFileName =
      parameters->getNextParameterAsString("Output Paint File Name");
   const QString paintFileGeographyColumnNameOrNumber = 
      parameters->getNextParameterAsString("Paint File Geography Column Name or Number");
   const QString inputAreaColorFileName = 
      parameters->getNextParameterAsString("Input Area Color File Name");
   const QString outputAreaColorFileName =
      parameters->getNextParameterAsString("Output Area Color File Name");
   const QString surfaceShapeFileName = 
      parameters->getNextParameterAsString("Surface Shape File Name");
   const QString surfaceShapeFileDepthColumnNameOrNumber = 
      parameters->getNextParameterAsString("Surface Shape File Depth Column Name or Number");
   const QString probabilisticSulcusVolumeListFileName = 
      parameters->getNextParameterAsString("Probabilistic Sulcus/Volume List File (CSV)");
   const float postCentralSulcusOffset = 
      parameters->getNextParameterAsFloat("Post Central Sulcus Offset");
   const float postCentralSulcusStdDevSquared = 
      parameters->getNextParameterAsFloat("Post Central Sulcus Std Dev Squared");
   const float postCentralSulcusSplit = 
      parameters->getNextParameterAsFloat("Post Central Sulcus Split");
   
   //
   // Make sure that are no more parameters
   //
   checkForExcessiveParameters();

   //
   // Create a spec file
   //
   SpecFile specFile;
   specFile.setAllFileSelections(SpecFile::SPEC_FALSE);
   specFile.addToSpecFile(SpecFile::getFiducialCoordFileTag(), 
                          fiducialCoordFileName, 
                          "", 
                          SpecFile::SPEC_FALSE);
   specFile.addToSpecFile(SpecFile::getInflatedCoordFileTag(),
                          inflatedCoordFileName,
                          "",
                          SpecFile::SPEC_FALSE);
   specFile.addToSpecFile(SpecFile::getVeryInflatedCoordFileTag(),
                          veryInflatedCoordFileName,
                          "",
                          SpecFile::SPEC_FALSE);
   specFile.addToSpecFile(SpecFile::getClosedTopoFileTag(), 
                          inputTopoFileName, 
                          "", 
                          SpecFile::SPEC_FALSE);
   specFile.addToSpecFile(SpecFile::getPaintFileTag(), 
                          paintFileName, 
                          "", 
                          SpecFile::SPEC_FALSE);
   if (inputAreaColorFileName.isEmpty() == false) {
      if (QFile::exists(inputAreaColorFileName)) {
         specFile.addToSpecFile(SpecFile::getAreaColorFileTag(), 
                                inputAreaColorFileName, 
                                "", 
                                SpecFile::SPEC_FALSE);
      }
   }
   specFile.addToSpecFile(SpecFile::getSurfaceShapeFileTag(), 
                          surfaceShapeFileName, 
                          "", 
                          SpecFile::SPEC_FALSE);
   
   //
   // Read the spec file into a brain set
   //
   QString errorMessage;
   BrainSet brainSet(true);
   if (brainSet.readSpecFile(specFile, "temp", errorMessage)) {
      const QString msg("ERROR: Reading spec file data files: \n"
                        + errorMessage);
      throw CommandException(msg);
   }
   
   //
   // Find the fiducial and very inflated surfaces
   //
   BrainModelSurface* fiducialSurface = NULL;
   BrainModelSurface* inflatedSurface = NULL;
   BrainModelSurface* veryInflatedSurface = NULL;
   for (int i = 0; i < brainSet.getNumberOfBrainModels(); i++) {
      BrainModelSurface* bms = brainSet.getBrainModelSurface(i);
      if (bms != NULL) {
         if (bms->getSurfaceType() == BrainModelSurface::SURFACE_TYPE_FIDUCIAL) {
            fiducialSurface = bms;
         }
         else if (bms->getSurfaceType() == BrainModelSurface::SURFACE_TYPE_INFLATED) {
            inflatedSurface = bms;
         }
         else if (bms->getSurfaceType() == BrainModelSurface::SURFACE_TYPE_VERY_INFLATED) {
            veryInflatedSurface = bms;
         }
      }
   }
   if (fiducialSurface == NULL) {
      throw CommandException("Unable to find fiducial surface.");
   }
   if (veryInflatedSurface == NULL) {
      throw CommandException("Unable to find very inflated surface.");
   }
   
   //
   // Get the paint and shape column numbers
   //
   const int paintFileGeographyColumnNumber = 
      brainSet.getPaintFile()->getColumnFromNameOrNumber(paintFileGeographyColumnNameOrNumber, false);
   const int surfaceShapeFileDepthColumnNumber = 
      brainSet.getSurfaceShapeFile()->getColumnFromNameOrNumber(surfaceShapeFileDepthColumnNameOrNumber, false);
   //
   // Identify the sulci
   //
   BrainModelSurfaceSulcalIdentificationProbabilistic bmssi(&brainSet,
                                                  fiducialSurface,
                                                  inflatedSurface,
                                                  veryInflatedSurface,
                                                  brainSet.getPaintFile(),
                                                  paintFileGeographyColumnNumber,
                                                  brainSet.getSurfaceShapeFile(),
                                                  surfaceShapeFileDepthColumnNumber,
                                                  probabilisticSulcusVolumeListFileName,
                                                  postCentralSulcusOffset,
                                                  postCentralSulcusStdDevSquared,
                                                  postCentralSulcusSplit);
   try {
      bmssi.execute();
      if (bmssi.getOutputPaintFile() == NULL) {
         throw CommandException("output paint file with Identified sulci is NULL.");
      }
      try {
         PaintFile outputPaintFile(*bmssi.getOutputPaintFile());
         outputPaintFile.writeFile(outputPaintFileName);
      }
      catch (FileException& e) {
         const QString msg("identifying sulci writing output paint file: " 
                           + e.whatQString());
         throw CommandException(msg);
      }
      
      if (outputAreaColorFileName.isEmpty() == false) {
         const AreaColorFile* acf = bmssi.getOutputAreaColorFile(); 
         if (acf != NULL) {
            brainSet.getAreaColorFile()->append(*acf);
            try {
               brainSet.getAreaColorFile()->writeFile(outputAreaColorFileName);
            }
            catch (FileException&) {
               std::cout << "WARNING: Unable to write "
                         << outputAreaColorFileName.toAscii().constData()
                         << std::endl;
            }
         }
      }
   }
   catch (BrainModelAlgorithmException& e) {
      throw CommandException("identifying sulci: " 
                             + e.whatQString());
   }
}