kriging-rs 0.4.0

Geostatistical kriging library with WASM support
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

//! Space–time kriging.
//!
//! Mirrors the 2-D spatial path: [`SpaceTimeCoord`] and [`SpaceTimeDataset`] pair a spatial
//! coordinate (via [`SpatialMetric`]) with a scalar time, [`SpaceTimeVariogram`] provides
//! separable and product-sum covariance families, and the `kriging` submodule hosts the
//! ordinary/simple/universal/binomial ST kriging models.
//!
//! The metric abstraction lets the same generic model serve both geographic and projected
//! data:
//!
//! - [`GeoMetric`] — Haversine distance on [`GeoCoord`](crate::GeoCoord) (kilometers).
//! - [`ProjectedMetric`] — Euclidean distance on
//!   [`ProjectedCoord`](crate::ProjectedCoord) with optional 2-D anisotropy.
//!
//! # Quick example
//!
//! ```rust
//! use kriging_rs::{
//!     GeoCoord, VariogramModel, VariogramType,
//!     spacetime::{
//!         GeoMetric, SpaceTimeCoord, SpaceTimeDataset, SpaceTimeOrdinaryKrigingModel,
//!         SpaceTimeVariogram,
//!     },
//! };
//!
//! # fn main() -> Result<(), kriging_rs::KrigingError> {
//! let coords = vec![
//!     SpaceTimeCoord::try_new(GeoCoord::try_new(0.0, 0.0)?, 0.0)?,
//!     SpaceTimeCoord::try_new(GeoCoord::try_new(0.0, 1.0)?, 1.0)?,
//!     SpaceTimeCoord::try_new(GeoCoord::try_new(1.0, 0.0)?, 2.0)?,
//! ];
//! let values = vec![1.0, 2.0, 1.5];
//! let dataset = SpaceTimeDataset::new(coords, values)?;
//! let spatial = VariogramModel::new(0.01, 2.0, 300.0, VariogramType::Exponential)?;
//! let temporal = VariogramModel::new(0.01, 1.0, 5.0, VariogramType::Exponential)?;
//! let variogram = SpaceTimeVariogram::new_separable(spatial, temporal)?;
//! let model = SpaceTimeOrdinaryKrigingModel::new(GeoMetric, dataset, variogram)?;
//! let pred = model.predict(SpaceTimeCoord::try_new(GeoCoord::try_new(0.3, 0.3)?, 1.0)?)?;
//! # let _ = pred.value;
//! # Ok(())
//! # }
//! ```

pub mod coord;
pub mod dataset;
pub mod empirical;
pub mod fitting;
pub mod kriging;
pub mod metric;
pub mod variogram;

pub use coord::SpaceTimeCoord;
pub use dataset::SpaceTimeDataset;
pub use empirical::{
    EmpiricalSpaceTimeVariogram, SpaceTimeVariogramConfig, compute_empirical_spacetime_variogram,
    spatial_marginal, temporal_marginal,
};
pub use fitting::{
    SpaceTimeFitConfig, SpaceTimeFitResult, SpaceTimeVariogramType, fit_spacetime_variogram,
};
pub use kriging::binomial::{SpaceTimeBinomialKrigingModel, SpaceTimeBinomialObservation};
pub use kriging::ordinary::SpaceTimeOrdinaryKrigingModel;
pub use kriging::simple::SpaceTimeSimpleKrigingModel;
pub use kriging::universal::{SpaceTimeUniversalKrigingModel, SpaceTimeUniversalTrend};
pub use metric::{GeoMetric, ProjectedMetric, SpatialBasis, SpatialMetric};
pub use variogram::SpaceTimeVariogram;