~ubuntu-branches/ubuntu/trusty/mricron/trusty

« back to all changes in this revision

Viewing changes to html/bat.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Hanke
  • Date: 2010-07-29 22:07:43 UTC
  • Revision ID: james.westby@ubuntu.com-20100729220743-q621ts2zj806gu0n
Tags: upstream-0.20100725.1~dfsg.1
ImportĀ upstreamĀ versionĀ 0.20100725.1~dfsg.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 
5
  <meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
 
6
  <title>MRIcron Batch File Page</title>
 
7
</head>
 
8
<body bgcolor="#ffffff">
 
9
 
 
10
<table bgcolor="#000050" border="0" width="100%">
 
11
 <tbody>
 
12
    <tr>
 
13
 <td><a href="index.html"><img src="images/icon.png"  border="0"  height="86" width="128"></a></td>
 
14
 <td width="100%"><font color="#ffffff" size="5">MRIcron Advanced Settings</font></td>
 
15
    </tr>
 
16
 
 
17
  </tbody>
 
18
</table>
 
19
 
 
20
<p><b>Advanced Options</b></p>
 
21
 
 
22
<p><b>Command line options</b> &nbsp; Usage: mricron BackgroundImageFilename [options]</p>
 
23
 
 
24
<p>If you launch MRIcron from the command line you can (optionally)
 
25
include default parameters to specify desired settings. Nice examples
 
26
of these commands are the batch files that are created in the same
 
27
folder as the mricron.exe program (you need to include the 'Tutorials'
 
28
when you install mricron). For example, lets look at simple batch file:<br>
 
29
 &nbsp; <u>start /MAX mricron .\templates\ch2bet.nii.gz -c -0 -l 20 -h 140</u><br>
 
30
The terms 'start /MAX mricron' are standard parts of a Windows batch
 
31
file. This launches MRIcron and ensures that the main window is
 
32
maximized to fill the entire screen. You could run this from a batch
 
33
script (a text file with the name '.bat') or from the command line
 
34
(e.g. choose Start/Run and type 'cmd' to start the Windows command
 
35
line). Note that this script will only work from the folder where
 
36
MRIcron is stored. Otherwise, the script will need to specify the
 
37
location of the software:<br>
 
38
 &nbsp; <u>start /MAX c:\mricron\mricron c:\mricron\templates\ch2bet.nii.gz -c -0 -l 20 -h 140 x</u><br>
 
39
Note that after the program name the script specifies the background
 
40
image that is to be loaded, in this cas the image ch2bet.nii.gz. After
 
41
this, you can optinally specify additional settings. For example, the
 
42
"-c -0" sets the image to have a grayscale color scheme. While "-l 20
 
43
-h 140" sets the image brightness to be set for the range 20..140 (e.g.
 
44
voxels with values less than 20 will appear black, voxels greater than
 
45
140 will be white, and intermediate values will be linearly scaled for
 
46
this range). Finally, the 'X' command adjusts the adjusts the
 
47
proportions of the sagittal, coronal and axial panels so that each of
 
48
these views will be shown at a similar scale. <br>
 
49
 This next example shows how you can load an overlay on top of another image:<br>
 
50
 &nbsp; <u>start mricron .\templates\ch2.nii.gz -c -0 -l 20 -h 140 -o .\templates\ch2bet.nii.gz -c -1 10 -h 130</u><br>
 
51
Note how this script uses some parameters multiple times - the first
 
52
set of -c-l-h parameters refer to the background image (ch2), while the
 
53
second set refer to the overlay image (ch2bet). The parameters that can
 
54
be adjusted for each image are noted with an asterix in the table below
 
55
(-c, -l, -h, -z).</p>
 
56
 
 
57
<p>Here is a complete list of the parameters you can specify </p>
 
58
 
 
59
<table border="1" cellspacing="0">
 
60
 <tbody>
 
61
    <tr>
 
62
 <td width="180"><b>Parameter</b></td>
 
63
 <td width="100%"><b>Notes</b></td>
 
64
 <td>&nbsp;</td>
 
