Boulder Laboratory for 3-Dimensional Electron Microscopy of Cells

BINVOL(1)							 BINVOL(1)

NAME
	binvol - Bin a 3D volume down isotropically or anisotropically

SYNOPSIS
	binvol [-b #] input_file output_file

DESCRIPTION

  Binvol will bin down a volume in all three dimensions, with the binning
  done isotropically or by different amounts in X, Y, and Z.  Binning means
  summing (actually averaging) all of the values in a block of voxels (e.g.,
  2x2x2 or 1x1x3) in the input volume to create one voxel in the output
  volume.  The output file will have appropriately larger pixel spacings in
  its header.

  Binvol uses the PIP package for input (see the manual page for pip).
  The following options can be specified either as command line arguments
  (with the -) or one per line in a command file (without the -):

 -input OR -InputFile   File name
    Input image file to bin down in 3D

 -output OR -OutputFile   File name
    Output file for binned volume

 -binning OR -BinningFactor   Integer
    Overall reduction factor to bin by (default 2)

 -xbinning OR -XBinningFactor   Integer
    Factor to bin by in X (default same as overall factor)

 -ybinning OR -YBinningFactor   Integer
    Factor to bin by in Y (default same as overall factor)

 -zbinning OR -ZBinningFactor   Integer
    Factor to bin by in Z (default same as overall factor)

 -test OR -TestLimit   Integer
    To test the code for reading in and binning in chunks, enter a limit for
    the total size of the working array.

 -help OR -usage
    Print help output

  -StandardInput
     Read parameter entries from standard input.

HISTORY
  Written by David Mastronarde
  Converted to PIP input and added to package, 10/28/04