Struct nifti::object::GenericNiftiObject

pub struct GenericNiftiObject<V> { /* fields omitted */ }

Generic data type for a NIfTI object.

Implementations

impl GenericNiftiObject<InMemNiftiVolume>

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

👎 Deprecated since 0.10.0:

use read_file from ReaderOptions instead

Retrieve the full contents of a NIFTI object. The given file system path is used as reference. If the file only contains the header, this method will look for the corresponding file with the extension ".img", or ".img.gz" if the former wasn't found.

Example

use nifti::{NiftiObject, InMemNiftiObject};

let obj = InMemNiftiObject::from_file("minimal.nii.gz")?;

pub fn from_file_pair<P, Q>(hdr_path: P, vol_path: Q) -> Result<Self> where
    P: AsRef<Path>,
    Q: AsRef<Path>, 

👎 Deprecated since 0.10.0:

use read_file_pair from ReaderOptions instead

Retrieve a NIFTI object as separate header and volume files. This method is useful when file names are not conventional for a NIFTI file pair.

impl GenericNiftiObject<StreamedNiftiVolume<R>>

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

👎 Deprecated since 0.10.0:

use read_file from ReaderStreamedOptions instead

Retrieve the NIfTI object and prepare the volume for streamed reading. The given file system path is used as reference. If the file only contains the header, this method will look for the corresponding file with the extension ".img", or ".img.gz" if the former wasn't found.

Example

use nifti::{NiftiObject, StreamedNiftiObject};

let obj = StreamedNiftiObject::from_file("minimal.nii.gz")?;

let volume = obj.into_volume();
for slice in volume {
    let slice = slice?;
    // manipulate slice here
}

pub fn from_file_rank<P: AsRef<Path>>(path: P, slice_rank: u16) -> Result<Self>

👎 Deprecated since 0.10.0:

use read_file_rank from ReaderStreamedOptions instead

Retrieve the NIfTI object and prepare the volume for streamed reading, using slice_rank as the dimensionality of each slice. The given file system path is used as reference. If the file only contains the header, this method will look for the corresponding file with the extension ".img", or ".img.gz" if the former wasn't found.

pub fn from_file_pair<P, Q>(hdr_path: P, vol_path: Q) -> Result<Self> where
    P: AsRef<Path>,
    Q: AsRef<Path>, 

👎 Deprecated since 0.10.0:

use read_file_pair from ReaderStreamedOptions instead

Retrieve a NIfTI object as separate header and volume files, for streamed volume reading. This method is useful when file names are not conventional for a NIfTI file pair.

Example

use nifti::{NiftiObject, StreamedNiftiObject};

let obj = StreamedNiftiObject::from_file_pair("abc.hdr", "abc.img.gz")?;

let volume = obj.into_volume();
for slice in volume {
    let slice = slice?;
    // manipulate slice here
}

pub fn from_file_pair_rank<P, Q>(
    hdr_path: P,
    vol_path: Q,
    slice_rank: u16
) -> Result<Self> where
    P: AsRef<Path>,
    Q: AsRef<Path>, 

👎 Deprecated since 0.10.0:

use read_file_pair_rank from ReaderStreamedOptions instead

Retrieve a NIfTI object as separate header and volume files, for streamed volume reading, using slice_rank as the dimensionality of each slice. This method is useful when file names are not conventional for a NIfTI file pair.

impl<V> GenericNiftiObject<V>

pub fn from_reader<R>(mut source: R) -> Result<Self> where
    R: Read,
    V: FromSource<R>, 

Construct a NIfTI object from a data reader, first by fetching the header, the extensions, and then the volume.

Errors

• NiftiError::NoVolumeData if the source only contains (or claims to contain) a header.

Trait Implementations

impl<V: Clone> Clone for GenericNiftiObject<V>

pub fn clone(&self) -> GenericNiftiObject<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for GenericNiftiObject<V>

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

Formats the value using the given formatter.

impl<V> NiftiObject for GenericNiftiObject<V> where
    V: NiftiVolume, 

type Volume = V

The concrete type of the volume.

pub fn header(&self) -> &NiftiHeader

Obtain a reference to the NIFTI header.

pub fn header_mut(&mut self) -> &mut NiftiHeader

Obtain a mutable reference to the NIFTI header.

pub fn extensions(&self) -> &ExtensionSequence

Obtain a reference to the object's extensions.

pub fn volume(&self) -> &Self::Volume

Obtain a reference to the object's volume.

pub fn into_volume(self) -> Self::Volume

Move the volume out of the object, discarding the header and extensions.

impl<V: PartialEq> PartialEq<GenericNiftiObject<V>> for GenericNiftiObject<V>

pub fn eq(&self, other: &GenericNiftiObject<V>) -> bool

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

pub fn ne(&self, other: &GenericNiftiObject<V>) -> bool

This method tests for !=.

impl<V> StructuralPartialEq for GenericNiftiObject<V>