65
    </tr>
 
66
 <tr>
 
67
 <td>-b &lt;%&gt; </td>
 
68
 <td width="100%">Sets transparency of overlays on background.
 
69
Supported values are -1,0,20,40,50,60,80,100. A value of -1 signifies
 
70
additive color blending.</td>
 
71
 <td>&nbsp;</td>
 
72
    </tr>
 
73
 <tr>
 
74
 <td>-c &lt;LUT name&gt;</td>
 
75
 <td width="100%">Specify color lookup table. "-c bone" will load
 
76
bone.lut. You can also specify the index number of the LUT by using the
 
77
prefix "-". For example, "-c -1" will load the red color scheme, while
 
78
"-c -0" will load the grayscale color scheme.</td>
 
79
 <td>*</td>
 
80
    </tr>
 
81
 <tr>
 
82
 <td>-d</td>
 
83
 <td width="100%">Defaults will be saved when the user quits.</td>
 
84
 <td>&nbsp;</td>
 
85
    </tr>
 
86
 <tr>
 
87
      <td>-f</td>
 
88
      <td>Loads image 'flat': the NIfTI orientation matrix is ignored.
 
89
This is the same effect as editing the .ini file and setting 'Reslice=0'</td>
 
90
      <td></td>
 
91
    </tr>
 
92
    <tr>
 
93
 <td>-h</td>
 
94
 <td width="100%">Sets maximum value for image intensity scaling. For
 
95
example a Z-score statistical map loaded with "-l 1.96 -h 4" will show
 
96
values near 1.96 as maximal dark and values near 4 as maximal bright.
 
97
See also -l and -z</td>
 
98
 <td>*</td>
 
99
    </tr>
 
100
 <tr>
 
101
 <td>-l</td>
 
102
 <td width="100%">Sets minimum value for image intensity scaling. see -h</td>
 
103
 <td>*</td>
 
104
    </tr>
 
105
 <tr>
 
106
 <td>-m</td>
 
107
 <td width="100%">Will show a multi-slice view using default multislice settings.</td>
 
108
 <td>&nbsp;</td>
 
109
    </tr>
 
110
 <tr>
 
111
 <td>-m &lt;INI name&gt;</td>
 
112
 <td width="100%">Will show a multi-slice view using the settings for
 
113
the file &lt;INI name&gt;. For example "-m c:\mymulti.ini". Multislice
 
114
settings files can be created by selecting File/SaveSettings in the
 
115
multislice window.</td>
 
116
 <td>&nbsp;</td>
 
117
    </tr>
 
118
 <tr>
 
119
 <td>-o &lt;overlay name&gt;</td>
 
120
 <td width="100%">Will load overlay &lt;overlay name&gt;. For example "-o c:\statmap.hdr".</td>
 
121
 <td>&nbsp;</td>
 
122
    </tr>
 
123
 <tr>
 
124
 <td>-r</td>
 
125
 <td width="100%">Will show a rendering using default rendering settings.</td>
 
126
 <td>&nbsp;</td>
 
127
    </tr>
 
128
 <tr>
 
129
 <td>-r &lt;INI name&gt;</td>
 
130
 <td width="100%">Will show a rendering using the settings for the file
 
131
&lt;INI name&gt;. For example "-r c:\myrender.ini". Rendering settings
 
132
files can be created by selecting File/SaveSettings in the render
 
133
window.</td>
 
134
 <td>&nbsp;</td>
 
135
    </tr>
 
136
 <tr>
 
137
 <td>-s &lt;v&gt;</td>
 
138
 <td width="100%">Settings smoothing. &lt;v&gt; should be a value 0..3.
 
139
If &lt;v&gt; is odd (1 or 3) then bilinear smoothing is applied to
 
140
images (otherwise, nearest neighbor is used). If &lt;v&gt; is 2 or 3
 
141
then overlays will be scaled using trilinear interpolation (otherwise,
 
142
nearest neighbor is used).</td>
 
143
 <td>&nbsp;</td>
 
144
    </tr>
 
145
 <tr>
 
