~ubuntu-branches/ubuntu/raring/voxbo/raring

« back to all changes in this revision

Viewing changes to munge/vbimagemunge.hlp

  • Committer: Bazaar Package Importer
  • Author(s): Michael Hanke
  • Date: 2010-06-06 11:33:11 UTC
  • Revision ID: james.westby@ubuntu.com-20100606113311-v3c13imdkkd5n7ae
Tags: upstream-1.8.5~svn1172
ImportĀ upstreamĀ versionĀ 1.8.5~svn1172

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
VoxBo vbimagemunge (v%1%)
 
2
summary: image munging for VoxBo
 
3
usage:
 
4
  vbimagemunge [<file> ...] <flags> -- <op> [<op> ...]
 
5
flags:
 
6
  -h             show help
 
7
  -v             show version
 
8
image processing operations:
 
9
  smoothvox <x> <y> <z>  3D Gaussian smooth
 
10
  smoothmm <x> <y> <z>   3D Gaussian smooth
 
11
  thresh <val>           zero where <= val
 
12
  threshabs <val>        zero where absolute value <= val
 
13
  cutoff <val>           zero where >= val
 
14
  quantize <val>         set non-zero values to val
 
15
  invert                 zet non-zeros to zero, zeros to 1
 
16
  combine ...            see below
 
17
  convert <new type>     see below
 
18
  add <img/num>          add image (if file exists) or scalar
 
19
  sub <img/num>          subtract image (if file exists) or scalar
 
20
  mult <img/num>         multiply by image (if file exists) or scalar
 
21
  div <img/num>          divide by image (if file exists) or scalar
 
22
  nminus <img/num>       subtract from img (if file exists) or scalar
 
23
  random01               fill entire volume with random 0s and 1s
 
24
  remap <file>           file has two values per line: old value and new value
 
25
  flipx/flipy/flipz      
 
26
  bigendian/littleendian change how the data will be written out
 
27
  byteswap               
 
28
  zeroleft/zeroright     
 
29
  rotate <pitch> <roll> <yaw>
 
30
  regionat <x> <y> <z>   find region including voxel at coordinates x,y,z
 
31
  splitregions <fname>   output filename (XXX will be replaced by an index)
 
32
# NOT YET IMPLEMENTED:
 
33
# orient <from> <to>     RPI notation, use -- as from for current orientation
 
34
# ndividedby <num>
 
35
# removesmallregions <n>  // uses function zerosmallregions(cube,double)
 
36
combining operations:
 
37
  sum               sum all volumes
 
38
  average           average all volumes
 
39
  product           product of all volumes
 
40
  multi             combine input masks into a multi-mask
 
41
  union             combine input masks by calculating the union
 
42
  intersect         combine input masks by calculating the intersection
 
43
  count             combine input masks by counting non-zero voxels
 
44
  overlapmask       create a color-coded overlap mask of up to 3 masks
 
45
  select <n>        randomly select n volumes
 
46
  include <range>   include volumes in range, e.g., 0-5,7,9-13 (no spaces)
 
47
  exclude <range>   exclude volumes in range, e.g., 0-5,7,9-13 (no spaces)
 
48
output/summary operations:
 
49
  write <name>            write to single output filename
 
50
  writeprefixed <prefix>  prefix each volume's original name and write
 
51
  write4d <name>          combine the volumes into a 4d file
 
52
  info                    print general info about each 3D volume
 
53
  regioninfo              print region info    // vbregion has great methods
 
54
notes:
 
55
  vbimagemunge replaces vbmaskmunge, for the most part.
 
56
 
 
57
  vbimagemunge takes multiple 3D volumes as input, and applies the
 
58
  specified image processing operations, in the order specified.  If a
 
59
  4D input volume is specified, it is broken down into 3D volumes.
 
60
  
 
61
  vbimagemunge has three kinds of operations.  Image processing
 
62
  operations are applied to each 3D volume independently.  Combining
 
63
  operations apply to the whole set of 3D volumes and typically reduce
 
64
  the set to a single volume.  Output/summary operations print out
 
65
  information about the volumes as they exist at that point and/or
 
66
  write out files.  The operations are applied in the order given.
 
67
 
 
68
  For convert, valid new types are: byte, int16, int32, float, and
 
69
  double.  Note that VoxBo historically has used more ambiguous names
 
70
  for int16 and int32.
 
71
 
 
72
  The combine operation implements several methods for re-calculating
 
73
  each voxel's value as a combination of surrounding voxels.  It takes
 
74
  six arguments.  The first argment is either "fixed" or "moving" (can
 
75
  be abbreviated with f/m).  Fixed means that the brain is divided
 
76
  into fixed subregions, and each voxel in a given subregion gets the
 
77
  same value.  Moving means that each voxel gets a value calculated
 
78
  from a region centered at that voxel.  The next three arguments are
 
79
  the size of the region in x, y, and z.  The following argument is
 
80
  the combination method.  The following methods are supported: sum,
 
81
  count (count nonzero), average, pct (percent nonzero), any (1 if any
 
82
  voxel in the region is nonzero), sumthresh (1 if the sum exceeds a
 
83
  threshold), and averagethresh.  The final argument is the threshold
 
84
  for sumthresh and averagethresh (ignored for the other methods, but
 
85
  you must still supply a value.  Note that the output is stored in
 
86
  the same format as the input, so you may want to convert to a
 
87
  different datatype before performing some operations (e.g., many
 
88
  masks are stored as byte data, which can only represent integers in
 
89
  the 0-255 range).