pub struct InMemNiftiVolume { /* fields omitted */ }
A data type for a NIFTI-1 volume contained in memory. Objects of this type
contain raw image data, which is converted automatically when using reading
methods or converting it to an ndarray
(only with the ndarray_volumes
feature).
Since NIfTI volumes are stored in disk in column major order (also called
Fortran order), this data type will also retain this memory order.
Build an InMemNiftiVolume from a header and a buffer. The buffer length and the dimensions
declared in the header are expected to fit.
Read a NIFTI volume from a stream of data. The header and expected byte order
of the volume's data must be known in advance. It it also expected that the
following bytes represent the first voxels of the volume (and not part of the
extensions).
Read a NIFTI volume, and extensions, from a stream of data. The header,
extender code and expected byte order of the volume's data must be
known in advance.
Read a NIFTI volume from an image file. NIFTI-1 volume files usually have the
extension ".img" or ".img.gz". In the latter case, the file is automatically
decoded as a Gzip stream.
Read a NIFTI volume, along with the extensions, from an image file. NIFTI-1 volume
files usually have the extension ".img" or ".img.gz". In the latter case, the file
is automatically decoded as a Gzip stream.
Deprecated since 0.6.0
: naming was unconventional, please use into_raw_data
instead
Retrieve the raw data, consuming the volume.
Retrieve the raw data, consuming the volume.
Deprecated
: unconventional naming, please use raw_data
instead
Retrieve a reference to the raw data.
Retrieve a reference to the raw data.
Deprecated
: unconventional naming, please use raw_data_mut
instead
Retrieve a mutable reference to the raw data.
Retrieve a mutable reference to the raw data.
Formats the value using the given formatter. Read more
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.
Performs copy-assignment from source
. Read more
Get the dimensions of the volume. Unlike how NIFTI-1 stores dimensions, the returned slice does not include dim[0]
and is clipped to the effective number of dimensions. Read more
Get the volume's number of dimensions. In a fully compliant file, this is equivalent to the corresponding header's dim[0]
field (with byte swapping already applied). Read more
Get this volume's data type.
Fetch a single voxel's value in the given voxel index coordinates as a single precision floating point value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a double precision floating point value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as an unsigned 8-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a signed 8-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as an unsigned 16-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a signed 16-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as an unsigned 32-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a signed 32-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as an unsigned 64-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a signed 64-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Get the dimensions of the volume. Unlike how NIFTI-1 stores dimensions, the returned slice does not include dim[0]
and is clipped to the effective number of dimensions. Read more
Get the volume's number of dimensions. In a fully compliant file, this is equivalent to the corresponding header's dim[0]
field (with byte swapping already applied). Read more
Get this volume's data type.
Fetch a single voxel's value in the given voxel index coordinates as a single precision floating point value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a double precision floating point value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as an unsigned 8-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a signed 8-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as an unsigned 16-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a signed 16-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as an unsigned 32-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a signed 32-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as an unsigned 64-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more
Fetch a single voxel's value in the given voxel index coordinates as a signed 64-bit value. All necessary conversions and transformations are made when reading the voxel, including scaling. Note that using this function continuously to traverse the volume is inefficient. Prefer using iterators or the ndarray
API for volume traversal. Read more