Home · Quickstart · Documentation · Citation · NiPy

# interfaces.vista.vista

## Vnifti2Image

Link to code

Wraps command vnifti2image

Convert a nifti file into a vista file.

### Example

    >>> vimage = Vnifti2Image()
    >>> vimage.inputs.in_file = 'image.nii'
    >>> vimage.cmdline
    'vnifti2image -in image.nii -out image.v'
    >>> vimage.run()

Inputs:

    [Mandatory]
    in_file: (an existing file name)
            in file
            flag: -in %s, position: 1
    terminal_output: ('stream' or 'allatonce' or 'file' or 'none')
            Control terminal output: `stream` - displays to terminal
            immediately, `allatonce` - waits till command is finished to display
            output, `file` - writes output to file, `none` - output is ignored

    [Optional]
    args: (a string)
            Additional parameters to the command
            flag: %s
    attributes: (an existing file name)
            attribute file
            flag: -attr %s, position: 2
    environ: (a dictionary with keys which are a value of type 'str' and
             with values which are a value of type 'str', nipype default value:
             {})
            Environment variables
    ignore_exception: (a boolean, nipype default value: False)
            Print an error message instead of throwing an exception in case the
            interface fails to run
    out_file: (a file name)
            output data file
            flag: -out %s, position: -1

Outputs:

    out_file: (an existing file name)
            Output vista file

## VtoMat

Link to code

Wraps command vtomat

Convert a nifti file into a vista file.

### Example

    >>> vimage = VtoMat()
    >>> vimage.inputs.in_file = 'image.v'
    >>> vimage.cmdline
    'vtomat -in image.v -out image.mat'
    >>> vimage.run()

Inputs:

    [Mandatory]
    in_file: (an existing file name)
            in file
            flag: -in %s, position: 1
    terminal_output: ('stream' or 'allatonce' or 'file' or 'none')
            Control terminal output: `stream` - displays to terminal
            immediately, `allatonce` - waits till command is finished to display
            output, `file` - writes output to file, `none` - output is ignored

    [Optional]
    args: (a string)
            Additional parameters to the command
            flag: %s
    environ: (a dictionary with keys which are a value of type 'str' and
             with values which are a value of type 'str', nipype default value:
             {})
            Environment variables
    ignore_exception: (a boolean, nipype default value: False)
            Print an error message instead of throwing an exception in case the
            interface fails to run
    out_file: (a file name)
            output mat file
            flag: -out %s, position: -1

Outputs:

    out_file: (an existing file name)
            Output mat file