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

interfaces.bru2nii
==================


.. _nipype.interfaces.bru2nii.Bru2:


.. index:: Bru2

Bru2
----

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/bru2nii.py#L40>`__

Wraps the executable command ``Bru2``.

Uses bru2nii's Bru2 to convert Bruker files

Examples
~~~~~~~~

>>> from nipype.interfaces.bru2nii import Bru2
>>> converter = Bru2()
>>> converter.inputs.input_dir = "brukerdir"
>>> converter.cmdline  # doctest: +ELLIPSIS
'Bru2 -o .../data/brukerdir brukerdir'

Inputs::

        [Mandatory]
        input_dir: (an existing directory name)
                Input Directory
                argument: ``%s``, position: -1

        [Optional]
        actual_size: (a boolean)
                Keep actual size - otherwise x10 scale so animals match human.
                argument: ``-a``
        args: (a unicode string)
                Additional parameters to the command
                argument: ``%s``
        compress: (a boolean)
                gz compress images (".nii.gz").
                argument: ``-z``
        output_filename: (a unicode string)
                Output filename (".nii" will be appended, or ".nii.gz" if the "-z"
                compress option is selected)
                argument: ``-o %s``
        environ: (a dictionary with keys which are a newbytes or None or a
                  newstr or None and with values which are a newbytes or None or a
                  newstr or None, nipype default value: {})
                Environment variables
        force_conversion: (a boolean)
                Force conversion of localizers images (multiple slice orientations).
                argument: ``-f``
        append_protocol_name: (a boolean)
                Append protocol name to output filename.
                argument: ``-p``

Outputs::

        nii_file: (an existing file name)
