deconvolution 0.2.0

Rust image deconvolution and restoration 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
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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
use deconvolution::otf::convert::{otf2psf, otf2psf_3d, psf2otf, psf2otf_3d};
use deconvolution::otf::spectra::{defocus_otf, koehler_otf};
use deconvolution::psf::basic::{
    box2d, box3d, defocus, delta2d, delta3d, disk, gaussian2d, gaussian3d, motion_linear,
    oriented_gaussian, pillbox,
};
use deconvolution::psf::init::{from_support, gaussian_guess, motion_guess, uniform};
use deconvolution::psf::microscopy::{
    BornWolfParams, GibsonLanniParams, RichardsWolfParams, VariableRiGibsonLanniParams, astigmatic,
    born_wolf, double_helix, gibson_lanni, lorentz2d, richards_wolf, variable_ri_gibson_lanni,
};
use deconvolution::psf::support::{
    center, center_3d, crop_to, crop_to_3d, flip, flip_3d, normalize, normalize_3d, pad_to,
    pad_to_3d, support_mask, support_mask_3d, validate, validate_3d,
};
use deconvolution::simulate::blur::{blur, blur_otf};
use deconvolution::simulate::phantom::checkerboard_2d;
use deconvolution::{
    Error, Kernel2D, Kernel3D, Transfer2D, Transfer3D,
    prelude::{Kernel2D as PreludeKernel2D, Transfer2D as PreludeTransfer2D},
    psf::{Blur2D, Blur3D},
};
use ndarray::{Array2, array};
use num_complex::Complex32;

#[test]
fn valid_construction_succeeds() {
    let kernel2 = Kernel2D::new(array![[0.25_f32, 0.25_f32], [0.25_f32, 0.25_f32]]).unwrap();
    let kernel3 = Kernel3D::new(array![[[1.0_f32, 2.0_f32], [3.0_f32, 4.0_f32]]]).unwrap();
    let transfer2 = Transfer2D::new(array![
        [Complex32::new(1.0, 0.0), Complex32::new(0.0, 1.0)],
        [Complex32::new(2.0, -1.0), Complex32::new(0.5, 0.5)]
    ])
    .unwrap();
    let transfer3 = Transfer3D::new(array![[[
        Complex32::new(1.0, 0.0),
        Complex32::new(0.5, -0.5)
    ]]])
    .unwrap();

    assert_eq!(kernel2.dims(), (2, 2));
    assert_eq!(kernel3.dims(), (1, 2, 2));
    assert_eq!(transfer2.dims(), (2, 2));
    assert_eq!(transfer3.dims(), (1, 1, 2));

    let _prelude_kernel: PreludeKernel2D = kernel2;
    let _prelude_transfer: PreludeTransfer2D = transfer2;
}

#[test]
fn non_finite_input_is_rejected() {
    let kernel2_err = Kernel2D::new(array![[1.0_f32, f32::NAN]]).unwrap_err();
    let kernel3_err = Kernel3D::new(array![[[1.0_f32, f32::INFINITY]]]).unwrap_err();
    let transfer2_err = Transfer2D::new(array![[
        Complex32::new(f32::NAN, 0.0),
        Complex32::new(1.0, 0.0)
    ]])
    .unwrap_err();
    let transfer3_err =
        Transfer3D::new(array![[[Complex32::new(0.0, f32::INFINITY)]]]).unwrap_err();

    assert_eq!(kernel2_err, Error::NonFiniteInput);
    assert_eq!(kernel3_err, Error::NonFiniteInput);
    assert_eq!(transfer2_err, Error::NonFiniteInput);
    assert_eq!(transfer3_err, Error::NonFiniteInput);
}

