nereids_io/lib.rs
1//! # nereids-io
2//!
3//! Data I/O for VENUS beamline neutron imaging data.
4//!
5//! ## Modules
6//! - `daslogs` — DASlogs run-health summary (pause/beam-dip fractions;
7//! `hdf5` feature)
8//! - [`error`] — Error types for I/O operations
9//! - [`export`] — Export spatial mapping results to TIFF, HDF5, and Markdown
10//! - `nexus` — NeXus/HDF5 reading for rustpix-processed data (`hdf5` feature;
11//! not an intra-doc link so default-feature doc builds stay warning-free)
12//! - [`normalization`] — Raw + open beam → transmission (Method 2), dead/hot pixel masks (pipeline-integrity), ROI
13//! - `project` — Project file save/load for `.nrd.h5` archives (`hdf5` feature)
14//! - [`rebin`] — Energy rebinning (coarsen the TOF/energy axis by an integer factor)
15//! - `runlog` — DASlogs transition logs → beam-state intervals for event
16//! filtering (`hdf5` feature; not an intra-doc link so default-feature
17//! doc builds stay warning-free)
18//! - [`spectrum`] — Spectrum file parser for TOF/energy bin edges or centers
19//! - [`tiff_stack`] — Multi-frame TIFF stack loading → 3D arrays (tof, y, x)
20//! - [`tof`] — TOF bin edges → energy conversion for imaging data
21//!
22//! ## PLEIADES Reference
23//! - `pleiades/processing/normalization_ornl.py` for Method 2 normalization
24//! - `pleiades/processing/helper_ornl.py` for data loading
25
26#[cfg(feature = "hdf5")]
27pub mod daslogs;
28pub mod error;
29pub mod export;
30#[cfg(feature = "hdf5")]
31pub mod nexus;
32pub mod normalization;
33#[cfg(feature = "hdf5")]
34pub mod project;
35pub mod rebin;
36#[cfg(feature = "hdf5")]
37pub mod runlog;
38pub mod spectrum;
39pub mod tiff_stack;
40pub mod tof;