nd2_rs/lib.rs
1//! nd2-rs: Pure Rust library for reading Nikon ND2 microscopy files
2//!
3//! This library provides functionality to read metadata from modern ND2 files
4//! (versions 2.0, 2.1, and 3.0) created by Nikon NIS Elements software.
5//!
6//! # Example
7//! ```no_run
8//! use nd2_rs::Nd2File;
9//!
10//! fn main() -> nd2_rs::Result<()> {
11//! let mut nd2 = Nd2File::open("image.nd2")?;
12//!
13//! println!("Version: {:?}", nd2.version());
14//! println!("Summary: {:#?}", nd2.summary()?);
15//!
16//! Ok(())
17//! }
18//! ```
19
20mod error;
21mod io;
22mod types;
23
24mod chunk;
25mod constants;
26#[path = "metadata/mod.rs"]
27mod meta_parse;
28mod parse;
29mod reader;
30
31pub use error::{Nd2Error, Result};
32pub use io::ReadSeek;
33pub use reader::Nd2File;
34pub use types::{DatasetSummary, SummaryChannel, SummaryScaling};