File: CommandVolumeScalePercent0to255.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 (132 lines) | stat: -rw-r--r-- 4,455 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
/*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 "CommandVolumeScalePercent0to255.h"
#include "FileFilters.h"
#include "ProgramParameters.h"
#include "ScriptBuilderParameters.h"
#include "VolumeFile.h"

/**
 * constructor.
 */
CommandVolumeScalePercent0to255::CommandVolumeScalePercent0to255()
   : CommandBase("-volume-scale-percent-min-max-255",
                 "VOLUME SCALE VOXELS 0 to 255 WITH PERCENTAGE OF MIN/MAX")
{
}

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

/**
 * get the script builder parameters.
 */
void 
CommandVolumeScalePercent0to255::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{
   paramsOut.clear();
   paramsOut.addFile("Input Volume File Name", FileFilters::getVolumeGenericFileFilter());
   paramsOut.addFile("Output Volume File Name", FileFilters::getVolumeGenericFileFilter());
   paramsOut.addFloat("Percent Minimum", 2.0);
   paramsOut.addFloat("Percent Maximum", 2.0);
}

/**
 * get full help information.
 */
QString 
CommandVolumeScalePercent0to255::getHelpInformation() const
{
   QString helpInfo =
      (indent3 + getShortDescription() + "\n"
       + indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + "  \n"
       + indent9 + "<input-volume-file-name>\n"
       + indent9 + "<output-volume-file-name>\n"
       + indent9 + "<percent-minimum> \n"
       + indent9 + "<percent-maximum> \n"
       + indent9 + "\n"
       + indent9 + "Scale voxels.\n"
       + indent9 + "\n"
       + indent9 + "Scale voxels so that they are in the range 0 to 255 but\n"
       + indent9 + "map the first \"percent-minimum\" voxels to 0 and map the\n"
       + indent9 + "last \"percent-maximum\" voxels to 255.\n"
       + indent9 + "\n"
       + indent9 + "The \"percent-minimum\" and \"percent-maximum\" values should\n"
       + indent9 + "range from 0.0 to 100.0.  Setting the \"percent-minimum\" to\n"
       + indent9 + "2.0 and the \"percent-maximum\" to 3.0 will result in the first\n"
       + indent9 + "two percent of voxel values being mapped to zero and the last\n"
       + indent9 + "three percent of voxel values being mapped to two hundred\n"
       + indent9 + "fifty five.\n"
       + indent9 + "\n");
      
   return helpInfo;
}

/**
 * execute the command.
 */
void 
CommandVolumeScalePercent0to255::executeCommand() throw (BrainModelAlgorithmException,
                                     CommandException,
                                     FileException,
                                     ProgramParametersException,
                                     StatisticException)
{
   const QString inputVolumeFileName =
      parameters->getNextParameterAsString("Input Volume File Name");
   QString outputVolumeFileName, outputVolumeFileLabel;
   parameters->getNextParameterAsVolumeFileNameAndLabel("Output Volume File Name/Label",
                                                        outputVolumeFileName, 
                                                        outputVolumeFileLabel);
   const float percentMinimum =
      parameters->getNextParameterAsFloat("Percent Minimum");
   const float percentMaximum =
      parameters->getNextParameterAsFloat("Percent Maximum");
   checkForExcessiveParameters();

   //
   // Read the input file
   //
   VolumeFile volume;
   volume.readFile(inputVolumeFileName);
   
   //
   // rescale
   //
   volume.stretchVoxelValuesExcludePercentage(percentMinimum, percentMaximum);
      
   //
   // Write the volume
   //
   writeVolumeFile(volume, outputVolumeFileName, outputVolumeFileLabel);
}