.. AUTO-GENERATED FILE -- DO NOT EDIT!

interfaces.camino.utils
=======================


.. _nipype.interfaces.camino.utils.ImageStats:


.. index:: ImageStats

ImageStats
----------

`Link to code <file:///build/nipype-1.1.9/nipype/interfaces/camino/utils.py#L57>`__

Wraps the executable command ``imagestats``.

This program computes voxelwise statistics on a series of 3D images. The images
must be in the same space; the operation is performed voxelwise and one output
is produced per voxel.

Examples
~~~~~~~~

>>> import nipype.interfaces.camino as cam
>>> imstats = cam.ImageStats()
>>> imstats.inputs.in_files = ['im1.nii','im2.nii','im3.nii']
>>> imstats.inputs.stat = 'max'
>>> imstats.run()                  # doctest: +SKIP

Inputs::

        [Mandatory]
        in_files: (a list of items which are an existing file name)
                List of images to process. They must be in the same space and have
                the same dimensions.
                argument: ``-images %s``, position: -1
        stat: ('min' or 'max' or 'mean' or 'median' or 'sum' or 'std' or
                  'var')
                The statistic to compute.
                argument: ``-stat %s``
        output_root: (a file name)
                Filename root prepended onto the names of the output files. The
                extension will be determined from the input.
                argument: ``-outputroot %s``

        [Optional]
        out_type: ('float' or 'char' or 'short' or 'int' or 'long' or
                  'double', nipype default value: float)
                A Camino data type string, default is "float". Type must be signed.
                argument: ``-outputdatatype %s``
        args: (a unicode string)
                Additional parameters to the command
                argument: ``%s``
        environ: (a dictionary with keys which are a bytes or None or a value
                  of class 'str' and with values which are a bytes or None or a
                  value of class 'str', nipype default value: {})
                Environment variables

Outputs::

        out_file: (an existing file name)
                Path of the file computed with the statistic chosen
