interfaces.dipy.base

DipyBaseInterface

Link to code

A base interface for py:mod:dipy computations

Inputs:

None

Outputs:

None

DipyDiffusionInterface

Link to code

A base interface for py:mod:dipy computations

Inputs:

[Mandatory]
in_file: (a pathlike object or string representing an existing file)
        input diffusion data
in_bval: (a pathlike object or string representing an existing file)
        input b-values table
in_bvec: (a pathlike object or string representing an existing file)
        input b-vectors table

[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

convert_to_traits_type()

Link to code

Convert DIPY type to Traits type.

create_interface_specs()

Link to code

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

dipy_to_nipype_interface()

Link to code

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

get_dipy_workflows()

Link to code

Search for DIPY workflow class.

Parameters

module : object

module object

Returns

l_wkflw : list of tuple

This a list of tuple containing 2 elements: Worflow name, Workflow class obj

Examples

>>> from dipy.workflows import align  # doctest: +SKIP
>>> get_dipy_workflows(align)  # doctest: +SKIP