146
 <td>-t &lt;%&gt;</td>
 
147
 <td width="100%">Sets transparency of overlays with respect to other
 
148
overlays. Supported values are -1,0,20,40,50,60,80,100. A value of -1
 
149
signifies additive color blending.</td>
 
150
 <td>&nbsp;</td>
 
151
    </tr>
 
152
 <tr>
 
153
 <td>-v &lt;drawing name&gt;</td>
 
154
 <td>Will load volume of interest &lt;drawing name&gt;. For example "-o c:\lesion.voi".</td>
 
155
 <td>&nbsp;</td>
 
156
    </tr>
 
157
 <tr>
 
158
 <td>-x</td>
 
159
 <td>Main window will be maximized to fill entire screen. The size of
 
160
each view (sagittal, coronal and axial) will be proportionally scaled.</td>
 
161
 <td>&nbsp;</td>
 
162
    </tr>
 
163
 <tr>
 
164
 <td>-z</td>
 
165
 <td>Image color scaling will be from zero. For example a Z-score
 
166
statistical map loaded with "-l 1.96 -h 4 -z" will hide values below
 
167
1.96, but will show values near 1.96 as a medium intensity and values
 
168
near 4 as maximal bright. See also -h</td>
 
169
 <td>*</td>
 
170
    </tr>
 
171
 
 
172
  </tbody>
 
173
</table>
 
174
 
 
175
<p><b>Default Settings</b></p>
 
176
<p>You can adjust many of MRIcron's settings by choosing Help/Preferences. A window will appear that allows you to edit many of the values from your mricron.ini file. The window is shown below, and the mricron.ini settings are described in the table below.</p>
 
177
 
 
178
<p><img style="width: 356px; height: 337px;" alt="overlay panel" src="images/prefs.gif"></p>
 
179
 
 
180
 
 
181
<p>MRIcron remembers users preferences. Three standard .INI format text
 
182
files are automatically generated: mricron.ini, \render\default.ini,
 
183
and \multislice\default.ini. The file mricron.ini saves general
 
184
settings, while the other files store values specific to the rendering
 
185
and multislice views respectively. The user can save custom multislice
 
186
and rendering settings by opening up the render (or multislice view)
 
187
and creating their desired settings and then choosing
 
188
File\SaveSettings. Deleting the ini files will return the software to
 
189
its factory settings.</p>
 
190
 
 
191
<p>The mricron.ini file has a few values that can not be adjusted from
 
192
the program, but can be changed by editing the file with a text editor.
 
193
Here is a complete list of the parameters you can specify </p>
 
194
 
 
195
<table border="1" cellspacing="0">
 
196
 <tbody>
 
197
    <tr><td width="180"><b>Parameter</b></td><td width="100%"><b>Notes</b></td></tr>
 
198
    <tr><td>file0...file5=</td><td>Stores the five most recently viewed images. These will appear in the File/OpenRecent submenu.</td></tr>
 
199
    <tr><td>reslice=</td><td>If 1, image will be spatially oriented using the NIfTI transforms, similar to SPM5. If 0, images will be shown as saved to disk (like SPM2 and FSLview). Reslice=1 requires more memory, but hopefully avoids left-right confusions.</td></tr>
 
200
    <tr><td>ShowDraw=</td><td>If 1, the 'Draw' menu and drawing tools will be visible.</td></tr>
 
201
    <tr><td>Smooth=</td><td>If 1, resliced images will use the slow but relatively precise trilinear interpolation </td></tr>
 
202
    <tr><td>XBar=</td><td>If 1, cross-hairs will mark the currently selected voxel. </td></tr>
 
203
    <tr><td>OverlaySmooth=</td><td>If 1, overlays will be scaled to background image using smooth trilinear interpolation. If 0, overlays will use nearest neighbor (and the edges may appear jagged). </td></tr>
 
204
    <tr><td>LRMirror=</td><td>If 1, images with NIfTI orientation parameters will appear in radiological convention (with left on the right). If 0, images will be in neurological convention (with left on the left). </td></tr>
 
