Inheritance diagram for nipy.neurospin.datasets.volumes.volume_field:
The base volumetric field interface
This defines the nipy volumetric structure interface.
Bases: object
The base volumetric structure.
This object represents numerical values embedded in a 3-dimensional world space (called a field in physics and engineering)
This is an abstract base class: it defines the interface, but not the logics.
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 consistency of this information is not maintained as the data is modified. |
Methods
as_volume_img | |
composed_with_transform | |
get_transform | |
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
|
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 |
---|
Resample the volume to be sampled similarly than the target volumetric structure.
Parameters : | target_image : nipy volume
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
|