Struct Nd2File 

pub struct Nd2File { /* private fields */ }

Main reader for ND2 files

Implementations

impl Nd2File

pub fn open_reader<R>(reader: R) -> Result<Self>

where R: Read + Seek + 'static,

Open an ND2 file from any Read + Seek source (e.g. in-memory buffer).

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open an ND2 file for reading from a local path.

Examples found in repository

examples/read_summary.rs (line 12)

fn main() -> Result<()> {
    let args: Vec<String> = std::env::args().collect();

    if args.len() < 2 {
        eprintln!("Usage: {} <path-to-nd2-file>", args[0]);
        std::process::exit(1);
    }

    let path = &args[1];
    let mut nd2 = Nd2File::open(path)?;

    println!("=== ND2 File Information ===");
    println!("Version: {:?}", nd2.version());

    let summary = nd2.summary()?;
    println!("Logical frames: {}", summary.logical_frame_count);
    println!("Sizes: {:?}", summary.sizes);
    println!("Channels: {:?}", summary.channels);

    let first_plane = nd2.read_frame_2d(0, 0, 0, 0)?;
    println!("First plane pixels: {}", first_plane.len());

    Ok(())
}

pub fn version(&self) -> (u32, u32)

Get the file format version (major, minor)

Examples found in repository

examples/read_summary.rs (line 15)

fn main() -> Result<()> {
    let args: Vec<String> = std::env::args().collect();

    if args.len() < 2 {
        eprintln!("Usage: {} <path-to-nd2-file>", args[0]);
        std::process::exit(1);
    }

    let path = &args[1];
    let mut nd2 = Nd2File::open(path)?;

    println!("=== ND2 File Information ===");
    println!("Version: {:?}", nd2.version());

    let summary = nd2.summary()?;
    println!("Logical frames: {}", summary.logical_frame_count);
    println!("Sizes: {:?}", summary.sizes);
    println!("Channels: {:?}", summary.channels);

    let first_plane = nd2.read_frame_2d(0, 0, 0, 0)?;
    println!("First plane pixels: {}", first_plane.len());

    Ok(())
}

pub fn summary(&mut self) -> Result<DatasetSummary>

Return a lightweight dataset overview aligned with other reader crates.

Examples found in repository

examples/read_summary.rs (line 17)

fn main() -> Result<()> {
    let args: Vec<String> = std::env::args().collect();

    if args.len() < 2 {
        eprintln!("Usage: {} <path-to-nd2-file>", args[0]);
        std::process::exit(1);
    }

    let path = &args[1];
    let mut nd2 = Nd2File::open(path)?;

    println!("=== ND2 File Information ===");
    println!("Version: {:?}", nd2.version());

    let summary = nd2.summary()?;
    println!("Logical frames: {}", summary.logical_frame_count);
    println!("Sizes: {:?}", summary.sizes);
    println!("Channels: {:?}", summary.channels);

    let first_plane = nd2.read_frame_2d(0, 0, 0, 0)?;
    println!("First plane pixels: {}", first_plane.len());

    Ok(())
}

pub fn read_frame(&mut self, index: usize) -> Result<Vec<u16>>

Read one frame by sequence index. Returns pixels as (C, Y, X) u16 data.

pub fn read_frame_2d( &mut self, p: usize, t: usize, c: usize, z: usize, ) -> Result<Vec<u16>>

Read 2D Y×X frame at (p,t,c,z). Returns the Y×X pixels for the requested channel.

Examples found in repository

examples/read_summary.rs (line 22)

fn main() -> Result<()> {
    let args: Vec<String> = std::env::args().collect();

    if args.len() < 2 {
        eprintln!("Usage: {} <path-to-nd2-file>", args[0]);
        std::process::exit(1);
    }

    let path = &args[1];
    let mut nd2 = Nd2File::open(path)?;

    println!("=== ND2 File Information ===");
    println!("Version: {:?}", nd2.version());

    let summary = nd2.summary()?;
    println!("Logical frames: {}", summary.logical_frame_count);
    println!("Sizes: {:?}", summary.sizes);
    println!("Channels: {:?}", summary.channels);

    let first_plane = nd2.read_frame_2d(0, 0, 0, 0)?;
    println!("First plane pixels: {}", first_plane.len());

    Ok(())
}

Trait Implementations

impl Drop for Nd2File

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.