.TH mia\-3dimagefilterstack 1 "17 October 2014" "2.0.10" "USER COMMANDS" .SH NAME mia\-3dimagefilterstack \- Filter a series of 3D images. .SH SYNOPSIS .B mia\-3dimagefilterstack \-i \-o \-t [options] .SH DESCRIPTION .B mia\-3dimagefilterstack This program is used to filter and convert a consecutive numbered series gray of scale images. File names must follow the pattern 'dataXXXX.v' (X being digits), i.e. the numbering comes right before the dot. .SH OPTIONS .RS .IP "\-i \-\-in-file=(input,required)" input image(s) to be filtered For supported file types see PLUGINS:3dimage/io .IP "\-o \-\-out-file=(required)" output file name base, numbers are added accorfing to the input file pattern, and the file extension is added according to the 'type' option. For supported file types see PLUGINS:3dimage/io .IP "\-t \-\-type=(required)" output file type .IP " \-\-help-plugins" give some help about the filter plugins .RE .SS Help & Info .RS .IP "\-V \-\-verbose=warning" verbosity of output, print messages of given level and higher priorities. Supported priorities starting at lowest level are: .RS 10 .I info \(hy Low level messages .RE .RS 10 .I trace \(hy Function call trace .RE .RS 10 .I fail \(hy Report test failures .RE .RS 10 .I warning \(hy Warnings .RE .RS 10 .I error \(hy Report errors .RE .RS 10 .I debug \(hy Debug output .RE .RS 10 .I message \(hy Normal messages .RE .RS 10 .I fatal \(hy Report only fatal errors .RE .IP " \-\-copyright" print copyright information .IP "\-h \-\-help" print this help .IP "\-? \-\-usage" print a short help .IP " \-\-version" print the version number and exit .RE .SS Processing .RS .IP " \-\-threads=\-1" Maxiumum number of threads to use for processing,This number should be lower or equal to the number of logical processor cores in the machine. (\-1: automatic estimation). .RE .SH PLUGINS: 1d/spacialkernel .TP 10 .B gauss spacial Gauss filter kernel, supported parameters are: .P .RS 14 .I w = 1 (int) .RS 2 half filter width. in [0, 2147483647] .RE .RE .SH PLUGINS: 1d/splinebc .TP 10 .B mirror Spline interpolation boundary conditions that mirror on the boundary .P .RS 14 (no parameters) .RE .TP 10 .B repeat Spline interpolation boundary conditions that repeats the value at the boundary .P .RS 14 (no parameters) .RE .TP 10 .B zero Spline interpolation boundary conditions that assumes zero for values outside .P .RS 14 (no parameters) .RE .SH PLUGINS: 1d/splinekernel .TP 10 .B bspline B-spline kernel creation , supported parameters are: .P .RS 14 .I d = 3 (int) .RS 2 Spline degree. in [0, 5] .RE .RE .TP 10 .B omoms OMoms-spline kernel creation, supported parameters are: .P .RS 14 .I d = 3 (int) .RS 2 Spline degree. in [3, 3] .RE .RE .SH PLUGINS: 3dimage/combiner .TP 10 .B absdiff Image combiner 'absdiff' .P .RS 14 (no parameters) .RE .TP 10 .B add Image combiner 'add' .P .RS 14 (no parameters) .RE .TP 10 .B div Image combiner 'div' .P .RS 14 (no parameters) .RE .TP 10 .B mul Image combiner 'mul' .P .RS 14 (no parameters) .RE .TP 10 .B sub Image combiner 'sub' .P .RS 14 (no parameters) .RE .SH PLUGINS: 3dimage/filter .TP 10 .B bandpass intensity bandpass filter, supported parameters are: .P .RS 14 .I max = 3.40282e+38 (float) .RS 2 maximum of the band. in [\-3.40282e+38, 3.40282e+38] .RE .RE .RS 14 .I min = 0 (float) .RS 2 minimum of the band. in [\-3.40282e+38, 3.40282e+38] .RE .RE .TP 10 .B binarize image binarize filter, supported parameters are: .P .RS 14 .I max = 3.40282e+38 (float) .RS 2 maximum of accepted range. in [0, 3.40282e+38] .RE .RE .RS 14 .I min = 0 (float) .RS 2 minimum of accepted range. in [0, 3.40282e+38] .RE .RE .TP 10 .B close morphological close, supported parameters are: .P .RS 14 .I hint = black (string) .RS 2 a hint at the main image content (black|white). .RE .RE .RS 14 .I shape = [sphere:r=2] (factory) .RS 2 structuring element. For supported plug-ins see PLUGINS:3dimage/shape .RE .RE .TP 10 .B combiner Combine two images with the given combiner operator. if 'reverse' is set to false, the first operator is the image passed through the filter pipeline, and the second image is loaded from the file given with the 'image' parameter the moment the filter is run., supported parameters are: .P .RS 14 .I image =(input,required, io) .RS 2 second image that is needed in the combiner. For supported file types see PLUGINS:3dimage/io .RE .RE .RS 14 .I op = (required, factory) .RS 2 Image combiner to be applied to the images. For supported plug-ins see PLUGINS:3dimage/combiner .RE .RE .RS 14 .I reverse = 0 (bool) .RS 2 reverse the order in which the images passed to the combiner. .RE .RE .TP 10 .B convert image pixel format conversion filter, supported parameters are: .P .RS 14 .I a = 1 (float) .RS 2 linear conversion parameter a. in [\-3.40282e+38, 3.40282e+38] .RE .RE .RS 14 .I b = 0 (float) .RS 2 linear conversion parameter b. in [\-3.40282e+38, 3.40282e+38] .RE .RE .RS 14 .I map = opt (dict) .RS 2 conversion mapping. Supported values are: .RS 4 .I opt \(hy apply a linear transformation that maps the real input range to the full output range .RE .RS 4 .I range \(hy apply linear transformation that maps the input data type range to the output data type range .RE .RS 4 .I copy \(hy copy data when converting .RE .RS 4 .I linear \(hy apply linear transformation x -> a*x+b .RE .RS 4 .I optstat \(hy apply a linear transform that maps based on input mean and variation to the full output range .RE .RE .RE .RS 14 .I repn = ubyte (dict) .RS 2 output pixel type. Supported values are: .RS 4 .I float \(hy floating point 32 bit .RE .RS 4 .I sbyte \(hy signed 8 bit .RE .RS 4 .I ulong \(hy unsigned 64 bit .RE .RS 4 .I double \(hy floating point 64 bit .RE .RS 4 .I sint \(hy signed 32 bit .RE .RS 4 .I ushort \(hy unsigned 16 bit .RE .RS 4 .I sshort \(hy signed 16 bit .RE .RS 4 .I uint \(hy unsigned 32 bit .RE .RS 4 .I slong \(hy signed 64 bit .RE .RS 4 .I bit \(hy binary data .RE .RS 4 .I ubyte \(hy unsigned 8 bit .RE .RE .RE .TP 10 .B crop Crop a region of an image, the region is always clamped to the original image size in the sense that the given range is kept., supported parameters are: .P .RS 14 .I end = [[4294967295,4294967295,4294967295]] (streamable) .RS 2 end of cropping range, maximum = (\-1,\-1,\-1). .RE .RE .RS 14 .I start = [[0,0,0]] (streamable) .RS 2 begin of cropping range. .RE .RE .TP 10 .B dilate 3d image stack dilate filter, supported parameters are: .P .RS 14 .I hint = black (string) .RS 2 a hint at the main image content (black|white). .RE .RE .RS 14 .I shape = [sphere:r=2] (factory) .RS 2 structuring element. For supported plug-ins see PLUGINS:3dimage/shape .RE .RE .TP 10 .B distance Evaluate the 3D distance transform of an image. If the image is a binary mask, then result of the distance transform in each point corresponds to the Euclidian distance to the mask. If the input image is of a scalar pixel value, then the this scalar is interpreted as heighfield and the per pixel value adds to the distance. .P .RS 14 (no parameters) .RE .TP 10 .B downscale Downscale the input image by using a given block size to define the downscale factor. Prior to scaling the image is filtered by a smoothing filter to eliminate high frequency data and avoid aliasing artifacts., supported parameters are: .P .RS 14 .I b = [[1,1,1]] (3dbounds) .RS 2 blocksize. .RE .RE .RS 14 .I bx = 1 (uint) .RS 2 blocksize in x direction. in [1, 2147483647] .RE .RE .RS 14 .I by = 1 (uint) .RS 2 blocksize in y direction. in [1, 2147483647] .RE .RE .RS 14 .I bz = 1 (uint) .RS 2 blocksize in z direction. in [1, 2147483647] .RE .RE .RS 14 .I kernel = gauss (factory) .RS 2 smoothing filter kernel to be applied, the size of the filter is estimated based on the blocksize.. For supported plug-ins see PLUGINS:1d/spacialkernel .RE .RE .TP 10 .B erode 3d image stack erode filter, supported parameters are: .P .RS 14 .I hint = black (string) .RS 2 a hint at the main image content (black|white). .RE .RE .RS 14 .I shape = [sphere:r=2] (factory) .RS 2 structuring element. For supported plug-ins see PLUGINS:3dimage/shape .RE .RE .TP 10 .B gauss isotropic 3D gauss filter, supported parameters are: .P .RS 14 .I w = 1 (int) .RS 2 filter width parameter. in [0, 2147483647] .RE .RE .TP 10 .B gradnorm 3D image to gradient norm filter .P .RS 14 (no parameters) .RE .TP 10 .B growmask Use an input binary mask and a reference gray scale image to do region growing by adding the neighborhood pixels of an already added pixel if the have a lower intensity that is above the given threshold., supported parameters are: .P .RS 14 .I min = 1 (float) .RS 2 lower threshold for mask growing. in [\-3.40282e+38, 3.40282e+38] .RE .RE .RS 14 .I ref =(input,required, io) .RS 2 reference image for mask region growing. For supported file types see PLUGINS:3dimage/io .RE .RE .RS 14 .I shape = 6n (factory) .RS 2 neighborhood mask. For supported plug-ins see PLUGINS:3dimage/shape .RE .RE .TP 10 .B invert intensity invert filter .P .RS 14 (no parameters) .RE .TP 10 .B isovoxel This filter scales an image to make the voxel size isometric and its size to correspond to the given value, supported parameters are: .P .RS 14 .I interp = [bspline:d=3] (factory) .RS 2 interpolation kernel to be used . For supported plug-ins see PLUGINS:1d/splinekernel .RE .RE .RS 14 .I size = 1 (float) .RS 2 isometric target voxel size. in [0.001, 1e+06] .RE .RE .TP 10 .B kmeans 3D image k-means filter. In the output image the pixel value represents the class membership and the class centers are stored as attribute in the image., supported parameters are: .P .RS 14 .I c = 3 (int) .RS 2 number of classes. in [0, 255] .RE .RE .TP 10 .B label A filter to label the connected components of a binary image., supported parameters are: .P .RS 14 .I n = 6n (factory) .RS 2 neighborhood mask. For supported plug-ins see PLUGINS:3dimage/shape .RE .RE .TP 10 .B load Load the input image from a file and use it to replace the current image in the pipeline., supported parameters are: .P .RS 14 .I file =(input,required, io) .RS 2 name of the input file to load from.. For supported file types see PLUGINS:3dimage/io .RE .RE .TP 10 .B lvdownscale This is a label voting downscale filter. It adownscales a 3D image by blocks. For each block the (non-zero) label that appears most times in the block is issued as output pixel in the target image. If two labels appear the same number of times, the one with the lower absolute value wins., supported parameters are: .P .RS 14 .I b = [[1,1,1]] (3dbounds) .RS 2 blocksize for the downscaling. Each block will be represented by one pixel in the target image.. .RE .RE .TP 10 .B mask Mask an image, one image is taken from the parameters list and the other from the normal filter input. Both images must be of the same dimensions and one must be binary. The attributes of the image coming through the filter pipeline are preserved. The output pixel type corresponds to the input image that is not binary., supported parameters are: .P .RS 14 .I input =(input,required, io) .RS 2 second input image file name. For supported file types see PLUGINS:3dimage/io .RE .RE .TP 10 .B mean 3D image mean filter, supported parameters are: .P .RS 14 .I w = 1 (int) .RS 2 half filter width. in [1, 2147483647] .RE .RE .TP 10 .B median median 3d filter, supported parameters are: .P .RS 14 .I w = 1 (int) .RS 2 filter width parameter. in [0, 2147483647] .RE .RE .TP 10 .B mlv Mean of Least Variance 3D image filter, supported parameters are: .P .RS 14 .I w = 1 (int) .RS 2 filter width parameter. in [0, 2147483647] .RE .RE .TP 10 .B msnormalizer 3D image mean-sigma normalizing filter, supported parameters are: .P .RS 14 .I w = 1 (int) .RS 2 half filter width. in [1, 2147483647] .RE .RE .TP 10 .B open morphological open, supported parameters are: .P .RS 14 .I hint = black (string) .RS 2 a hint at the main image content (black|white). .RE .RE .RS 14 .I shape = [sphere:r=2] (factory) .RS 2 structuring element. For supported plug-ins see PLUGINS:3dimage/shape .RE .RE .TP 10 .B resize Resize an image. The original data is centered within the new sized image., supported parameters are: .P .RS 14 .I size = [[0,0,0]] (streamable) .RS 2 new size of the image a size 0 indicates to keep the size for the corresponding dimension.. .RE .RE .TP 10 .B sandp salt and pepper 3d filter, supported parameters are: .P .RS 14 .I thresh = 100 (float) .RS 2 thresh value. in [0, 3.40282e+38] .RE .RE .RS 14 .I w = 1 (int) .RS 2 filter width parameter. in [0, 2147483647] .RE .RE .TP 10 .B scale 3D image filter that scales to a given target size , supported parameters are: .P .RS 14 .I interp = [bspline:d=3] (factory) .RS 2 interpolation kernel to be used . For supported plug-ins see PLUGINS:1d/splinekernel .RE .RE .RS 14 .I s = [[0,0,0]] (3dbounds) .RS 2 target size to set all components at once (component 0:use input image size). .RE .RE .RS 14 .I sx = 0 (uint) .RS 2 target size in x direction (0:use input image size). in [0, 4294967295] .RE .RE .RS 14 .I sy = 0 (uint) .RS 2 target size in y direction (0:use input image size). in [0, 4294967295] .RE .RE .RS 14 .I sz = 0 (uint) .RS 2 target size in y direction (0:use input image size). in [0, 4294967295] .RE .RE .TP 10 .B selectbig A filter that creats a binary mask representing the intensity with the highest pixel count.The pixel value 0 will be ignored, and if two intensities have the same pixel count, then the result is undefined. The input pixel must have an integral pixel type. .P .RS 14 (no parameters) .RE .TP 10 .B sepconv 3D image intensity separaple convolution filter, supported parameters are: .P .RS 14 .I kx = [gauss:w=1] (factory) .RS 2 filter kernel in x\-direction. For supported plug-ins see PLUGINS:1d/spacialkernel .RE .RE .RS 14 .I ky = [gauss:w=1] (factory) .RS 2 filter kernel in y\-direction. For supported plug-ins see PLUGINS:1d/spacialkernel .RE .RE .RS 14 .I kz = [gauss:w=1] (factory) .RS 2 filter kernel in z\-direction. For supported plug-ins see PLUGINS:1d/spacialkernel .RE .RE .TP 10 .B sws seeded watershead. The algorithm extracts exactly so many reagions as initial labels are given in the seed image., supported parameters are: .P .RS 14 .I grad = 0 (bool) .RS 2 Interpret the input image as gradient. . .RE .RE .RS 14 .I mark = 0 (bool) .RS 2 Mark the segmented watersheds with a special gray scale value. .RE .RE .RS 14 .I n = [sphere:r=1] (factory) .RS 2 Neighborhood for watershead region growing. For supported plug-ins see PLUGINS:3dimage/shape .RE .RE .RS 14 .I seed =(input,required, string) .RS 2 seed input image containing the lables for the initial regions. .RE .RE .TP 10 .B tee Save the input image to a file and also pass it through to the next filter, supported parameters are: .P .RS 14 .I file =(output,required, io) .RS 2 name of the output file to save the image too.. For supported file types see PLUGINS:3dimage/io .RE .RE .TP 10 .B thinning 3D morphological thinning, based on: Lee and Kashyap, 'Building Skeleton Models via 3-D Medial Surface/Axis Thinning Algorithms', Graphical Models and Image Processing, 56(6):462-478, 1994. This implementation only supports the 26 neighbourhood. .P .RS 14 (no parameters) .RE .TP 10 .B transform Transform the input image with the given transformation., supported parameters are: .P .RS 14 .I file =(input,required, io) .RS 2 Name of the file containing the transformation.. For supported file types see PLUGINS:3dtransform/io .RE .RE .RS 14 .I imgboundary = (factory) .RS 2 override image interpolation boundary conditions. For supported plug-ins see PLUGINS:1d/splinebc .RE .RE .RS 14 .I imgkernel = (factory) .RS 2 override image interpolator kernel. For supported plug-ins see PLUGINS:1d/splinekernel .RE .RE .TP 10 .B variance 3D image variance filter, supported parameters are: .P .RS 14 .I w = 1 (int) .RS 2 half filter width. in [1, 2147483647] .RE .RE .TP 10 .B ws basic watershead segmentation., supported parameters are: .P .RS 14 .I evalgrad = 0 (bool) .RS 2 Set to 1 if the input image does not represent a gradient norm image. .RE .RE .RS 14 .I mark = 0 (bool) .RS 2 Mark the segmented watersheds with a special gray scale value. .RE .RE .RS 14 .I n = [sphere:r=1] (factory) .RS 2 Neighborhood for watershead region growing. For supported plug-ins see PLUGINS:3dimage/shape .RE .RE .RS 14 .I thresh = 0 (float) .RS 2 Relative gradient norm threshold. The actual value threshhold value is thresh * (max_grad \- min_grad) + min_grad. Bassins separated by gradients with a lower norm will be joined. in [0, 1] .RE .RE .SH PLUGINS: 3dimage/io .TP 10 .B analyze Analyze 7.5 image .P .RS 14 Recognized file extensions: .HDR, .hdr .RE .RS 14 Supported element types: .RS 2 unsigned 8 bit, signed 16 bit, signed 32 bit, floating point 32 bit, floating point 64 bit .RE .RE .TP 10 .B datapool Virtual IO to and from the internal data pool .P .RS 14 Recognized file extensions: .@ .RE .TP 10 .B dicom Dicom image series as 3D .P .RS 14 Recognized file extensions: .DCM, .dcm .RE .RS 14 Supported element types: .RS 2 signed 16 bit, unsigned 16 bit .RE .RE .TP 10 .B hdf5 HDF5 3D image IO .P .RS 14 Recognized file extensions: .H5, .h5 .RE .RS 14 Supported element types: .RS 2 binary data, signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, signed 64 bit, unsigned 64 bit, floating point 32 bit, floating point 64 bit .RE .RE .TP 10 .B inria INRIA image .P .RS 14 Recognized file extensions: .INR, .inr .RE .RS 14 Supported element types: .RS 2 signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit .RE .RE .TP 10 .B mhd MetaIO 3D image IO using the VTK implementation (experimental). .P .RS 14 Recognized file extensions: .MHA, .MHD, .mha, .mhd .RE .RS 14 Supported element types: .RS 2 signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit .RE .RE .TP 10 .B nifti NIFTI-1 3D image IO .P .RS 14 Recognized file extensions: .NII, .nii .RE .RS 14 Supported element types: .RS 2 signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, signed 64 bit, unsigned 64 bit, floating point 32 bit, floating point 64 bit .RE .RE .TP 10 .B vff VFF Sun raster format .P .RS 14 Recognized file extensions: .VFF, .vff .RE .RS 14 Supported element types: .RS 2 unsigned 8 bit, signed 16 bit .RE .RE .TP 10 .B vista Vista 3D .P .RS 14 Recognized file extensions: .V, .VISTA, .v, .vista .RE .RS 14 Supported element types: .RS 2 binary data, signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit .RE .RE .TP 10 .B vti 3D image VTK-XML in- and output (experimental). .P .RS 14 Recognized file extensions: .VTI, .vti .RE .RS 14 Supported element types: .RS 2 signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit .RE .RE .TP 10 .B vtk 3D VTK image legacy in- and output (experimental). .P .RS 14 Recognized file extensions: .VTK, .VTKIMAGE, .vtk, .vtkimage .RE .RS 14 Supported element types: .RS 2 binary data, signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit .RE .RE .SH PLUGINS: 3dimage/shape .TP 10 .B 18n 18n neighborhood 3D shape creator .P .RS 14 (no parameters) .RE .TP 10 .B 26n 26n neighborhood 3D shape creator .P .RS 14 (no parameters) .RE .TP 10 .B 6n 6n neighborhood 3D shape creator .P .RS 14 (no parameters) .RE .TP 10 .B sphere Closed spherical shape neighborhood including the pixels within a given radius r., supported parameters are: .P .RS 14 .I r = 2 (float) .RS 2 sphere radius. in [0, 3.40282e+38] .RE .RE .SH PLUGINS: 3dtransform/io .TP 10 .B bbs Binary (non-portable) serialized IO of 3D transformations .P .RS 14 Recognized file extensions: .bbs .RE .TP 10 .B datapool Virtual IO to and from the internal data pool .P .RS 14 Recognized file extensions: .@ .RE .TP 10 .B vista Vista storage of 3D transformations .P .RS 14 Recognized file extensions: .v, .v3dt .RE .TP 10 .B xml XML serialized IO of 3D transformations .P .RS 14 Recognized file extensions: .x3dt .RE .SH EXAMPLE Run a mean\-least\-varaiance filter on a series of images that follow the numbering pattern imageXXXX.hdr and store the output in images filteredXXXX.hdr .HP mia\-3dimagefilterstack \-i image0000.hdr \-o filtered \-t hdr mlv:w=2 .SH AUTHOR(s) Gert Wollny .SH COPYRIGHT This software is Copyright (c) 1999\(hy2013 Leipzig, Germany and Madrid, Spain. It comes with ABSOLUTELY NO WARRANTY and you may redistribute it under the terms of the GNU GENERAL PUBLIC LICENSE Version 3 (or later). For more information run the program with the option '\-\-copyright'.