File: CommandMetricSmoothing.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 (260 lines) | stat: -rw-r--r-- 9,899 bytes parent folder | download
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
/*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 "BrainModelSurfaceMetricSmoothing.h"
#include "BrainSet.h"
#include "CommandMetricSmoothing.h"
#include "FileFilters.h"
#include "MetricFile.h"
#include "ProgramParameters.h"
#include "ScriptBuilderParameters.h"

/**
 * constructor.
 */
CommandMetricSmoothing::CommandMetricSmoothing()
   : CommandBase("-metric-smoothing",
                 "METRIC SMOOTHING")
{
}

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

/**
 * get the script builder parameters.
 */
void 
CommandMetricSmoothing::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{
   std::vector<QString> values, descriptions;
   values.push_back("AN");      descriptions.push_back("Average Neighbors");
   values.push_back("DILATE");  descriptions.push_back("Dilation");
   values.push_back("FWHM");   descriptions.push_back("Full Width Half Maximum");
   values.push_back("GAUSS");   descriptions.push_back("Gaussian");
   values.push_back("WAN");     descriptions.push_back("Weighted Average Neighbors");

   paramsOut.clear();
   paramsOut.clear();
   paramsOut.addFile("Coordinate File Name", FileFilters::getCoordinateGenericFileFilter());
   paramsOut.addFile("Topology File Name", FileFilters::getTopologyGenericFileFilter());
   paramsOut.addFile("Input Metric File Name", FileFilters::getMetricFileFilter());
   paramsOut.addFile("Output Metric File Name", FileFilters::getMetricFileFilter());
   paramsOut.addListOfItems("Smoothing Algorithm", values, descriptions);
   paramsOut.addInt("Smoothing Number of Iterations", 50, 1, 100000);
   paramsOut.addFloat("Smoothing Strength", 1.0, 0.0, 1.0);
   paramsOut.addVariableListOfParameters("Gaussian Options");
}

/**
 * get full help information.
 */
QString 
CommandMetricSmoothing::getHelpInformation() const
{
   QString helpInfo =
      (indent3 + getShortDescription() + "\n"
       + indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + "  \n"
       + indent9 + "<coordinate-file-name>\n"
       + indent9 + "<topology-file-name>\n"
       + indent9 + "<input-metric-file-name>\n"
       + indent9 + "<output-metric-file-name>\n"
       + indent9 + "<smoothing-algorithm>\n"
       + indent9 + "<smoothing-number-of-iterations>\n"
       + indent9 + "<smoothing-strength>\n"
       + indent9 + " \n"
       + indent9 + "[-fwhm  desired-full-width-half-maximum] \n"
       + indent9 + " \n"
       + indent9 + "[-gauss   spherical-coordinate-file-name\n"
       + indent9 + "          sigma-norm\n"
       + indent9 + "          sigma-tang\n"
       + indent9 + "          norm below cutoff (mm)\n"
       + indent9 + "          norm above cutoff (mm)\n"
       + indent9 + "          tang-cutoff (mm)]\n"
       + indent9 + "\n"
       + indent9 + "Smooth metric data.\n"
       + indent9 + "\n"
       + indent9 + "\"smoothing-algorithm\" is one of:\n"
       + indent9 + "   AN      Average Neighbors\n"
       + indent9 + "   DILATE  Dilation\n"
       + indent9 + "   FWHM    Full-Width Half-Maximum\n"
       + indent9 + "   GAUSS   Gaussian\n"
       + indent9 + "   WAN     Weighted Average Neighbors\n"
       + indent9 + "\n");
      
   return helpInfo;
}

/**
 * execute the command.
 */
