imgal 0.3.1

A fast and open-source scientific image processing and algorithm library.
Documentation 
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

use ndarray::arr2;

use imgal::prelude::*;
use imgal::simulation::blob::gaussian_metaballs;
use imgal::transform::pad::{constant_pad, reflect_pad, zero_pad};

const TOLERANCE: f64 = 1e-10;
const CENTER_2D: [[f64; 2]; 1] = [[25.0, 25.0]];
const CENTER_3D: [[f64; 3]; 1] = [[5.0, 25.0, 25.0]];
const RADIUS: [f64; 1] = [20.0];
const INTENSITY: [f64; 1] = [10.0];
const FALLOFF: [f64; 1] = [2.0];
const BACKGROUND: f64 = 0.0;
const SHAPE_2D: [usize; 2] = [50, 50];
const SHAPE_3D: [usize; 3] = [10, 50, 50];
const PAD_CONFIG_2D: [usize; 2] = [5, 5];
const PAD_CONFIG_3D: [usize; 3] = [5, 5, 5];
const THREADS: Option<usize> = Some(0);

fn approx_equal(a: f64, b: f64) -> bool {
    (a - b).abs() < TOLERANCE
}

/// Tests that `constant_pad` returns the expected constant value padded array
/// (2D and 3D) by checking the center for the maximum value and padded regions
/// for the constant value.
#[test]
fn pad_constant_pad_expected_results() -> Result<(), ImgalError> {
    let data_2d = gaussian_metaballs(
        &arr2(&CENTER_2D),
        &RADIUS,
        &INTENSITY,
        &FALLOFF,
        BACKGROUND,
        &SHAPE_2D,
        None,
    )?;
    let data_3d = gaussian_metaballs(
        &arr2(&CENTER_3D),
        &RADIUS,
        &INTENSITY,
        &FALLOFF,
        BACKGROUND,
        &SHAPE_3D,
        None,
    )?;
    let pad_2d_right_par = constant_pad(&data_2d, 3.2, &PAD_CONFIG_2D, Some(0), THREADS)?;
    let pad_3d_right_par = constant_pad(&data_3d, 3.2, &PAD_CONFIG_3D, Some(0), THREADS)?;
    let pad_2d_right_seq = constant_pad(&data_2d, 3.2, &PAD_CONFIG_2D, Some(0), None)?;
    let pad_3d_right_seq = constant_pad(&data_3d, 3.2, &PAD_CONFIG_3D, Some(0), None)?;
    let pad_2d_left_par = constant_pad(&data_2d, 3.2, &PAD_CONFIG_2D, Some(1), THREADS)?;
    let pad_3d_left_par = constant_pad(&data_3d, 3.2, &PAD_CONFIG_3D, Some(1), THREADS)?;
    let pad_2d_left_seq = constant_pad(&data_2d, 3.2, &PAD_CONFIG_2D, Some(1), None)?;
    let pad_3d_left_seq = constant_pad(&data_3d, 3.2, &PAD_CONFIG_3D, Some(1), None)?;
    let pad_2d_sym_par = constant_pad(&data_2d, 3.2, &PAD_CONFIG_2D, Some(2), THREADS)?;
    let pad_3d_sym_par = constant_pad(&data_3d, 3.2, &PAD_CONFIG_3D, Some(2), THREADS)?;
    let pad_2d_sym_seq = constant_pad(&data_2d, 3.2, &PAD_CONFIG_2D, Some(2), None)?;
    let pad_3d_sym_seq = constant_pad(&data_3d, 3.2, &PAD_CONFIG_3D, Some(2), None)?;
    assert_eq!(pad_2d_right_par.shape(), &[55, 55]);
    assert_eq!(pad_3d_right_par.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_right_seq.shape(), &[55, 55]);
    assert_eq!(pad_3d_right_seq.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_left_par.shape(), &[55, 55]);
    assert_eq!(pad_3d_left_par.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_left_seq.shape(), &[55, 55]);
    assert_eq!(pad_3d_left_seq.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_sym_par.shape(), &[60, 60]);
    assert_eq!(pad_3d_sym_par.shape(), &[20, 60, 60]);
    assert_eq!(pad_2d_sym_seq.shape(), &[60, 60]);
    assert_eq!(pad_3d_sym_seq.shape(), &[20, 60, 60]);
    // check the center
    assert_eq!(pad_2d_right_par[[25, 25]], 10.0);
    assert_eq!(pad_3d_right_par[[5, 25, 25]], 10.0);
    assert_eq!(pad_2d_right_seq[[25, 25]], 10.0);
    assert_eq!(pad_3d_right_seq[[5, 25, 25]], 10.0);
    assert_eq!(pad_2d_left_par[[30, 30]], 10.0);
    assert_eq!(pad_3d_left_par[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_left_seq[[30, 30]], 10.0);
    assert_eq!(pad_3d_left_seq[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_sym_par[[30, 30]], 10.0);
    assert_eq!(pad_3d_sym_par[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_sym_seq[[30, 30]], 10.0);
    assert_eq!(pad_3d_sym_seq[[10, 30, 30]], 10.0);
    // check right padding
    assert_eq!(pad_2d_right_par[[10, 53]], 3.2);
    assert_eq!(pad_3d_right_par[[7, 10, 53]], 3.2);
    assert_eq!(pad_2d_right_seq[[10, 53]], 3.2);
    assert_eq!(pad_3d_right_seq[[7, 10, 53]], 3.2);
    // check left padding
    assert_eq!(pad_2d_left_par[[10, 3]], 3.2);
    assert_eq!(pad_3d_left_par[[7, 10, 3]], 3.2);
    assert_eq!(pad_2d_left_seq[[10, 3]], 3.2);
    assert_eq!(pad_3d_left_seq[[7, 10, 3]], 3.2);
    // check symmetrical
    assert_eq!(pad_2d_sym_par[[10, 3]], 3.2);
    assert_eq!(pad_3d_sym_par[[7, 10, 3]], 3.2);
    assert_eq!(pad_2d_sym_seq[[10, 3]], 3.2);
    assert_eq!(pad_3d_sym_seq[[7, 10, 3]], 3.2);
    assert_eq!(pad_2d_sym_par[[10, 58]], 3.2);
    assert_eq!(pad_3d_sym_par[[7, 10, 58]], 3.2);
    assert_eq!(pad_2d_sym_seq[[10, 58]], 3.2);
    assert_eq!(pad_3d_sym_seq[[7, 10, 58]], 3.2);
    Ok(())
}

/// Tests that `reflect_pad` returns the expected reflected value padded array
/// (2D and 3D) by checking the center for the maximum value and padded regions
/// for the reflected value.
#[test]
fn pad_reflect_pad_expected_results() -> Result<(), ImgalError> {
    let data_2d = gaussian_metaballs(
        &arr2(&CENTER_2D),
        &RADIUS,
        &INTENSITY,
        &FALLOFF,
        BACKGROUND,
        &SHAPE_2D,
        None,
    )?;
    let data_3d = gaussian_metaballs(
        &arr2(&CENTER_3D),
        &RADIUS,
        &INTENSITY,
        &FALLOFF,
        BACKGROUND,
        &SHAPE_3D,
        None,
    )?;
    let pad_2d_right_par = reflect_pad(&data_2d, &PAD_CONFIG_2D, Some(0), THREADS)?;
    let pad_3d_right_par = reflect_pad(&data_3d, &PAD_CONFIG_3D, Some(0), THREADS)?;
    let pad_2d_right_seq = reflect_pad(&data_2d, &PAD_CONFIG_2D, Some(0), None)?;
    let pad_3d_right_seq = reflect_pad(&data_3d, &PAD_CONFIG_3D, Some(0), None)?;
    let pad_2d_left_par = reflect_pad(&data_2d, &PAD_CONFIG_2D, Some(1), THREADS)?;
    let pad_3d_left_par = reflect_pad(&data_3d, &PAD_CONFIG_3D, Some(1), THREADS)?;
    let pad_2d_left_seq = reflect_pad(&data_2d, &PAD_CONFIG_2D, Some(1), None)?;
    let pad_3d_left_seq = reflect_pad(&data_3d, &PAD_CONFIG_3D, Some(1), None)?;
    let pad_2d_sym_par = reflect_pad(&data_2d, &PAD_CONFIG_2D, Some(2), THREADS)?;
    let pad_3d_sym_par = reflect_pad(&data_3d, &PAD_CONFIG_3D, Some(2), THREADS)?;
    let pad_2d_sym_seq = reflect_pad(&data_2d, &PAD_CONFIG_2D, Some(2), None)?;
    let pad_3d_sym_seq = reflect_pad(&data_3d, &PAD_CONFIG_3D, Some(2), None)?;
    assert_eq!(pad_2d_right_par.shape(), &[55, 55]);
    assert_eq!(pad_3d_right_par.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_right_seq.shape(), &[55, 55]);
    assert_eq!(pad_3d_right_seq.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_left_par.shape(), &[55, 55]);
    assert_eq!(pad_3d_left_par.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_left_seq.shape(), &[55, 55]);
    assert_eq!(pad_3d_left_seq.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_sym_par.shape(), &[60, 60]);
    assert_eq!(pad_3d_sym_par.shape(), &[20, 60, 60]);
    assert_eq!(pad_2d_sym_seq.shape(), &[60, 60]);
    assert_eq!(pad_3d_sym_seq.shape(), &[20, 60, 60]);
    // check the center
    assert_eq!(pad_2d_right_par[[25, 25]], 10.0);
    assert_eq!(pad_3d_right_par[[5, 25, 25]], 10.0);
    assert_eq!(pad_2d_right_seq[[25, 25]], 10.0);
    assert_eq!(pad_3d_right_seq[[5, 25, 25]], 10.0);
    assert_eq!(pad_2d_left_par[[30, 30]], 10.0);
    assert_eq!(pad_3d_left_par[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_left_seq[[30, 30]], 10.0);
    assert_eq!(pad_3d_left_seq[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_sym_par[[30, 30]], 10.0);
    assert_eq!(pad_3d_sym_par[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_sym_seq[[30, 30]], 10.0);
    assert_eq!(pad_3d_sym_seq[[10, 30, 30]], 10.0);
    // check right padding
    assert!(approx_equal(pad_2d_right_par[[10, 53]], 4.5783336177));
    assert!(approx_equal(pad_3d_right_par[[7, 10, 53]], 4.5554990835));
    assert!(approx_equal(pad_2d_right_seq[[10, 53]], 4.5783336177));
    assert!(approx_equal(pad_3d_right_seq[[7, 10, 53]], 4.5554990835));
    // check left padding
    assert!(approx_equal(pad_2d_left_par[[10, 3]], 3.1309456796));
    assert!(approx_equal(pad_3d_left_par[[7, 10, 3]], 3.09591993));
    assert!(approx_equal(pad_2d_left_seq[[10, 3]], 3.1309456796));
    assert!(approx_equal(pad_3d_left_seq[[7, 10, 3]], 3.09591993));
    // check symmetrical
    assert!(approx_equal(pad_2d_sym_par[[10, 3]], 3.1309456796));
    assert!(approx_equal(pad_3d_sym_par[[7, 10, 3]], 3.09591993));
    assert!(approx_equal(pad_2d_sym_seq[[10, 3]], 3.1309456796));
    assert!(approx_equal(pad_3d_sym_seq[[7, 10, 3]], 3.09591993));
    assert!(approx_equal(pad_2d_sym_par[[10, 58]], 3.6787944117));
    assert!(approx_equal(pad_3d_sym_par[[7, 10, 58]], 3.6376399027));
    assert!(approx_equal(pad_2d_sym_seq[[10, 58]], 3.6787944117));
    assert!(approx_equal(pad_3d_sym_seq[[7, 10, 58]], 3.6376399027));
    Ok(())
}

/// Tests that `zero_pad` returns the expected zero padded array (2D and 3D) by
/// checking the center for the maximum value and padded regions for the zero
/// value.
#[test]
fn pad_zero_pad_expected_results() -> Result<(), ImgalError> {
    let data_2d = gaussian_metaballs(
        &arr2(&CENTER_2D),
        &RADIUS,
        &INTENSITY,
        &FALLOFF,
        BACKGROUND,
        &SHAPE_2D,
        None,
    )?;
    let data_3d = gaussian_metaballs(
        &arr2(&CENTER_3D),
        &RADIUS,
        &INTENSITY,
        &FALLOFF,
        BACKGROUND,
        &SHAPE_3D,
        None,
    )?;
    let pad_2d_right_par = zero_pad(&data_2d, &PAD_CONFIG_2D, Some(0), THREADS)?;
    let pad_3d_right_par = zero_pad(&data_3d, &PAD_CONFIG_3D, Some(0), THREADS)?;
    let pad_2d_right_seq = zero_pad(&data_2d, &PAD_CONFIG_2D, Some(0), None)?;
    let pad_3d_right_seq = zero_pad(&data_3d, &PAD_CONFIG_3D, Some(0), None)?;
    let pad_2d_left_par = zero_pad(&data_2d, &PAD_CONFIG_2D, Some(1), THREADS)?;
    let pad_3d_left_par = zero_pad(&data_3d, &PAD_CONFIG_3D, Some(1), THREADS)?;
    let pad_2d_left_seq = zero_pad(&data_2d, &PAD_CONFIG_2D, Some(1), None)?;
    let pad_3d_left_seq = zero_pad(&data_3d, &PAD_CONFIG_3D, Some(1), None)?;
    let pad_2d_sym_par = zero_pad(&data_2d, &PAD_CONFIG_2D, Some(2), THREADS)?;
    let pad_3d_sym_par = zero_pad(&data_3d, &PAD_CONFIG_3D, Some(2), THREADS)?;
    let pad_2d_sym_seq = zero_pad(&data_2d, &PAD_CONFIG_2D, Some(2), None)?;
    let pad_3d_sym_seq = zero_pad(&data_3d, &PAD_CONFIG_3D, Some(2), None)?;
    assert_eq!(pad_2d_right_par.shape(), &[55, 55]);
    assert_eq!(pad_3d_right_par.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_right_seq.shape(), &[55, 55]);
    assert_eq!(pad_3d_right_seq.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_left_par.shape(), &[55, 55]);
    assert_eq!(pad_3d_left_par.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_left_seq.shape(), &[55, 55]);
    assert_eq!(pad_3d_left_seq.shape(), &[15, 55, 55]);
    assert_eq!(pad_2d_sym_par.shape(), &[60, 60]);
    assert_eq!(pad_3d_sym_par.shape(), &[20, 60, 60]);
    assert_eq!(pad_2d_sym_seq.shape(), &[60, 60]);
    assert_eq!(pad_3d_sym_seq.shape(), &[20, 60, 60]);
    // check the center
    assert_eq!(pad_2d_right_par[[25, 25]], 10.0);
    assert_eq!(pad_3d_right_par[[5, 25, 25]], 10.0);
    assert_eq!(pad_2d_right_seq[[25, 25]], 10.0);
    assert_eq!(pad_3d_right_seq[[5, 25, 25]], 10.0);
    assert_eq!(pad_2d_left_par[[30, 30]], 10.0);
    assert_eq!(pad_3d_left_par[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_left_seq[[30, 30]], 10.0);
    assert_eq!(pad_3d_left_seq[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_sym_par[[30, 30]], 10.0);
    assert_eq!(pad_3d_sym_par[[10, 30, 30]], 10.0);
    assert_eq!(pad_2d_sym_seq[[30, 30]], 10.0);
    assert_eq!(pad_3d_sym_seq[[10, 30, 30]], 10.0);
    // check right padding
    assert_eq!(pad_2d_right_par[[10, 53]], 0.0);
    assert_eq!(pad_3d_right_par[[7, 10, 53]], 0.0);
    assert_eq!(pad_2d_right_seq[[10, 53]], 0.0);
    assert_eq!(pad_3d_right_seq[[7, 10, 53]], 0.0);
    // check left padding
    assert_eq!(pad_2d_left_par[[10, 3]], 0.0);
    assert_eq!(pad_3d_left_par[[7, 10, 3]], 0.0);
    assert_eq!(pad_2d_left_seq[[10, 3]], 0.0);
    assert_eq!(pad_3d_left_seq[[7, 10, 3]], 0.0);
    // check symmetrical
    assert_eq!(pad_2d_sym_par[[10, 3]], 0.0);
    assert_eq!(pad_3d_sym_par[[7, 10, 3]], 0.0);
    assert_eq!(pad_2d_sym_seq[[10, 3]], 0.0);
    assert_eq!(pad_3d_sym_seq[[7, 10, 3]], 0.0);
    assert_eq!(pad_2d_sym_par[[10, 58]], 0.0);
    assert_eq!(pad_3d_sym_par[[7, 10, 58]], 0.0);
    assert_eq!(pad_2d_sym_seq[[10, 58]], 0.0);
    assert_eq!(pad_3d_sym_seq[[7, 10, 58]], 0.0);
    Ok(())
}