#[test]
fn sums_dims_and_normalization_are_reported() {
    let kernel2 = Kernel2D::new(array![[1.0_f32, 2.0_f32], [3.0_f32, 4.0_f32]]).unwrap();
    let kernel3 = Kernel3D::new(array![[[1.0_f32, 1.0_f32], [2.0_f32, 2.0_f32]]]).unwrap();

    assert_eq!(kernel2.dims(), (2, 2));
    assert_eq!(kernel3.dims(), (1, 2, 2));
    assert!((kernel2.sum() - 10.0).abs() < 1e-6);
    assert!((kernel3.sum() - 6.0).abs() < 1e-6);
    assert!(kernel2.is_finite());
    assert!(kernel3.is_finite());

    let normalized_kernel2 = kernel2.normalized().unwrap();
    let normalized_kernel3 = kernel3.normalized().unwrap();
    assert!((normalized_kernel2.sum() - 1.0).abs() < 1e-6);
    assert!((normalized_kernel3.sum() - 1.0).abs() < 1e-6);

    let transfer2 = Transfer2D::new(array![
        [Complex32::new(2.0, 0.0), Complex32::new(1.0, -1.0)],
        [Complex32::new(0.0, 1.0), Complex32::new(1.0, 0.0)]
    ])
    .unwrap();
    let transfer3 = Transfer3D::new(array![[[
        Complex32::new(2.0, 0.0),
        Complex32::new(1.0, 1.0),
        Complex32::new(1.0, -1.0)
    ]]])
    .unwrap();

    assert_eq!(transfer2.dims(), (2, 2));
    assert_eq!(transfer3.dims(), (1, 1, 3));
    assert!(transfer2.is_finite());
    assert!(transfer3.is_finite());
    assert!((transfer2.sum() - Complex32::new(4.0, 0.0)).norm() < 1e-6);
    assert!((transfer3.sum() - Complex32::new(4.0, 0.0)).norm() < 1e-6);

    let normalized_transfer2 = transfer2.normalized().unwrap();
    let normalized_transfer3 = transfer3.normalized().unwrap();
    assert!((normalized_transfer2.sum() - Complex32::new(1.0, 0.0)).norm() < 1e-6);
    assert!((normalized_transfer3.sum() - Complex32::new(1.0, 0.0)).norm() < 1e-6);
}

#[test]
fn blur_wrappers_are_lightweight_references() {
    let kernel2 = Kernel2D::new(array![[1.0_f32]]).unwrap();
    let transfer2 = Transfer2D::new(array![[Complex32::new(1.0, 0.0)]]).unwrap();
    let kernel3 = Kernel3D::new(array![[[1.0_f32]]]).unwrap();
    let transfer3 = Transfer3D::new(array![[[Complex32::new(1.0, 0.0)]]]).unwrap();

    let blur2_psf = Blur2D::Psf(&kernel2);
    let blur2_otf = Blur2D::Otf(&transfer2);
    let blur3_psf = Blur3D::Psf(&kernel3);
    let blur3_otf = Blur3D::Otf(&transfer3);

    assert_eq!(blur2_psf.dims(), kernel2.dims());
    assert_eq!(blur2_otf.dims(), transfer2.dims());
    assert_eq!(blur3_psf.dims(), kernel3.dims());
    assert_eq!(blur3_otf.dims(), transfer3.dims());

    match blur2_psf {
        Blur2D::Psf(psf) => assert!(std::ptr::eq(psf, &kernel2)),
        Blur2D::Otf(_) => panic!("expected psf variant"),
    }
    match blur2_otf {
        Blur2D::Otf(otf) => assert!(std::ptr::eq(otf, &transfer2)),
        Blur2D::Psf(_) => panic!("expected otf variant"),
    }
    match blur3_psf {
        Blur3D::Psf(psf) => assert!(std::ptr::eq(psf, &kernel3)),
        Blur3D::Otf(_) => panic!("expected psf variant"),
    }
    match blur3_otf {
        Blur3D::Otf(otf) => assert!(std::ptr::eq(otf, &transfer3)),
        Blur3D::Psf(_) => panic!("expected otf variant"),
    }
}

#[test]
fn psf2otf_delta_is_all_ones() {
    let delta2 = Kernel2D::new(array![
        [0.0_f32, 0.0_f32, 0.0_f32],
        [0.0_f32, 1.0_f32, 0.0_f32],
        [0.0_f32, 0.0_f32, 0.0_f32]
    ])
    .unwrap();
    let otf2 = psf2otf(&delta2, delta2.dims()).unwrap();
    for value in otf2.as_array() {
        assert!((*value - Complex32::new(1.0, 0.0)).norm() < 1e-5);
    }

    let delta3 = Kernel3D::new(array![
        [
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32]
        ],
        [
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 1.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32]
        ],
        [
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32]
        ]
    ])
    .unwrap();
    let otf3 = psf2otf_3d(&delta3, delta3.dims()).unwrap();
    for value in otf3.as_array() {
        assert!((*value - Complex32::new(1.0, 0.0)).norm() < 1e-5);
    }
}

