apbase 0.1.3

High-performance automated map-generation pipeline for precision agriculture
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

//! High-level kriging API: local ordinary kriging. Target-grid generation lives in `apbase::grid`.

mod _interpolation;
mod _native;

use ndarray::Array1;

pub use crate::variogram::Variogram;
pub use _interpolation::{Kriging, KrigingOptions};

use crate::common::arrays::{ArrayLike, Targets};
use crate::common::exceptions::Result;

/// Interpolation diagnostics returned by [`ordinary_kriging_with_diagnostics`].
#[derive(Clone, Debug, PartialEq)]
pub struct KrigingDiagnostics {
    /// Local search radius actually used.
    pub radius: f64,
    /// Maximum neighbors per target.
    pub max_neighbors: i64,
    /// Minimum neighbors per target.
    pub min_neighbors: i64,
    /// OpenMP thread count.
    pub n_threads: i64,
}

/// Fit local ordinary kriging and estimate `targets` values.
///
/// One-shot wrapper around [`Kriging`]; prefer [`Kriging`] directly to reuse a
/// fitted variogram across several `interpolate` calls.
pub fn ordinary_kriging(
    x: &(impl ArrayLike + ?Sized),
    y: &(impl ArrayLike + ?Sized),
    z: &(impl ArrayLike + ?Sized),
    targets: &(impl Targets + ?Sized),
    options: KrigingOptions,
) -> Result<Array1<f64>> {
    Kriging::new(options)?.fit(x, y, z)?.interpolate(targets)
}

/// [`ordinary_kriging`] with `return_diagnostics=True`: `(estimates, diagnostics)`.
pub fn ordinary_kriging_with_diagnostics(
    x: &(impl ArrayLike + ?Sized),
    y: &(impl ArrayLike + ?Sized),
    z: &(impl ArrayLike + ?Sized),
    targets: &(impl Targets + ?Sized),
    options: KrigingOptions,
) -> Result<(Array1<f64>, KrigingDiagnostics)> {
    let max_neighbors = options.max_neighbors;
    let min_neighbors = options.min_neighbors;
    let mut kriging = Kriging::new(options)?;
    kriging.fit(x, y, z)?;
    let estimates = kriging.interpolate(targets)?;

    Ok((
        estimates,
        KrigingDiagnostics {
            radius: kriging.resolve_radius()?,
            max_neighbors,
            min_neighbors,
            n_threads: kriging.n_threads(),
        },
    ))
}