1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

#[macro_use]
extern crate lazy_static;

use crate::properties::Properties;

#[cfg(feature = "deepzoom")]
use crate::traits::Slide;

mod bindings;
#[cfg(feature = "deepzoom")]
pub mod deepzoom;
pub mod errors;
pub mod properties;
pub mod traits;
mod utils;
mod wrapper;

/// The corresponding result type used by the crate.
pub type Result<T, E = errors::OpenSlideError> = std::result::Result<T, E>;

/// 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
#[derive(Debug)]
pub struct OpenSlide {
    osr: bindings::OpenSlideWrapper,
    pub properties: Properties,
}

/// Generates Deep Zoom tiles and metadata.
#[cfg(feature = "deepzoom")]
#[derive(Debug)]
pub struct DeepZoomGenerator<'a, T: Slide> {
    slide: &'a T,

    level_count: usize,
    level_tiles: Vec<Size>,
    level_dimensions: Vec<Size>,

    tile_size: u32,
    overlap: u32,

    l0_offset: Address,
    slide_level_dimensions: Vec<Size>,
    slide_from_dz_level: Vec<u32>,
    l0_l_downsamples: Vec<f64>,
    l_z_downsamples: Vec<f64>,
}

/// Region struct
/// Used to retrieve a tile in a WSI
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Region {
    pub size: Size,
    pub level: u32,
    pub address: Address,
}

/// Simple Size struct
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Size {
    pub w: u32,
    pub h: u32,
}

/// Simple Address struct
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Address {
    pub x: u32,
    pub y: u32,
}