Struct OpenSlide

pub struct OpenSlide {
    pub properties: Properties,
    /* private fields */
}

Openslide object is a simple wrapper around openslide_t “C” type. Implementation provides all functions available in the “C” API It contains also openslide and vendor specific properties found in WSI.

Note : As stated by the OpenSlide documentation, all function are thread-safe except close() For this reason OpenSlide implement the Drop trait which call close() automatically

Fields

properties: Properties

Implementations

impl OpenSlide

pub fn get_version() -> Result<String>

Get the version of the OpenSlide library.

pub fn new<T: AsRef<Path>>(path: T) -> Result<OpenSlide>

This method tries to open the slide at the given filename location.

This function can be expensive; avoid calling it unnecessarily. For example, a tile server should not create a new object on every tile request. Instead, it should maintain a cache of OpenSlide objects and reuse them when possible.

pub fn detect_vendor(path: &Path) -> Result<String>

Quickly determine whether a whole slide image is recognized.

pub fn properties(&self) -> &Properties

pub fn get_level_count(&self) -> Result<u32>

Get the number of levels in the whole slide image.

pub fn get_level_dimensions(&self, level: u32) -> Result<Size>

Get the dimensions of level 0 (the largest level).

This method returns the Size { width, height } number of pixels of the whole slide image at the specified level. Returns an error if the level is invalid

pub fn get_all_level_dimensions(&self) -> Result<Vec<Size>>

Get dimensions of all available levels

pub fn get_level_downsample(&self, level: u32) -> Result<f64>

Get the downsampling factor of a given level.

pub fn get_all_level_downsample(&self) -> Result<Vec<f64>>

Get all downsampling factors for all available levels.

pub fn get_best_level_for_downsample(&self, downsample: f64) -> Result<u32>

Get the best level to use for displaying the given downsample factor.

pub fn get_property_names(&self) -> Vec<String>

Get the list of all available properties.

pub fn get_property_value(&self, name: &str) -> Result<String>

Get the value of a single property.

pub fn read_region(&self, region: &Region) -> Result<Vec<u8>>

Copy pre-multiplied ARGB data from a whole slide image.

This function reads and decompresses a region of a whole slide image into a Vec

Args: offset: (x, y) coordinate (increasing downwards/to the right) of top left pixel position level: At which level to grab the region from size: (width, height) in pixels of the outputted region

Size of output Vec is Width * Height * 4 (RGBA pixels)

pub fn get_associated_image_names(&self) -> Result<Vec<String>>

Get the list name of all available associated image.

pub fn read_associated_buffer(&self, name: &str) -> Result<(Size, Vec<u8>)>

Copy pre-multiplied ARGB data from a whole slide image.

This function reads and decompresses an associated image into an Vec

Args: name: name of the associated image we want to read

Size of output Vec is width * height * 4 (RGBA pixels)

pub fn get_associated_image_dimensions(&self, name: &str) -> Result<Size>

Get the size of an associated image

pub fn read_image_rgba(&self, region: &Region) -> Result<RgbaImage>

Copy pre-multiplied ARGB data from a whole slide image.

This function reads and decompresses a region of a whole slide image into an RgbImage

Args: offset: (x, y) coordinate (increasing downwards/to the right) of top left pixel position level: At which level to grab the region from size: (width, height) in pixels of the outputted region

pub fn read_image_rgb(&self, region: &Region) -> Result<RgbImage>

Copy pre-multiplied ARGB data from from an associated image..

This function reads and decompresses a region of a whole slide image into an RgbaImage

Args: offset: (x, y) coordinate (increasing downwards/to the right) of top left pixel position level: At which level to grab the region from size: (width, height) in pixels of the outputted region

pub fn read_associated_image_rgba(&self, name: &str) -> Result<RgbaImage>

Copy pre-multiplied ARGB data from an associated image.

This function reads and decompresses an associated image into an RgbaImage

Args: name: name of the associated image we want to read

pub fn read_associated_image_rgb(&self, name: &str) -> Result<RgbImage>

Copy pre-multiplied ARGB data from an associated image.

This function reads and decompresses an associated image into an RgbaImage

Args: name: name of the associated image we want to read

pub fn thumbnail_rgba(&self, size: &Size) -> Result<RgbaImage>

Get a RGBA image thumbnail of desired size of the whole slide image. Args: size: (width, height) in pixels of the thumbnail

pub fn thumbnail_rgb(&self, size: &Size) -> Result<RgbImage>

Get a RGB image thumbnail of desired size of the whole slide image. Args: size: (width, height) in pixels of the thumbnail

Trait Implementations

impl Debug for OpenSlide

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

Formats the value using the given formatter.

impl Drop for OpenSlide

fn drop(&mut self)

Executes the destructor for this type.

impl Slide for OpenSlide

fn get_bounds(&self) -> Bounds

Get properties of the whole slide image through Properties struct.

fn get_level_count(&self) -> Result<u32>

Get the number of levels in the whole slide image.

fn get_level_dimensions(&self, level: u32) -> Result<Size>

Get the dimensions of level 0 (the largest level).

fn get_level_downsample(&self, level: u32) -> Result<f64>

Get the downsampling factor of a given level.

fn get_best_level_for_downsample(&self, downsample: f64) -> Result<u32>

Get the best level to use for displaying the given downsample factor.

fn read_image_rgba(&self, region: &Region) -> Result<RgbaImage>

Copy pre-multiplied ARGB data from a whole slide image.

fn read_image_rgb(&self, region: &Region) -> Result<RgbImage>

Copy pre-multiplied ARGB data from an associated image.