NIPY logo

Table Of Contents

Previous topic

Interfaces and Algorithms

Next topic

nipype.algorithms.modelgen

This Page

nipype.algorithms.misc

Dissimilarity

Calculates dissimilarity between two maps.

Inputs:

[Mandatory]
volume1 : (an existing file name)
        Has to have the same dimensions as volume2.
volume2 : (an existing file name)
        Has to have the same dimensions as volume1.

[Optional]
method : ('dice' or 'jaccard')
        "dice": Dice's dissimilarity,    "jaccard": Jaccards's dissimilarity

Outputs:

dissimilarity : (a float)
        Unknown

Distance

Calculates distance between two volumes.

Inputs:

[Mandatory]
volume1 : (an existing file name)
        Has to have the same dimensions as volume2.
volume2 : (an existing file name)
        Has to have the same dimensions as volume1.

[Optional]
method : ('eucl_min' or 'eucl_cog' or 'eucl_mean' or 'eucl_wmean')
        ""eucl_min": Euclidean distance between two closest points    "eucl_cog": mean Euclidian distance between the Center of Gravity of volume1 and CoGs of volume2    "eucl_mean": mean Euclidian minimum distance of all volume2 voxels to volume1    "eucl_wmean": mean Euclidian minimum distance of all volume2 voxels to volume1 weighted by their values

Outputs:

distance : (a float)
        Unknown
histogram : (a file name)
        Unknown
point1 : (an array with shape (3,))
        Unknown
point2 : (an array with shape (3,))
        Unknown

ModifyAffine

Left multiplies the affine matrix with a specified values. Saves the volume as a nifti file.

Inputs:

[Mandatory]
volumes : (an existing file name)
        volumes which affine matrices will be modified

[Optional]
transformation_matrix : (an array with shape (4, 4))
        transformation matrix that will be left multiplied by the affine matrix

Outputs:

transformed_volumes : (a file name)
        Unknown

PickAtlas

Returns ROI masks given an atlas and a list of labels. Supports dilation and left right masking (assuming the atlas is properly aligned).

Inputs:

[Optional]
atlas : (an existing file name)
        Location of the atlas that will be used.
dilation_size : (an integer)
        Defines how much the mask will be dilated (expanded in 3D).
hemi : ('both' or 'left' or 'right')
        Restrict the mask to only one hemisphere: left or right
labels : (an integer or a list of items which are an integer)
        Labels of regions that will be included in the mask. Must be compatible with the atlas used.
output_file : (a file name)
        Where to store the output mask.

Outputs:

mask_file : (an existing file name)
        output mask file

SimpleThreshold

Inputs:

[Mandatory]
threshold : (a float)
        volumes to be thresholdedeverything below this value will be set to zero
volumes : (an existing file name)
        volumes to be thresholded

Outputs:

thresholded_volumes : (an existing file name)
        thresholded volumes