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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
use std::path::Path;
use std::collections::HashMap;
use std::fmt::{Display, Debug};
use std::cmp::PartialOrd;
use failure::{err_msg, Error};
use image::{RgbaImage};
use num::{Num, ToPrimitive, Unsigned, Integer};
use num::zero;
use ::{
utils,
bindings,
properties,
};
#[derive(Clone)]
pub struct OpenSlide {
osr: *const bindings::OpenSlideT,
pub properties: properties::Properties,
}
impl Drop for OpenSlide {
fn drop(
&mut self
) {
bindings::close(self.osr);
}
}
impl OpenSlide {
pub fn new(
filename: &Path
) -> Result<OpenSlide, Error> {
if !filename.exists() {
return Err(err_msg(format!("Error: Nonexisting path: {}", filename.display())));
}
let osr = bindings::open(filename.to_str().ok_or(err_msg("Error: Path to &str"))?)?;
let mut property_map = HashMap::<String, String>::new();
for name in bindings::get_property_names(osr)? {
property_map.insert(name.clone(), bindings::get_property_value(osr, &name)?);
}
let properties = properties::Properties::new(&property_map);
Ok(OpenSlide {
osr: osr,
properties: properties,
})
}
pub fn get_level_count(
&self
) -> Result<u32, Error> {
let num_levels = bindings::get_level_count(self.osr)?;
if num_levels < -1 {
Err(err_msg(format!("Error: Number of levels is {}, this is an unknown error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation.", num_levels)))
} else if num_levels == -1 {
Err(err_msg("Error: Number of levels is -1, this is a known error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation."))
} else {
Ok(num_levels as u32)
}
}
pub fn get_level0_dimensions(
&self
) -> Result<(u64, u64), Error> {
let (width, height) = bindings::get_level0_dimensions(self.osr)?;
if width < -1 {
return Err(err_msg(format!("Error: Width is {}, this is an unknown error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation.", width)))
} else if width == -1 {
return Err(err_msg("Error: Width is -1, this is a known error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation."))
}
if height < -1 {
return Err(err_msg(format!("Error: Height is {}, this is an unknown error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation.", width)))
} else if height == -1 {
return Err(err_msg("Error: Height is -1, this is a known error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation."))
}
Ok((width as u64, height as u64))
}
pub fn get_level_dimensions<T: Integer + ToPrimitive + Debug + Display + Clone + Copy>(
&self,
level: T,
) -> Result<(u64, u64), Error> {
let max_num_levels = self.get_level_count()?;
if level.to_u32().ok_or(err_msg("Conversion to primitive error"))? > max_num_levels {
return Err(err_msg(format!("Error: Specified level {} is larger than the max slide level {}",
level, max_num_levels)));
}
let (width, height) = bindings::get_level_dimensions(self.osr, level.to_i32().ok_or(err_msg("Conversion to primitive error"))?)?;
if width < -1 {
return Err(err_msg(format!("Error: Width is {}, this is an unknown error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation.", width)))
} else if width == -1 {
return Err(err_msg("Error: Width is -1, this is a known error from openslide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation."))
}
if height < -1 {
return Err(err_msg(format!("Error: Height is {}, this is an unknown error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation.", width)))
} else if height == -1 {
return Err(err_msg("Error: Height is -1, this is a known error from openslide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation."))
}
Ok((width as u64, height as u64))
}
pub fn get_level_downsample<T: Integer + Unsigned + ToPrimitive + Debug + Display + Clone + Copy>(
&self,
level: T,
) -> Result<f64, Error> {
let max_num_levels = self.get_level_count()?;
if level.to_u32().ok_or(err_msg("Conversion to primitive error"))? > max_num_levels {
return Err(err_msg(format!("Error: Specified level {} is larger than the max slide level {}",
level, max_num_levels)));
}
let downsample_factor = bindings::get_level_downsample(self.osr, level.to_i32().ok_or(err_msg("Conversion to primitive error"))?)?;
if downsample_factor < 0.0 {
return Err(err_msg(format!("Error: Downsample factor is {}, this is an error from \
OpenSlide. OpenSlide returns -1.0 if an error occured. \
See OpenSlide C API documentation.", downsample_factor)))
}
Ok(downsample_factor)
}
pub fn get_best_level_for_downsample<T: Num + ToPrimitive + PartialOrd + Debug + Display + Clone + Copy>(
&self,
downsample_factor: T,
) -> Result<u32, Error> {
if downsample_factor < zero() {
return Err(err_msg(format!("Error: Only non-negative downsample factor is allowed. \
You specified {}. ", downsample_factor)))
}
let level = bindings::get_best_level_for_downsample(self.osr, downsample_factor.to_f64().ok_or(err_msg("Conversion to primitive error"))?)?;
if level < -1 {
Err(err_msg(format!("Error: Returned level is {}, this is an unknown error from OpenSlide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation.", level)))
} else if level == -1 {
Err(err_msg("Error: Returned level is -1, this is a known error from openslide. \
OpenSlide returns -1 if an error occured. \
See OpenSlide C API documentation."))
} else {
Ok(level as u32)
}
}
fn get_feasible_dimensions<T: Integer + Unsigned + ToPrimitive + Debug + Display + Clone + Copy>(
&self,
top_left_lvl0_row: T,
top_left_lvl0_col: T,
level: T,
height: T,
width: T,
) -> Result<(u64, u64), Error> {
let (max_width, max_height) = self.get_level_dimensions(level)?;
let downsample_factor = self.get_level_downsample(level)?;
let tl_row_this_lvl = top_left_lvl0_row.to_f64().ok_or(err_msg("Conversion to primitive error"))? /
downsample_factor;
let tl_col_this_lvl = top_left_lvl0_col.to_f64().ok_or(err_msg("Conversion to primitive error"))? /
downsample_factor;
let new_height = height.to_u64()
.ok_or(err_msg("conversion to primitive error"))?
.min(max_height - tl_row_this_lvl.round() as u64);
let new_width = width.to_u64()
.ok_or(err_msg("Conversion to primitive error"))?
.min(max_width - tl_col_this_lvl.round() as u64);
if new_height < height.to_u64().ok_or(err_msg("conversion to primitive error"))? {
println!("WARNING: Requested region height is changed from {} to {} in order to fit",
height, new_height);
}
if new_width < width.to_u64().ok_or(err_msg("conversion to primitive error"))? {
println!("WARNING: Requested region width is changed from {} to {} in order to fit",
width, new_width);
}
if new_height > max_height {
return Err(err_msg(format!("Requested height {} exceeds maximum {}", height, max_height)))
}
if new_width > max_width {
return Err(err_msg(format!("Requested width {} exceeds maximum {}", width, max_width)))
}
Ok((new_height, new_width))
}
pub fn read_region<T: Integer + Unsigned + ToPrimitive + Debug + Display + Clone + Copy>(
&self,
top_left_lvl0_row: T,
top_left_lvl0_col: T,
level: T,
height: T,
width: T,
) -> Result<RgbaImage, Error> {
let (height, width) = self.get_feasible_dimensions(top_left_lvl0_row,
top_left_lvl0_col,
level,
height,
width)?;
let buffer = bindings::read_region(self.osr,
top_left_lvl0_col.to_i64().ok_or(err_msg("Conversion to primitive error"))?,
top_left_lvl0_row.to_i64().ok_or(err_msg("Conversion to primitive error"))?,
level.to_i32().ok_or(err_msg("Conversion to primitive error"))?,
width.to_i64().ok_or(err_msg("Conversion to primitive error"))?,
height.to_i64().ok_or(err_msg("Conversion to primitive error"))?)?;
let word_repr = utils::WordRepresentation::BigEndian;
utils::decode_buffer(&buffer, height, width, word_repr)
}
pub fn get_properties(
&self
) -> Result<HashMap<String, String>, Error> {
let mut properties = HashMap::<String, String>::new();
for name in bindings::get_property_names(self.osr)? {
properties.insert(name.clone(), bindings::get_property_value(self.osr, &name)?);
}
Ok(properties)
}
}