dipy logo

Site Navigation

NIPY Community

dipy.reconst.modelarray

Class to present model parameters as voxel-shaped array

class dipy.reconst.modelarray.ModelArray

A class that has a shape and can be indexed like an ndarray

When using a model to describe many voxels, ModelArray allows the parameters of a model to be stored as an ndarray where the last dimension of the array represents the parameters, and the first n-1 dimensions represent the shape or arrangement of the voxels. Model array is meant to be sub-classed to make more specific model classes.

mask

If the model_params array has a mask, returns the mask

model_params

Parameters of the model

All the parameters needed for a model should be flattened into the last dimension of model_params. The shape of the ModelArray is determined by the model_params.shape[:-1].

ndim

Gives the number of dimensions of the ModelArray

shape

Shape of model array