Struct nifti::object::ReaderOptions

pub struct ReaderOptions { /* fields omitted */ }

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

Implementations

impl ReaderOptions

pub fn new() -> ReaderOptions

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<InMemNiftiObject> where
    P: AsRef<Path>, 

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

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

pub fn read_file_pair<P, Q>(
    &self,
    hdr_path: P,
    vol_path: Q
) -> Result<InMemNiftiObject> where
    P: AsRef<Path>,
    Q: AsRef<Path>, 

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.

Trait Implementations

impl Clone for ReaderOptions

fn clone(&self) -> ReaderOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReaderOptions

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq<ReaderOptions> for ReaderOptions

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

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

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

This method tests for !=.

impl StructuralPartialEq for ReaderOptions