Inheritance diagram for nipy.neurospin.datasets.volumes.volume_data:
The volume data class
This class represents indexable data embedded in a 3D space
Bases: nipy.neurospin.datasets.volumes.volume_field.VolumeField
A class representing data embedded in a 3D space
This object has data stored in an array like, that knows how it is mapped to a 3D “real-world space”, and how it can change real-world coordinate system.
Notes
The data is stored in an undefined way: prescalings might need to be applied to it before using it, or the data might be loaded on demand. The best practice to access the data is not to access the _data attribute, but to use the get_data method.
Attributes
world_space: string | World space the data is embedded in. For instance mni152. |
metadata: dictionnary | Optional, user-defined, dictionnary used to carry around extra information about the data as it goes through transformations. The class consistency of this information is not maintained as the data is modified. |
_data: | Private pointer to the data. |
Methods
as_volume_img | |
composed_with_transform | |
get_data | |
get_transform | |
like_from_data | |
resampled_to_img | |
values_in_world |
x.__init__(...) initializes x; see help(type(x)) for signature
Resample the image to be an image with the data points lying on a regular grid with an affine mapping to the word space (a nipy VolumeImg).
Parameters : | affine: 4x4 or 3x3 ndarray, optional :
shape: (n_x, n_y, n_z), tuple of integers, optional :
interpolation : None, ‘continuous’ or ‘nearest’, optional
|
---|---|
Returns : | resampled_image : nipy VolumeImg
|
Notes
The coordinate system of the image is not changed: the returned image points to the same world space.
Return a new image embedding the same data in a different word space using the given world to world transform.
Parameters : | w2w_transform : transform object
|
---|---|
Returns : | remapped_image : nipy image
|
Return data as a numpy array.
Returns the transform object associated with the volumetric structure which is a general description of the mapping from the values to the world space.
Returns : | transform : nipy.datasets.Transform object |
---|
Returns an volumetric data structure with the same relationship between data and world space, and same metadata, but different data.
Parameters : | data: ndarray : |
---|
Resample the data to be on the same voxel grid than the target volume structure.
Parameters : | target_image : nipy image
interpolation : None, ‘continuous’ or ‘nearest’, optional
|
---|---|
Returns : | resampled_image : nipy_image
|
Notes
Both the target image and the original image should be embedded in the same world space.
Return the values of the data at the world-space positions given by x, y, z
Parameters : | x : number or ndarray
y : number or ndarray
z : number or ndarray
interpolation : None, ‘continuous’ or ‘nearest’, optional
|
---|---|
Returns : | values : number or ndarray
|