Struct Reader 

pub struct Reader { /* private fields */ }

Implementations

impl Reader

pub fn open(path: &str) -> Result<Self, Error>

pub fn shape(&self) -> VolumeShape

pub fn mode(&self) -> Mode

pub fn header(&self) -> &Header

pub fn slices<T>(&self) -> SliceIter<'_, T>

pub fn slabs<T>(&self, k: usize) -> SlabIter<'_, T>

pub fn blocks<T>(&self, chunk_shape: [usize; 3]) -> BlockIter<'_, T>

pub fn can_zero_copy<T: Voxel>(&self) -> bool

Check if zero-copy decode is possible for the given type. Zero-copy requires: file mode matches T’s mode AND file endian is native.

pub fn read_converted<S, D>( &self, offset: [usize; 3], shape: [usize; 3], ) -> Result<VoxelBlock<D>, Error>

where S: EndianCodec + Send + Copy + Default + Voxel, D: Convert<S> + EndianCodec + Copy + Default + Voxel,

Read and convert voxels from file mode to target type D.

This method decodes the raw bytes using the file’s voxel mode, then converts each voxel to the destination type D using the Convert trait.

Example

// Read Int16 file as Float32
let reader = Reader::open("data.mrc")?;
let block: VoxelBlock<f32> = reader.read_converted::<i16, f32>([0,0,0], [64,64,64])?;

pub fn conversion_path(&self, dst_mode: Mode) -> ConversionPath

Get the optimal conversion path for the given source and destination modes.

pub fn slices_converted<S, D>(&self) -> SliceIterConverted<'_, S, D>

where S: Voxel, D: Convert<S> + Voxel,

Iterate over slices with type conversion.

Example

// Read Int16 file as Float32 slices
let reader = Reader::open("data.mrc")?;
for slice in reader.slices_converted::<i16, f32>() {
    let data: Vec<f32> = slice?.data; // converted from i16
}

pub fn slabs_converted<S, D>(&self, k: usize) -> SlabIterConverted<'_, S, D>

where S: Voxel, D: Convert<S> + Voxel,

Iterate over slabs with type conversion.

Example

// Read Int16 file as Float32 slabs of 10 slices each
let reader = Reader::open("data.mrc")?;
for slab in reader.slabs_converted::<i16, f32>(10) {
    let data: Vec<f32> = slab?.data; // converted from i16
}

impl Reader

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

Get a reference to the raw data bytes

pub fn endian(&self) -> FileEndian

Get the file endianness