Struct Slide 

pub struct Slide { /* private fields */ }

Represents a single WSI, along with its metadata.

Implementations

impl Slide

pub fn open(path: impl AsRef<Path>) -> Result<Self, WsiError>

Opens a WSI from the specified path and returns a corresponding Slide instance.

Arguments

• path - Path to the WSI file.

Returns

A Result containing a Slide instance on success, or a WsiError on failure.

Errors

Returns WsiError if the file cannot be opened or the metadata cannot be read.

pub fn path(&self) -> &PathBuf

Returns the path of the WSI.

pub fn metadata(&self) -> &Metadata

Returns a reference to the metadata associated with the WSI.

pub fn level_count(&self) -> usize

Returns the number of pyramid levels in the WSI.

pub fn read_tile_raw( &self, level_idx: usize, tile_x: u32, tile_y: u32, ) -> Result<Vec<u8>, WsiError>

Reads and returns the raw tile bytes at the specified level and coordinates.

Given a level index and tile coordinates (tile_x, tile_y), this function retrieves the corresponding tile bytes from the WSI.

Arguments

• level_idx - The index of the pyramid level.
• tile_x - The x-coordinate of the tile.
• tile_y - The y-coordinate of the tile.

Returns

A Result containing a vector of bytes representing the tile on success, or a WsiError on failure.

Errors

Returns WsiError::LevelIndexOutOfBounds if the specified level index is invalid.

pub fn decode_tile( &self, level_idx: usize, tile_x: u32, tile_y: u32, ) -> Result<Tile, WsiError>

Reads the raw tile bytes at the specified level and coordinates and decodes them into a Tile.

Given a level index and tile coordinates (tile_x, tile_y), this function retrieves the corresponding tile bytes from the WSI, decodes them and returns them in the form of a loaded Tile. This function should preferably be used over read_tile

Arguments

• level_idx - The index of the pyramid level.
• tile_x - The x-coordinate of the tile.
• tile_y - The y-coordinate of the tile.

Returns

A Result containing a Tile representing the tile on success, or a WsiError on failure.

Errors

Returns WsiError::LevelIndexOutOfBounds if the specified level index is invalid.

pub fn tile_coords( &self, level_idx: usize, ) -> Result<impl Iterator<Item = (u32, u32)> + '_, WsiError>

Returns an iterator over the tile coordinates (tile_x, tile_y) for the specified level. The iterator yields tuples of (tile_x, tile_y) for each tile in the specified level, in row-major order.

Arguments

• level_idx - The index of the pyramid level.

Returns

A Result containing an iterator over tile coordinates on success, or a WsiError on failure.

pub fn tiles( &self, level_idx: usize, ) -> Result<impl Iterator<Item = Result<Tile, WsiError>> + '_, WsiError>

Decodes every tile at level_idx and passes each to f, according to options.

pub fn extract<F>( &self, options: &ExtractionOptions, outputs: &SlideOutputs, f: F, ) -> Result<(), WsiError>

where F: Fn(Tile) -> Result<(), WsiError> + Sync,

Decodes every tile at level_idx and passes each to f, according to options.

f must be safe to call concurrently: Parallelism::Parallel invokes it from multiple worker threads at once.

Errors

Returns WsiError::LevelIndexOutOfBounds if the specified level index is invalid, or WsiError::ThreadPool if a dedicated thread pool could not be built for Parallelism::Parallel with an explicit thread count.

pub fn build_overview_image(&self) -> Result<DynamicImage, WsiError>

Stitches lowest-resolution pyramid level into a single image for use as a thumbnail.

Trait Implementations

impl Debug for Slide

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.