deconvolution 0.1.0

Rust image deconvolution and restoration library.
Documentation
use criterion::{black_box, criterion_group, criterion_main, Criterion};
use deconvolution::nd;
use deconvolution::optimization::Qmle;
use deconvolution::psf::basic::gaussian3d;
use deconvolution::simulate::blur::blur;
use deconvolution::simulate::phantom::phantom_3d;
use ndarray::{Array3, Axis};

fn bench_volume(c: &mut Criterion) {
    let (volume, psf) = degraded_volume_fixture().expect("fixture");
    let config = Qmle::new().iterations(8).snr(60.0).acuity(1.1);

    c.bench_function("volume_qmle", |b| {
        b.iter(|| {
            let _ =
                nd::microscopy::qmle_with(black_box(&volume), black_box(&psf), black_box(&config))
                    .expect("nd_qmle");
        });
    });
}

fn degraded_volume_fixture() -> deconvolution::Result<(Array3<f32>, Array3<f32>)> {
    let sharp = phantom_3d((7, 40, 40))?;
    let psf_3d = gaussian3d((7, 9, 9), 1.5)?;
    let blurred = blur_volume_slicewise(&sharp, psf_3d.as_array())?;
    Ok((blurred, psf_3d.as_array().to_owned()))
}

fn blur_volume_slicewise(
    volume: &Array3<f32>,
    psf_3d: &Array3<f32>,
) -> deconvolution::Result<Array3<f32>> {
    if volume.is_empty() {
        return Err(deconvolution::Error::EmptyImage);
    }
    if volume.iter().any(|value| !value.is_finite()) {
        return Err(deconvolution::Error::NonFiniteInput);
    }
    if psf_3d.is_empty() {
        return Err(deconvolution::Error::InvalidPsf);
    }
    if psf_3d.iter().any(|value| !value.is_finite()) {
        return Err(deconvolution::Error::NonFiniteInput);
    }

    let mut projected = psf_3d.sum_axis(Axis(0));
    let sum = projected.sum();
    if !sum.is_finite() || sum.abs() <= f32::EPSILON {
        return Err(deconvolution::Error::InvalidPsf);
    }
    for value in &mut projected {
        *value /= sum;
    }
    let projected = deconvolution::Kernel2D::new(projected)?;

    let (depth, height, width) = volume.dim();
    let mut output = Array3::zeros((depth, height, width));
    for z in 0..depth {
        let slice = volume.index_axis(Axis(0), z).to_owned();
        let blurred = blur(&slice, &projected)?;
        output.index_axis_mut(Axis(0), z).assign(&blurred);
    }
    Ok(output)
}

criterion_group!(benches, bench_volume);
criterion_main!(benches);