File: CommandMetricFileCreate.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 (178 lines) | stat: -rw-r--r-- 5,737 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
/*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 "CommandMetricFileCreate.h"
#include "FileFilters.h"
#include "MetricFile.h"
#include "ProgramParameters.h"
#include "ScriptBuilderParameters.h"

/**
 * constructor.
 */
CommandMetricFileCreate::CommandMetricFileCreate()
   : CommandBase("-metric-file-create",
                 "METRIC FILE CREATION")
{
}

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

/**
 * get the script builder parameters.
 */
void 
CommandMetricFileCreate::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{
   paramsOut.clear();
   paramsOut.addFile("Metric File Name", 
                     FileFilters::getMetricFileFilter());
   paramsOut.addInt("Number of Columns", 1);
   paramsOut.addVariableListOfParameters("Input Metric Files/Columns");
}

/**
 * get full help information.
 */
QString 
CommandMetricFileCreate::getHelpInformation() const
{
   QString helpInfo =
      (indent3 + getShortDescription() + "\n"
       + indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + "  \n"
       + indent9 + "<metric-file-name>  \n"
       + indent9 + "<number-of-columns> \n"
       + indent9 + "[-number-of-nodes  number-of-nodes] \n"
       + indent9 + "[-coordinate-file  coordinate-file-for-number-of-nodes] \n"
       + indent9 + "[-set-column-name  column-number  column-name]\n"
       + indent9 + "\n"
       + indent9 + "Create a metric file with the specified number of nodes\n"
       + indent9 + "and columns with all values initialized to zero.  \n"
       + indent9 + "\n"
       + indent9 + "The number of columns MUST be specified using either the\n"
       + indent9 + "\"-number-of-nodes\" option or the \"-coordinate-file\"\n"
       + indent9 + "in which case the number of nodes is set to the number\n"
       + indent9 + "of nodes in the coordinate file.\n"
       + indent9 + "\n"
       + indent9 + "When setting column names, the \"column-number\" starts at one.\n"
       + indent9 + "\n");
      
   return helpInfo;
}

/**
 * execute the command.
 */
void 
CommandMetricFileCreate::executeCommand() throw (BrainModelAlgorithmException,
                                     CommandException,
                                     FileException,
                                     ProgramParametersException,
                                     StatisticException)
{
   //
   // Get name, columns
   //
   const QString metricFileName =
      parameters->getNextParameterAsString("Metric File Name");
   const int numberOfColumns =
      parameters->getNextParameterAsInt("Number of Columns");
      
   if (numberOfColumns <= 0) {
      throw CommandException("Number of columns must be "
                             "greater than zero.");
   }
   int numberOfNodes = -1;
   
   //
   // Process optional parameters
   //
   std::vector<QString> metricColumnNames(numberOfColumns, "");
   while (parameters->getParametersAvailable()) {
      const QString paramName = parameters->getNextParameterAsString("Metric Create Parameter");
      if (paramName == "-number-of-nodes") {
         numberOfNodes = parameters->getNextParameterAsInt("Number of Nodes");
      }
      else if (paramName == "-coordinate-file") {
         const QString coordinateFileName =
            parameters->getNextParameterAsString("Coordinate File Name");
         CoordinateFile coordinateFile;
         coordinateFile.readFile(coordinateFileName);
         numberOfNodes = coordinateFile.getNumberOfCoordinates();
      }
      else if (paramName == "-set-column-name") {
         int metricColumnNumber = parameters->getNextParameterAsInt("Column Number");
         if ((metricColumnNumber < 1) ||
             (metricColumnNumber > numberOfColumns)) {
            throw CommandException("Invalid metric column number"
                                   + QString::number(metricColumnNumber));
         }
         metricColumnNumber--; // index starting at zero
         
         metricColumnNames[metricColumnNumber] = parameters->getNextParameterAsString("Column Name");
      }
      else {
         throw CommandException("Unrecognized parameter: "
                                + paramName);
      }
   }
   
   //
   // Error check
   //
   if (numberOfNodes <= 0) {
      throw CommandException("Number of nodes must be "
                             "greater than zero.");
   }
   
   //
   // Create the file
   //
   MetricFile metricFile;
   metricFile.setNumberOfNodesAndColumns(numberOfNodes, numberOfColumns);

   for (int i = 0; i < numberOfColumns; i++) {
      if (metricColumnNames[i].isEmpty() == false) {
         //
         // Set the column name
         //
         metricFile.setColumnName(i,
                                 metricColumnNames[i]);
      }
   }
   
   //
   // Write the file
   //
   metricFile.writeFile(metricFileName);
}