#[test]
fn otf_psf_roundtrip_within_tolerance() {
    let psf2 = Kernel2D::new(array![
        [0.0_f32, 0.1_f32, 0.0_f32],
        [0.1_f32, 0.6_f32, 0.1_f32],
        [0.0_f32, 0.1_f32, 0.0_f32]
    ])
    .unwrap();
    let psf2_norm = normalize(&psf2).unwrap();
    let otf2 = psf2otf(&psf2_norm, (7, 6)).unwrap();
    let restored2 = otf2psf(&otf2, psf2_norm.dims()).unwrap();
    for ((y, x), value) in psf2_norm.as_array().indexed_iter() {
        assert!((restored2.as_array()[[y, x]] - value).abs() < 1e-4);
    }

    let psf3 = Kernel3D::new(array![
        [
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.1_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32]
        ],
        [
            [0.0_f32, 0.1_f32, 0.0_f32],
            [0.1_f32, 0.4_f32, 0.1_f32],
            [0.0_f32, 0.1_f32, 0.0_f32]
        ],
        [
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.1_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32]
        ]
    ])
    .unwrap();
    let psf3_norm = normalize_3d(&psf3).unwrap();
    let otf3 = psf2otf_3d(&psf3_norm, (5, 6, 7)).unwrap();
    let restored3 = otf2psf_3d(&otf3, psf3_norm.dims()).unwrap();
    for ((d, y, x), value) in psf3_norm.as_array().indexed_iter() {
        assert!((restored3.as_array()[[d, y, x]] - value).abs() < 1e-4);
    }
}

#[test]
fn center_pad_crop_flip_and_validate_follow_conventions() {
    let psf = Kernel2D::new(array![
        [0.0_f32, 0.0_f32, 0.0_f32],
        [1.0_f32, 0.0_f32, 0.0_f32],
        [0.0_f32, 0.0_f32, 0.0_f32]
    ])
    .unwrap();
    let centered = center(&psf).unwrap();
    assert_eq!(centered.as_array()[[1, 1]], 1.0);

    let padded = pad_to(&centered, (5, 7)).unwrap();
    assert_eq!(padded.dims(), (5, 7));
    let cropped = crop_to(&padded, centered.dims()).unwrap();
    assert_eq!(cropped, centered);

    let flipped = flip(&centered).unwrap();
    assert_eq!(flipped.as_array()[[1, 1]], 1.0);
    validate(&centered).unwrap();

    let psf3 = Kernel3D::new(array![
        [
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32]
        ],
        [
            [0.0_f32, 0.0_f32, 0.0_f32],
            [1.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32]
        ],
        [
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32],
            [0.0_f32, 0.0_f32, 0.0_f32]
        ]
    ])
    .unwrap();
    let centered3 = center_3d(&psf3).unwrap();
    assert_eq!(centered3.as_array()[[1, 1, 1]], 1.0);

    let padded3 = pad_to_3d(&centered3, (5, 5, 5)).unwrap();
    let cropped3 = crop_to_3d(&padded3, centered3.dims()).unwrap();
    assert_eq!(cropped3, centered3);

    let flipped3 = flip_3d(&centered3).unwrap();
    assert_eq!(flipped3.as_array()[[1, 1, 1]], 1.0);
    validate_3d(&centered3).unwrap();
}

#[test]
fn support_mask_thresholding_is_stable() {
    let psf = Kernel2D::new(array![
        [1.0_f32, 0.5_f32, 0.1_f32],
        [0.0_f32, 0.0_f32, 0.0_f32],
        [0.0_f32, 0.0_f32, 0.0_f32]
    ])
    .unwrap();
    let mask = support_mask(&psf, 0.5).unwrap();
    assert!(mask[[0, 0]]);
    assert!(mask[[0, 1]]);
    assert!(!mask[[0, 2]]);

    let psf3 = Kernel3D::new(array![
        [[1.0_f32, 0.25_f32], [0.0_f32, 0.0_f32]],
        [[0.0_f32, 0.0_f32], [0.0_f32, 0.0_f32]]
    ])
    .unwrap();
    let mask3 = support_mask_3d(&psf3, 0.3).unwrap();
    assert!(mask3[[0, 0, 0]]);
    assert!(!mask3[[0, 0, 1]]);
}

