Struct nifti::object::ReaderStreamedOptions

pub struct ReaderStreamedOptions { /* fields omitted */ }

Options and flags which can be used to configure how a NIfTI image is read and iterated.

Implementations

impl ReaderStreamedOptions

pub fn new() -> ReaderStreamedOptions

Creates a blank new set of options ready for configuration.

All options are initially set to false.

pub fn fix_header(&mut self, fix_header: bool) -> &mut Self

Sets the options to fix some known header problems.

pub fn read_file<P>(
    &self,
    path: P
) -> Result<StreamedNiftiObject<MaybeGzDecodedFile>> where
    P: AsRef<Path>, 

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, ReaderStreamedOptions};

let obj = ReaderStreamedOptions::new().read_file("minimal.nii.gz")?;

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

pub fn read_file_rank<P>(
    &self,
    path: P,
    slice_rank: u16
) -> Result<StreamedNiftiObject<MaybeGzDecodedFile>> where
    P: AsRef<Path>, 

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 read_file_pair<P, Q>(
    &self,
    hdr_path: P,
    vol_path: Q
) -> Result<StreamedNiftiObject<MaybeGzDecodedFile>> where
    P: AsRef<Path>,
    Q: AsRef<Path>, 

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, ReaderStreamedOptions};

let obj = ReaderStreamedOptions::new().read_file_pair("abc.hdr", "abc.img.gz")?;

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

pub fn read_file_pair_rank<P, Q>(
    &self,
    hdr_path: P,
    vol_path: Q,
    slice_rank: u16
) -> Result<StreamedNiftiObject<MaybeGzDecodedFile>> where
    P: AsRef<Path>,
    Q: AsRef<Path>, 

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.

Trait Implementations

impl Clone for ReaderStreamedOptions

pub fn clone(&self) -> ReaderStreamedOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReaderStreamedOptions

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

Formats the value using the given formatter.

impl PartialEq<ReaderStreamedOptions> for ReaderStreamedOptions

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

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

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

This method tests for !=.

impl StructuralPartialEq for ReaderStreamedOptions