void 
CommandMetricSmoothing::executeCommand() throw (BrainModelAlgorithmException,
                                     CommandException,
                                     FileException,
                                     ProgramParametersException,
                                     StatisticException)
{
   const QString coordinateFileName =
      parameters->getNextParameterAsString("Coordinate File Name");
   const QString topologyFileName =
      parameters->getNextParameterAsString("Topology File Name");
   const QString inputMetricFileName =
      parameters->getNextParameterAsString("Input Metric File Name");
   const QString outputMetricFileName =
      parameters->getNextParameterAsString("Output Metric File Name");
   const QString algorithmName =
      parameters->getNextParameterAsString("Smoothing Algorithm");
   const int smoothingNumberOfIterations =
      parameters->getNextParameterAsInt("Smoothing Number of Iterations");
   const float smoothingStrength =
      parameters->getNextParameterAsFloat("Smoothing Strength");

   float desiredFullWidthHalfMaximum = 0.0;
   QString gaussianSphericalSurfaceName;
   float gaussSigmaNorm  = 1.0;
   float gaussSigmaTang  = 1.0;
   float gaussNormBelow  = 1.0;
   float gaussNormAbove  = 1.0;
   float gaussTangCutoff = 1.0;
   while (parameters->getParametersAvailable()) {
      const QString paramValue = parameters->getNextParameterAsString("Gaussian Parameter");
      if (paramValue == "-fwhm") {
         desiredFullWidthHalfMaximum = 
            parameters->getNextParameterAsFloat("Desired Full Width Half Maximum");
      }
      else if (paramValue == "-g") { 
         gaussianSphericalSurfaceName = 
            parameters->getNextParameterAsString("Guassian Spherical Surface");
         gaussSigmaNorm = 
            parameters->getNextParameterAsFloat("Gaussian Sigma Norm");
         gaussSigmaTang = 
            parameters->getNextParameterAsFloat("Gaussian Sigma Tangent");
         gaussNormBelow = 
            parameters->getNextParameterAsFloat("Gaussina Norm Below Cutoff");
         gaussNormAbove = 
            parameters->getNextParameterAsFloat("Gaussian Norm Above Cutoff");
         gaussTangCutoff = 
            parameters->getNextParameterAsFloat("Gaussian Tangent Cutoff");
      }
      else {
         throw CommandException("Unrecognized parameter: " + paramValue);
      }
   }
   
   //
   // Get algorithm
   //
   BrainModelSurfaceMetricSmoothing::SMOOTH_ALGORITHM smoothingAlgorithm;
   if (algorithmName == "AN") {
      smoothingAlgorithm = BrainModelSurfaceMetricSmoothing::SMOOTH_ALGORITHM_AVERAGE_NEIGHBORS;
   }
   else if (algorithmName == "DILATE") {
      smoothingAlgorithm = BrainModelSurfaceMetricSmoothing::SMOOTH_ALGORITHM_DILATE;
   }
   else if (algorithmName == "FWHM") {
      smoothingAlgorithm = BrainModelSurfaceMetricSmoothing::SMOOTH_ALGORITHM_FULL_WIDTH_HALF_MAXIMUM;
   }
   else if (algorithmName == "GAUSS") {
      smoothingAlgorithm = BrainModelSurfaceMetricSmoothing::SMOOTH_ALGORITHM_SURFACE_NORMAL_GAUSSIAN;
   }
   else if (algorithmName == "WAN") {
      smoothingAlgorithm = BrainModelSurfaceMetricSmoothing::SMOOTH_ALGORITHM_WEIGHTED_AVERAGE_NEIGHBORS;
   }
   else {
      throw CommandException("Invalid algorithm: \""
                             + algorithmName
                             + "\"");
   }
   
   //
   // Create a brain set
   //
   BrainSet brainSet(topologyFileName,
                     coordinateFileName,
                     gaussianSphericalSurfaceName,
                     true);
   BrainModelSurface* surface = brainSet.getBrainModelSurface(0);
   if (surface == NULL) {
      throw CommandException("unable to find surface.");
   }
   const TopologyFile* tf = surface->getTopologyFile();
   if (tf == NULL) {
      throw CommandException("unable to find topology.");
   }
   BrainModelSurface* gaussianSphericalSurface = NULL;
   if (gaussianSphericalSurfaceName.isEmpty() == false) {
      gaussianSphericalSurface = brainSet.getBrainModelSurface(1);
      if (gaussianSphericalSurface == NULL) {
         throw CommandException("unable to find spherical surface.");
      }
   }
   const int numNodes = surface->getNumberOfNodes();
   if (numNodes == 0) {
      throw CommandException("surface contains no nodes.");
   }
   
   //
   // Read input metric file
   //
   MetricFile metricFile;
   metricFile.readFile(inputMetricFileName);

   //
   // Perform smoothing
   //
   const int numberOfColumns = metricFile.getNumberOfColumns();
   for (int i = 0; i < numberOfColumns; i++) {
      BrainModelSurfaceMetricSmoothing smoothing(&brainSet,
                                                   surface,
                                                   gaussianSphericalSurface,
                                                   &metricFile,
                                                   smoothingAlgorithm,
                                                   i,
                                                   i,
                                                   metricFile.getColumnName(i),
                                                   smoothingStrength,
                                                   smoothingNumberOfIterations,
                                                   desiredFullWidthHalfMaximum,
                                                   gaussNormBelow,
                                                   gaussNormAbove,
                                                   gaussSigmaNorm,
                                                   gaussSigmaTang,
                                                   gaussTangCutoff);
      smoothing.execute();
   }
   
   //
   // Write the metric file
   //
   metricFile.writeFile(outputMetricFileName);
}