#[test]
fn basic_generators_are_normalized_and_shape_conformant() {
    let d2 = delta2d((5, 7)).unwrap();
    assert_eq!(d2.dims(), (5, 7));
    assert!((d2.sum() - 1.0).abs() < 1e-6);
    assert_eq!(d2.as_array()[[2, 3]], 1.0);

    let d3 = delta3d((3, 5, 7)).unwrap();
    assert_eq!(d3.dims(), (3, 5, 7));
    assert!((d3.sum() - 1.0).abs() < 1e-6);
    assert_eq!(d3.as_array()[[1, 2, 3]], 1.0);

    let g2 = gaussian2d((7, 7), 1.2).unwrap();
    assert!((g2.sum() - 1.0).abs() < 1e-6);
    assert!((g2.as_array()[[3, 2]] - g2.as_array()[[3, 4]]).abs() < 1e-6);
    assert!((g2.as_array()[[2, 3]] - g2.as_array()[[4, 3]]).abs() < 1e-6);

    let g3 = gaussian3d((5, 5, 5), 1.0).unwrap();
    assert!((g3.sum() - 1.0).abs() < 1e-6);
    assert!((g3.as_array()[[1, 2, 2]] - g3.as_array()[[3, 2, 2]]).abs() < 1e-6);

    let b2 = box2d((3, 5)).unwrap();
    let b3 = box3d((3, 3, 3)).unwrap();
    assert!((b2.sum() - 1.0).abs() < 1e-6);
    assert!((b3.sum() - 1.0).abs() < 1e-6);
}

#[test]
fn disk_family_support_and_motion_size_behave_sensibly() {
    let radius = 3.0_f32;
    let k_disk = disk(radius).unwrap();
    let k_pill = pillbox(radius).unwrap();
    let k_defocus = defocus(radius).unwrap();

    assert_eq!(k_disk.dims(), (7, 7));
    assert_eq!(k_pill.dims(), (7, 7));
    assert_eq!(k_defocus.dims(), (7, 7));
    assert!((k_disk.sum() - 1.0).abs() < 1e-6);
    assert!((k_pill.sum() - 1.0).abs() < 1e-6);
    assert!((k_defocus.sum() - 1.0).abs() < 1e-6);

    let center = 3_i32;
    for y in 0..7_i32 {
        for x in 0..7_i32 {
            let dy = (y - center) as f32;
            let dx = (x - center) as f32;
            if dx * dx + dy * dy > radius * radius {
                assert_eq!(k_disk.as_array()[[y as usize, x as usize]], 0.0);
                assert_eq!(k_pill.as_array()[[y as usize, x as usize]], 0.0);
            }
        }
    }

    let m = motion_linear(8.0, 0.0).unwrap();
    let (mh, mw) = m.dims();
    assert_eq!(mh, mw);
    assert_eq!(mh % 2, 1);
    assert!(mh >= 9);
    assert!((m.sum() - 1.0).abs() < 1e-6);
}

#[test]
fn oriented_gaussian_and_init_helpers_produce_valid_psf() {
    let og = oriented_gaussian((9, 9), 2.0, 0.8, 30.0).unwrap();
    assert!((og.sum() - 1.0).abs() < 1e-6);
    validate(&og).unwrap();

    let u = uniform((5, 7)).unwrap();
    let gg = gaussian_guess((5, 7), 1.0).unwrap();
    let mg = motion_guess((5, 7), 9.0, 15.0).unwrap();
    validate(&u).unwrap();
    validate(&gg).unwrap();
    validate(&mg).unwrap();
    assert_eq!(u.dims(), (5, 7));
    assert_eq!(gg.dims(), (5, 7));
    assert_eq!(mg.dims(), (5, 7));

    let mut support = Array2::from_elem((5, 7), false);
    support[[2, 2]] = true;
    support[[2, 3]] = true;
    support[[2, 4]] = true;
    let masked = from_support(&support).unwrap();
    validate(&masked).unwrap();
    assert_eq!(masked.dims(), (5, 7));
    assert_eq!(masked.as_array()[[2, 2]], 1.0 / 3.0);
    assert_eq!(masked.as_array()[[2, 3]], 1.0 / 3.0);
    assert_eq!(masked.as_array()[[2, 4]], 1.0 / 3.0);
    assert_eq!(masked.as_array()[[0, 0]], 0.0);
}

