File: CommandVolumeSegmentationLigase.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 (246 lines) | stat: -rw-r--r-- 10,110 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
/*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 <iostream>

#include "CommandVolumeSegmentationLigase.h"
#include "FileFilters.h"
#include "ProgramParameters.h"
#include "ScriptBuilderParameters.h"
#include "BrainModelVolumeLigaseSegmentation.h"
#include "BrainSet.h"
#include "StringUtilities.h"

/**
 * constructor.
 */
CommandVolumeSegmentationLigase::CommandVolumeSegmentationLigase()
   : CommandBase("-volume-segment-ligase",
                 "VOLUME SEGMENTATION LIGASE")
{
}

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

/**
 * get the script builder parameters.
 */
void 
CommandVolumeSegmentationLigase::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{
   paramsOut.clear();
   paramsOut.addFile("Input anatomy volume file name", FileFilters::getVolumeAnatomyFileFilter());
   paramsOut.addFile("Output segmentation volume file name", FileFilters::getVolumeSegmentationFileFilter());
   paramsOut.addString("Output volume label");
   paramsOut.addInt("X index of seed", 128, 0);
   paramsOut.addInt("Y index of seed", 128, 0);
   paramsOut.addInt("Z index of seed", 128, 0);
   paramsOut.addFloat("White minimum", 140.0f);
   paramsOut.addFloat("White peak", 170.0f);
   paramsOut.addFloat("White maximum", 200.0f);
   paramsOut.addFloat("Difference cutoff base value", BrainModelVolumeLigaseSegmentation::defaultDiff());
   paramsOut.addFloat("Gradient cutoff base value", BrainModelVolumeLigaseSegmentation::defaultGrad());
   paramsOut.addFloat("Above peak probability minimum", BrainModelVolumeLigaseSegmentation::defaultHighBias());
   paramsOut.addFloat("Below peak probability minimum", BrainModelVolumeLigaseSegmentation::defaultLowBias());
}

/**
 * get full help information.
 */
QString 
CommandVolumeSegmentationLigase::getHelpInformation() const
{
   QString helpInfo =
      (indent3 + getShortDescription() + "\n"
       + indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + "  \n"
       + indent9 + "<input-anatomy-volume-file-name>\n"
       + indent9 + "<output-segmentation-volume-file-name>\n"
       + indent9 + "<output-volume-label>\n"
       + indent9 + "<x-seed>\n"
       + indent9 + "<y-seed>\n"
       + indent9 + "<z-seed>\n"
       + indent9 + "<white-min>\n"
       + indent9 + "<white-peak>\n"
       + indent9 + "<white-max>\n"
       + indent9 + "[diff-base = " + StringUtilities::fromNumber(BrainModelVolumeLigaseSegmentation::defaultDiff()) + "]\n"
       + indent9 + "[grad-base = " + StringUtilities::fromNumber(BrainModelVolumeLigaseSegmentation::defaultGrad()) + "]\n"
       + indent9 + "[high-bias = " + StringUtilities::fromNumber(BrainModelVolumeLigaseSegmentation::defaultHighBias()) + "]\n"
       + indent9 + "[low-bias = " + StringUtilities::fromNumber(BrainModelVolumeLigaseSegmentation::defaultLowBias()) + "]\n"
       + indent9 + "\n"
       + indent9 + "Use LIGASE to segment the white matter.\n"
       + indent9 + "\n"
       + indent9 + "      x-seed, y-seed, z-seed  specify the voxel for LIGASE to grow\n"
       + indent9 + "                               from, make sure it is in the white\n"
       + indent9 + "                               matter.\n"
       + indent9 + "\n"
       + indent9 + "      white-min  specifies the minimum intensity of the white matter in\n"
       + indent9 + "                  the anatomy volume. \n"
       + indent9 + " \n"
       + indent9 + "      white-peak  specifies the intensity of the white matter peak in\n"
       + indent9 + "                  the anatomy volume. \n"
       + indent9 + " \n"
       + indent9 + "      white-max  specifies the maximum intensity of the white matter in\n"
       + indent9 + "                  the anatomy volume. \n"
       + indent9 + "\n"
       + indent9 + "   Optional parameters: (default value specified above)\n"
       + indent9 + "      diff-base  specifies how much to rely on the difference from one\n"
       + indent9 + "                  voxel to the next when growing, higher numbers allow\n"
       + indent9 + "                  more growth. \n"
       + indent9 + "\n"
       + indent9 + "      grad-base  specifies how much to rely on the magnitude of the\n"
       + indent9 + "                  local 3D gradient when growing, higher numbers allow\n"
       + indent9 + "                  more growth.\n"
       + indent9 + "\n"
       + indent9 + "      high-bias  specifies how low a probability based on intensity\n"
       + indent9 + "                  is considered as no chance of being white matter\n"
       + indent9 + "                  when intensity is above peak, smaller numbers allow\n"
       + indent9 + "                  more growth.\n"
       + indent9 + "\n"
       + indent9 + "      low-bias  specifies how low a probability based on intensity\n"
       + indent9 + "                  is considered as no chance of being white matter\n"
       + indent9 + "                  when intensity is below peak, smaller numbers allow\n"
       + indent9 + "                  more growth.\n"
       + indent9 + "\n"
       + indent9 + "Note: This algorithm is generally conservative in estimating the\n"
       + indent9 + "       gray/white boundary, try dilating the output if changing\n"
       + indent9 + "       parameters doesn't give the desired results.\n"
       + indent9 + "\n");
      
   return helpInfo;
}

