How czotti/nifti-rs works
NIFTI-rs is a Rust library for reading NIfTI-1.1 files and exposing their headers, extensions, and voxel volumes. The principal workflow is a caller selecting a reader, which produces an object containing parsed metadata and either an in-memory or streamed volume; callers can then inspect voxels or optionally convert a volume to ndarray. The graph also retains affine transforms and writing as distinct capabilities. Relationships are based on README statements and the cited source references; some implementation details were not sampled.
Main entry points: object.rs NIfTI Object · inmem.rs In-Memory Volume · header.rs Header Parser · mod.rs Volume API
Components 15
File Reading
- NIfTI Object
src/object.rs - Volume Writer
src/writer.rs
Format Metadata
- Header Parser
src/header.rs - Extensions
src/extension.rs - Affine Transforms
src/affine.rs
Voxel Volumes
- Volume API
src/volume/mod.rs - In-Memory Volume
src/volume/inmem.rs - Streamed Volume
src/volume/streamed.rs - Volume Shape
src/volume/shape.rs - ndarray Conversion
src/volume/ndarray.rs
Data Support
- NIfTI Types
src/typedef.rs - Voxel Elements
src/volume/element.rs - Format Utilities
src/util.rs - Error Types
src/error.rs
Other components
- Library Caller
Connections 19
- Library Caller → NIfTI Object: reads files
README.md - NIfTI Object → Header Parser: parses header
src/object.rs - NIfTI Object → Extensions: loads extensions
src/object.rs - NIfTI Object → In-Memory Volume: creates volume
src/object.rs - NIfTI Object → Streamed Volume: creates volume
src/object.rs - NIfTI Object → Volume API: exposes volume
src/object.rs - Header Parser → Affine Transforms: uses transforms
src/header.rs - Header Parser → NIfTI Types: validates codes
src/header.rs - Header Parser → Format Utilities: validates fields
src/header.rs - In-Memory Volume → Volume Shape: validates dimensions
src/volume/inmem.rs - In-Memory Volume → Voxel Elements: decodes voxels
src/volume/inmem.rs - In-Memory Volume → Header Parser: reads volume fields
src/volume/inmem.rs - Streamed Volume → Volume Shape: indexes slices
src/volume/streamed.rs - Streamed Volume → In-Memory Volume: produces slices
src/volume/streamed.rs - Volume API → In-Memory Volume: defines implementation
src/volume/mod.rs - Volume API → Streamed Volume: defines implementation
src/volume/mod.rs - ndarray Conversion → Volume API: converts volumes
src/volume/ndarray.rs - ndarray Conversion → Voxel Elements: converts elements
src/volume/ndarray.rs - NIfTI Types → Voxel Elements: rescales values
src/typedef.rs