#[test]
fn blur_matches_otf_blur_shape_and_finiteness() {
    let input = checkerboard_2d((28, 36), 4, 0.0, 1.0).unwrap();
    let psf = gaussian2d((7, 7), 1.1).unwrap();
    let otf = psf2otf(&psf, input.dim()).unwrap();

    let by_psf = blur(&input, &psf).unwrap();
    let by_otf = blur_otf(&input, &otf).unwrap();

    assert_eq!(by_psf.dim(), input.dim());
    assert_eq!(by_otf.dim(), input.dim());
    assert!(by_psf.iter().all(|value| value.is_finite()));
    assert!(by_otf.iter().all(|value| value.is_finite()));
}

#[test]
fn microscopy_models_produce_finite_normalized_kernels() {
    let born_wolf_kernel = born_wolf(&BornWolfParams::new().dims((17, 17, 17))).unwrap();
    let gibson_lanni_kernel = gibson_lanni(&GibsonLanniParams::new().dims((17, 17, 17))).unwrap();
    let variable_ri_kernel =
        variable_ri_gibson_lanni(&VariableRiGibsonLanniParams::new().dims((17, 17, 17))).unwrap();
    let richards_wolf_kernel =
        richards_wolf(&RichardsWolfParams::new().dims((17, 17, 17))).unwrap();

    let kernels = [
        born_wolf_kernel,
        gibson_lanni_kernel,
        variable_ri_kernel,
        richards_wolf_kernel,
    ];
    for kernel in &kernels {
        validate_3d(kernel).unwrap();
        assert_eq!(kernel.dims(), (17, 17, 17));
        assert!((kernel.sum() - 1.0).abs() < 1e-5);
        assert!(kernel.as_array().iter().all(|value| value.is_finite()));
        assert!(kernel.as_array().iter().all(|value| *value >= 0.0));
    }
}

#[test]
fn microscopy_centered_symmetric_cases_behave_sensibly() {
    let params = BornWolfParams::new()
        .dims((19, 19, 19))
        .wavelength_um(0.53)
        .numerical_aperture(1.2)
        .refractive_index(1.33)
        .axial_step_um(0.18);
    let kernel = born_wolf(&params).unwrap();
    let arr = kernel.as_array();
    let cz = 9_usize;
    let cy = 9_usize;
    let cx = 9_usize;

    assert!((arr[[cz, cy, cx - 2]] - arr[[cz, cy, cx + 2]]).abs() < 1e-6);
    assert!((arr[[cz, cy - 2, cx]] - arr[[cz, cy + 2, cx]]).abs() < 1e-6);
    assert!((arr[[cz - 2, cy, cx]] - arr[[cz + 2, cy, cx]]).abs() < 1e-6);
    assert!(arr[[cz, cy, cx]] >= arr[[cz, cy, cx + 1]]);
    assert!(arr[[cz, cy, cx]] >= arr[[cz + 1, cy, cx]]);
}

#[test]
fn variable_refractive_index_changes_output_meaningfully() {
    let uniform_index = VariableRiGibsonLanniParams::new()
        .dims((17, 17, 17))
        .refractive_index_start(1.36)
        .refractive_index_end(1.36);
    let varying_index = VariableRiGibsonLanniParams::new()
        .dims((17, 17, 17))
        .refractive_index_start(1.33)
        .refractive_index_end(1.46)
        .profile_exponent(1.4);

    let uniform_kernel = variable_ri_gibson_lanni(&uniform_index).unwrap();
    let varying_kernel = variable_ri_gibson_lanni(&varying_index).unwrap();

    let l1_distance = uniform_kernel
        .as_array()
        .iter()
        .zip(varying_kernel.as_array().iter())
        .map(|(a, b)| (a - b).abs())
        .sum::<f32>();
    assert!(l1_distance > 1e-3);
}

