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

interfaces.dipy.base
====================


.. _nipype.interfaces.dipy.base.DipyBaseInterface:


.. index:: DipyBaseInterface

DipyBaseInterface
-----------------

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/dipy/base.py#L35>`__

A base interface for py:mod:`dipy` computations

Inputs::

        None

Outputs::

        None

.. _nipype.interfaces.dipy.base.DipyDiffusionInterface:


.. index:: DipyDiffusionInterface

DipyDiffusionInterface
----------------------

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/dipy/base.py#L50>`__

A base interface for py:mod:`dipy` computations

Inputs::

        [Mandatory]
        in_bval: (an existing file name)
                input b-values table
        in_bvec: (an existing file name)
                input b-vectors table
        in_file: (an existing file name)
                input diffusion data

        [Optional]
        b0_thres: (an integer (int or long), nipype default value: 700)
                b0 threshold
        out_prefix: (a unicode string)
                output prefix for file names

Outputs::

        None

.. module:: nipype.interfaces.dipy.base


.. _nipype.interfaces.dipy.base.convert_to_traits_type:

:func:`convert_to_traits_type`
------------------------------

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/dipy/base.py#L82>`__



Convert DIPY type to Traits type.


.. _nipype.interfaces.dipy.base.create_interface_specs:

:func:`create_interface_specs`
------------------------------

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/dipy/base.py#L114>`__



Create IN/Out interface specifications dynamically.

Parameters
~~~~~~~~~~
class_name: str
    The future class name(e.g, (MyClassInSpec))
params: list of tuple
    dipy argument list
BaseClass: TraitedSpec object
    parent class

Returns
~~~~~~~
newclass: object
    new nipype interface specification class


.. _nipype.interfaces.dipy.base.dipy_to_nipype_interface:

:func:`dipy_to_nipype_interface`
--------------------------------

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/dipy/base.py#L156>`__



Construct a class in order to respect nipype interface specifications.

This convenient class factory convert a DIPY Workflow to a nipype
interface.

Parameters
~~~~~~~~~~
cls_name: string
    new class name
dipy_flow: Workflow class type.
    It should be any children class of `dipy.workflows.workflow.Worflow`
BaseClass: object
    nipype instance object

Returns
~~~~~~~
newclass: object
    new nipype interface specification class