205
    <tr><td>Yoke=</td><td>If 1, images in multiple instances of MRIcron will show the same location - changing the selected voxel in one instance will cahange the view in other instances. </td></tr>
 
206
    <tr><td>MaxDim=</td><td>If an image is larger than this value in any dimension, the image will be rescaled so that this is the largest dimension. This minimizes memory consumption. For example, if this is set to 256 and you open an image with 512x512x300 voxels, it will be displayed as 256x256x150voxels. </td></tr>
 
207
    <tr><td>Zoom=</td><td>Default image scaling. Zero specifies that the image is strecthed to fit the window, 1 for best integer fit to window (e.g. if a 235% scaling is possible, the image will be scaled 200%), 2 for 100%, 3 for 200%, etc. </td></tr>
 
208
    <tr><td>LUT=</td><td>Selected color scheme. E.G. if 24, then the 24th color scheme is used. </td></tr>
 
209
    <tr><td>XBarGap=</td><td>Empty gap between crosshairs.  If 7, then 7 pixels separate crosshairs.</td></tr>
 
210
    <tr><td>XBarThick=</td><td>Width of crosshairs. </td></tr>
 
211
    <tr><td>XBarClr=</td><td>Color of crosshairs. This is a 24-bit value, with top 8 bytes representing blue, middle 8 representing blue and least significant 8 representing red. So a value of 255 would be a bright, pure red. </td></tr>
 
212
    <tr><td>VOIClr=</td><td>Color of volume of interest drawing. Same values as XBarClr. </td></tr>
 
213
    <tr><td>BGTransPct=</td><td>Transparency of overlays on background (in percent). 0 for opaque overlays, 50 for a translucent overlay (50% each) and 100 for a completely transparent overlay. -1 specificies additive combination. </td></tr>
 
214
    <tr><td>OverlayTransPct=</td><td>Transparency of overlays relative to each other. Same values as BGTransPct </td></tr>
 
215
    <tr><td>MaxThreads=</td><td>Maximum number of CPU cores used for rendering. If set to 5, only five cores will be used regardless of the number of CPUs. Higher numbers lead to faster rendering, but can slow other applications. For systems with more than two cores, a good value is the number of cores minus one. For example, with a quad-CPU machine, set this to 3. If you have fewer CPUs than MaxThreads, MRIcron will use all of your available CPUs (e.g. threads will equal the number of CPUs), offering optimal speed.</td></tr>   
 
216
     <tr><td>SigDigits=</td><td>Number of digits shown after decimal place. Influences the voxel intensity value shown in the bottom-left status label.  </td></tr>    
 
217
    <tr><td>TabletPressure=</td><td>Only used when using a Tablet device (e.g. Wacom tablet or a Tablet PC which pressure sensitive stylus). Threshold for transitioning between a thin (1 voxel) and thick (3 voxel) pen - if pen pressure is double this threshold, a five pixel line will be drawn.. Tablet stylus pressure will range from 0..100. If set to 100, the pen will always draw a thin line, regardless of pressure. If set to 30, light pressure (<30%) will create a thin line, medium pressure (30..60%) will lead to a 3-voxel line and heavy pressure (>60%) will causes a very thick line (5 pixels wide).</td></tr>    
 
218
<tr><td>TabletErasePressure=</td><td>Pressure threshold for stylus eraser on Tablet systems. Same comments as TabletPressure.</td></tr>    
 
219
 
 
220
<tr><td>LesionSmooth=</td><td>Smoothing Full Width Half Maximum (in mm) This is used by the Draw Menu's "Create SPM5 mask" function.</td></tr>    
 
221
  </tbody>
 
222
</table>
 
223
    <br>
 
224
 
 
225
<table style="text-align: left; background-color: rgb(0, 0, 80); width: 100%;" border="0" cellpadding="0" cellspacing="0">
 
226
  <tbody>
 
227
    <tr>
 
228
      <td><img style="width: 367px; height: 109px;" alt="logo" src="images/meld.jpg"></td>
 
229
    </tr>
 
230
  </tbody>
 
231
</table>
 
232
</body>
 
233
</html>