Struct nifti::volume::inmem::InMemNiftiVolume

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.

Implementations

impl InMemNiftiVolume

pub fn from_raw_data(header: &NiftiHeader, raw_data: Vec<u8>) -> Result<Self>

Build an InMemNiftiVolume from a header and a buffer. The buffer length and the dimensions declared in the header are expected to fit.

pub fn from_raw_fields(
    raw_dim: [u16; 8],
    datatype: NiftiType,
    scl_slope: f32,
    scl_inter: f32,
    raw_data: Vec<u8>,
    endianness: Endianness
) -> Result<Self>

Build an InMemNiftiVolume from its raw set of attributes. The raw data is assumed to contain exactly enough bytes to contain the data elements of the volume in F-major order, with the byte order specified in endianness, as specified by the volume shape in raw_dim and data type in datatype.

pub fn from_reader<R: Read>(source: R, header: &NiftiHeader) -> Result<Self>

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).

pub fn from_file<P: AsRef<Path>>(path: P, header: &NiftiHeader) -> Result<Self>

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.

pub fn into_raw_data(self) -> Vec<u8>

Retrieve the raw data, consuming the volume.

pub fn raw_data(&self) -> &[u8]

Retrieve a reference to the raw data.

pub fn raw_data_mut(&mut self) -> &mut [u8]

Retrieve a mutable reference to the raw data.

Trait Implementations

impl Clone for InMemNiftiVolume

pub fn clone(&self) -> InMemNiftiVolume

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InMemNiftiVolume

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R> FromSource<R> for InMemNiftiVolume where
    R: Read, 

pub fn from_reader(
    reader: R,
    header: &NiftiHeader,
    (): Self::Options
) -> Result<Self>

Read a NIfTI volume from a stream of raw voxel data. The header and expected byte order of the volume's data must be known in advance. It is also expected that the following bytes represent the first voxels of the volume (and not part of the extensions).

impl FromSourceOptions for InMemNiftiVolume

type Options = ()

Set of additional options required (or useful) for constructing a volume.

impl IntoNdArray for InMemNiftiVolume

pub fn into_ndarray<T>(self) -> Result<Array<T, IxDyn>> where
    T: DataElement, 

Consume the volume into an ndarray.

impl<'a> IntoNdArray for &'a InMemNiftiVolume

pub fn into_ndarray<T>(self) -> Result<Array<T, IxDyn>> where
    T: DataElement, 

Create an ndarray from the given volume.

impl<'a> NiftiVolume for &'a InMemNiftiVolume

pub fn dim(&self) -> &[u16]

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.

pub fn dimensionality(&self) -> usize

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).

pub fn data_type(&self) -> NiftiType

Get this volume's data type.

impl NiftiVolume for InMemNiftiVolume

pub fn dim(&self) -> &[u16]

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.

pub fn dimensionality(&self) -> usize

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).

pub fn data_type(&self) -> NiftiType

Get this volume's data type.

impl PartialEq<InMemNiftiVolume> for InMemNiftiVolume

pub fn eq(&self, other: &InMemNiftiVolume) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &InMemNiftiVolume) -> bool

This method tests for !=.

impl RandomAccessNiftiVolume for InMemNiftiVolume

pub fn get_f32(&self, coords: &[u16]) -> Result<f32>

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.

pub fn get_f64(&self, coords: &[u16]) -> Result<f64>

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.

pub fn get_u8(&self, coords: &[u16]) -> Result<u8>

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.

pub fn get_i8(&self, coords: &[u16]) -> Result<i8>

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.

pub fn get_u16(&self, coords: &[u16]) -> Result<u16>

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.

pub fn get_i16(&self, coords: &[u16]) -> Result<i16>

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.

pub fn get_u32(&self, coords: &[u16]) -> Result<u32>

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.

pub fn get_i32(&self, coords: &[u16]) -> Result<i32>

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.

pub fn get_u64(&self, coords: &[u16]) -> Result<u64>

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.

pub fn get_i64(&self, coords: &[u16]) -> Result<i64>

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.

impl<'a> RandomAccessNiftiVolume for &'a InMemNiftiVolume

pub fn get_f32(&self, coords: &[u16]) -> Result<f32>

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.

pub fn get_f64(&self, coords: &[u16]) -> Result<f64>

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.

pub fn get_u8(&self, coords: &[u16]) -> Result<u8>

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.

pub fn get_i8(&self, coords: &[u16]) -> Result<i8>

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.

pub fn get_u16(&self, coords: &[u16]) -> Result<u16>

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.

pub fn get_i16(&self, coords: &[u16]) -> Result<i16>

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.

pub fn get_u32(&self, coords: &[u16]) -> Result<u32>

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.

pub fn get_i32(&self, coords: &[u16]) -> Result<i32>

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.

pub fn get_u64(&self, coords: &[u16]) -> Result<u64>

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.

pub fn get_i64(&self, coords: &[u16]) -> Result<i64>

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.

impl StructuralPartialEq for InMemNiftiVolume