bionic (1) mia-3dimagecreator.1.gz

Provided by: mia-tools_2.4.6-1_amd64 bug

NAME

       ('mia\-3dimagecreator',) - Create a synthetic 3D image.

SYNOPSIS

       mia-3dimagecreator -o <out-file> [options]

DESCRIPTION

       mia-3dimagecreator  This  program creates a 3D image that contains an object created by one of the object
       creator plug-ins (creator/3dimage)

OPTIONS

              -o --out-file=(output, required); io
                     output file for create object
                      For supported file types see PLUGINS:3dimage/io

              -s --size=[128,128,128]
                     size of the object

              -r --repn=ubyte
                     input pixel type

                        none ‐ no pixel type defined
                        float ‐ floating point 32 bit
                        sbyte ‐ signed 8 bit
                        ulong ‐ unsigned 64 bit
                        double ‐ floating point 64 bit
                        sint ‐ signed 32 bit
                        ushort ‐ unsigned 16 bit
                        sshort ‐ signed 16 bit
                        uint ‐ unsigned 32 bit
                        slong ‐ signed 64 bit
                        bit ‐ binary data
                        ubyte ‐ unsigned 8 bit

              -j --object=sphere
                     object to be created
                      For supported plugins see PLUGINS:3dimage/creator

   Help & Info
              -V --verbose=warning
                     verbosity of output, print  messages  of  given  level  and  higher  priorities.  Supported
                     priorities starting at lowest level are:

                        info ‐ Low level messages
                        trace ‐ Function call trace
                        fail ‐ Report test failures
                        warning ‐ Warnings
                        error ‐ Report errors
                        debug ‐ Debug output
                        message ‐ Normal messages
                        fatal ‐ Report only fatal errors

                 --copyright
                     print copyright information

              -h --help
                     print this help

              -? --usage
                     print a short help

                 --version
                     print the version number and exit

   Processing
                 --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).

PLUGINS: 3dimage/creator

       lattic    3D lattic creation program, supported parameters are:

                     fx = 16; float in [1, 64]
                       frequency in x-dir.

                     fy = 16; float in [1, 64]
                       frequency in y-dir.

                     fz = 16; float in [1, 64]
                       frequency in z-dir.

       sphere    3D sphere creation program, supported parameters are:

                     f = 2; float in [0, 10]
                       spherical change frequency.

                     p = 2; float in [0.1, 100]
                       spherical shape parameter (2.0 = sphere).

PLUGINS: 3dimage/io

       analyze   Analyze 7.5 image

                     ('Recognized file extensions: ', '.HDR, .hdr')

                     Supported element types:
                       unsigned 8 bit, signed 16 bit, signed 32 bit, floating point 32 bit,  floating  point  64
                       bit

       datapool  Virtual IO to and from the internal data pool

                     ('Recognized file extensions: ', '.@')

       dicom     Dicom image series as 3D

                     ('Recognized file extensions: ', '.DCM, .dcm')

                     Supported element types:
                       signed 16 bit, unsigned 16 bit

       hdf5      HDF5 3D image IO

                     ('Recognized file extensions: ', '.H5, .h5')

                     Supported element types:
                       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

       inria     INRIA image

                     ('Recognized file extensions: ', '.INR, .inr')

                     Supported element types:
                       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

       mhd       MetaIO 3D image IO using the VTK implementation (experimental).

                     ('Recognized file extensions: ', '.MHA, .MHD, .mha, .mhd')

                     Supported element types:
                       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

       nifti     NIFTI-1  3D  image  IO.  The  orientation  is  transformed in the same way like it is done with
                 'dicomtonifti --no-reorder' from the vtk-dicom package.

                     ('Recognized file extensions: ', '.NII, .nii')

                     Supported element types:
                       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

       vff       VFF Sun raster format

                     ('Recognized file extensions: ', '.VFF, .vff')

                     Supported element types:
                       unsigned 8 bit, signed 16 bit

       vista     Vista 3D

                     ('Recognized file extensions: ', '.-, .V, .VISTA, .v, .vista')

                     Supported element types:
                       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

       vti       3D image VTK-XML in- and output (experimental).

                     ('Recognized file extensions: ', '.VTI, .vti')

                     Supported element types:
                       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

       vtk       3D VTK image legacy in- and output (experimental).

                     ('Recognized file extensions: ', '.VTK, .VTKIMAGE, .vtk, .vtkimage')

                     Supported element types:
                       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

EXAMPLE

       Create an image output.v of size <64,128,256> that contains a lattic with frequencys 8, 16, and 4 in x, y
       and, z-direction respectively.

       mia-3dimagecreator -o lattic.v -j lattic:fx=8,fy=16,fz=4 -s "<64,128,256>"

AUTHOR(s)

       Gert Wollny

       This  software is Copyright (c) 1999‐2015 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'.