#[test]
fn microscopy_parameter_validation_rejects_invalid_sets() {
    let invalid_born_wolf = BornWolfParams::new()
        .dims((9, 9, 9))
        .refractive_index(1.33)
        .numerical_aperture(1.33);
    let invalid_richards_wolf = RichardsWolfParams::new()
        .dims((9, 9, 9))
        .polarization_weight(1.2);

    let err_bw = born_wolf(&invalid_born_wolf).unwrap_err();
    let err_rw = richards_wolf(&invalid_richards_wolf).unwrap_err();
    assert_eq!(err_bw, Error::InvalidParameter);
    assert_eq!(err_rw, Error::InvalidParameter);
}

#[test]
fn specialty_psf_models_are_normalized_and_finite() {
    let lorentz = lorentz2d((25, 23), 2.4).unwrap();
    let astig = astigmatic((25, 23), 3.0, 1.2, 15.0).unwrap();
    let helix = double_helix((25, 23), 1.8, 8.0, 35.0).unwrap();

    let kernels = [lorentz, astig, helix];
    for kernel in &kernels {
        validate(kernel).unwrap();
        assert!((kernel.sum() - 1.0).abs() < 1e-5);
        assert!(kernel.as_array().iter().all(|value| value.is_finite()));
        assert!(kernel.as_array().iter().all(|value| *value >= 0.0));
    }
}

#[test]
fn astigmatic_and_double_helix_have_expected_structure() {
    let astig = astigmatic((31, 31), 4.0, 1.5, 0.0).unwrap();
    let astig_arr = astig.as_array();
    let center = 15_usize;
    let row = astig_arr.row(center).sum();
    let col = astig_arr.column(center).sum();
    assert!(row > col);

    let helix = double_helix((41, 41), 2.0, 12.0, 0.0).unwrap();
    let helix_arr = helix.as_array();
    let c = 20_usize;
    let center_value = helix_arr[[c, c]];
    let left_peak = helix_arr[[c, c - 6]];
    let right_peak = helix_arr[[c, c + 6]];
    assert!(left_peak > center_value);
    assert!(right_peak > center_value);
    assert!((left_peak - right_peak).abs() < 1e-6);
}

#[test]
fn specialty_otf_models_have_expected_structure() {
    let koehler = koehler_otf((32, 30), 1.0).unwrap();
    let defocus = defocus_otf((32, 30), 1.0, 0.8).unwrap();

    assert_eq!(koehler.dims(), (32, 30));
    assert_eq!(defocus.dims(), (32, 30));
    assert!(koehler.as_array().iter().all(|value| value.is_finite()));
    assert!(defocus.as_array().iter().all(|value| value.is_finite()));
    assert!((koehler.as_array()[[0, 0]] - Complex32::new(1.0, 0.0)).norm() < 1e-6);
    assert!((defocus.as_array()[[0, 0]] - Complex32::new(1.0, 0.0)).norm() < 1e-6);

    let (height, width) = koehler.dims();
    for y in 0..height {
        let ny = wrap_neg(y, height);
        for x in 0..width {
            let nx = wrap_neg(x, width);
            let k_left = koehler.as_array()[[y, x]];
            let k_right = koehler.as_array()[[ny, nx]].conj();
            let d_left = defocus.as_array()[[y, x]];
            let d_right = defocus.as_array()[[ny, nx]].conj();
            assert!((k_left - k_right).norm() < 1e-6);
            assert!((d_left - d_right).norm() < 1e-6);
        }
    }

    let corner = koehler.as_array()[[height / 2, width / 2]];
    assert!(corner.norm() < 1e-5);
}

#[test]
fn specialty_model_parameter_validation_rejects_invalid_inputs() {
    let err_lorentz = lorentz2d((0, 9), 1.0).unwrap_err();
    let err_astig = astigmatic((9, 9), 1.0, -1.0, 0.0).unwrap_err();
    let err_helix = double_helix((9, 9), 1.0, 0.0, 0.0).unwrap_err();
    let err_koehler = koehler_otf((9, 9), 0.0).unwrap_err();
    let err_defocus = defocus_otf((9, 9), 1.0, -0.1).unwrap_err();

    assert_eq!(err_lorentz, Error::InvalidParameter);
    assert_eq!(err_astig, Error::InvalidParameter);
    assert_eq!(err_helix, Error::InvalidParameter);
    assert_eq!(err_koehler, Error::InvalidParameter);
    assert_eq!(err_defocus, Error::InvalidParameter);
}

fn wrap_neg(index: usize, size: usize) -> usize {
    if index == 0 { 0 } else { size - index }
}