/**
 * execute the command.
 */
void 
CommandVolumeSegmentationLigase::executeCommand() throw (BrainModelAlgorithmException,
                                     CommandException,
                                     FileException,
                                     ProgramParametersException,
                                     StatisticException)
{
   const QString inputVolumeFileName =
      parameters->getNextParameterAsString("Input Anatomy Volume File Name");
   const QString outputVolumeFileName =
      parameters->getNextParameterAsString("Output Segmentation Volume File Name");
   const QString outputVolumeLabel =
      parameters->getNextParameterAsString("Output Segmentation Volume Label");
   const int xSeed =
      parameters->getNextParameterAsInt("Seed Point X Index");
   const int ySeed =
      parameters->getNextParameterAsInt("Seed Point Y Index");
   const int zSeed =
      parameters->getNextParameterAsInt("Seed Point Z Index");
   const float whiteMin =
      parameters->getNextParameterAsFloat("White Minimum");
   const float whitePeak =
      parameters->getNextParameterAsFloat("White Peak");
   const float whiteMax =
      parameters->getNextParameterAsFloat("White Maximum");
   float diffBase = BrainModelVolumeLigaseSegmentation::defaultDiff(),
         gradBase = BrainModelVolumeLigaseSegmentation::defaultGrad(),
         highBias = BrainModelVolumeLigaseSegmentation::defaultHighBias(),
         lowBias = BrainModelVolumeLigaseSegmentation::defaultLowBias();
   if (parameters->getParametersAvailable())
   {
      diffBase =
         parameters->getNextParameterAsFloat("Difference Cutoff Base (optional)");
   }
   if (parameters->getParametersAvailable())
   {
      gradBase =
         parameters->getNextParameterAsFloat("Gradient Cutoff Base (optional)");
   }
   if (parameters->getParametersAvailable())
   {
      highBias =
         parameters->getNextParameterAsFloat("High Probability Bias (optional)");
   }
   if (parameters->getParametersAvailable())
   {
      lowBias =
         parameters->getNextParameterAsFloat("Low Probability Bias (optional)");
   }
   checkForExcessiveParameters();
   
   //
   // Create a brain set
   //
   BrainSet brainSet;
   
   //
   // Read the volume file
   //
   VolumeFile inputVolume;
   inputVolume.readFile(inputVolumeFileName);
   
   //
   // Create output volume file
   //
   VolumeFile segVolume(inputVolume);
   segVolume.setVolumeType(VolumeFile::VOLUME_TYPE_SEGMENTATION);

   //
   // Create the Ligase object
   //
   BrainModelVolumeLigaseSegmentation ligaseObject(&brainSet,
                                                   &inputVolume,
                                                   &segVolume,
                                                   outputVolumeFileName,
                                                   outputVolumeLabel,
                                                   xSeed,
                                                   ySeed,
                                                   zSeed,
                                                   whiteMin,
                                                   whitePeak,
                                                   whiteMax,
                                                   diffBase,
                                                   gradBase,
                                                   highBias,
                                                   lowBias);
   
   //
   // Execute Ligase
   //
   ligaseObject.execute();
   
   //
   // Write the file
   //
   segVolume.writeFile(outputVolumeFileName);
   
   const QString warningMessages = ligaseObject.getWarningMessages();
   if (warningMessages.isEmpty() == false) {
      std::cout << "Segmentation Warnings: " << warningMessages.toAscii().constData() << std::endl;
   }
}