Kriging

Kriging (Entity)

Kriging Solver class.

Parameters:

Name	Type	Description	Default
covariance_model	Union[Covariance, CovarianceElem]	Covariance used for distance computation.	required
neighborhood_model	Neighborhood	Neihborhood model used for weigths computation.	required
axes	List[Coord]	If solver is 2D or 3D. Defaults to [Coord.U, Coord.V, Coord.W].	[<Coord.U: 'U'>, <Coord.V: 'V'>, <Coord.W: 'W'>]

Attributes:

Name	Type	Description
covariance_model	Union[Covariance, CovarianceElem]	Covariance used for distance computation.
neighhborhood_model	Neighborhood	Neihborhood model used for weigths computation.
axes	List[Coord], optionnal	If solver is 2D or 3D.

axes: List[geolime.base.enums.Coord] property readonly

Return Solver Axis.

Returns:

Type	Description
List[Coord]	List of axes.

covariance_model: Union[geolime.geostats.models.covariance.Covariance, geolime.geostats.models.covariance.CovarianceElem] property readonly

Return Covariance Model.

Returns:

Type	Description
Union[Covariance, CovarianceElem]	Covariance model.

neighborhood_model: Neighborhood property readonly

Return Neighborhood Model.

Returns:

Type	Description
Neighborhood	Neighborhood model.

solve(self)

Use the defined method to interpolate onto target locations.

OrdinaryKriging (Kriging)

Ordinary Kriging Solver class.

Kriging Solver where mean of data is supposed to be unknown.

Parameters:

Name	Type	Description	Default
covariance_model	Union[Covariance, CovarianceElem]	Covariance used for distance computation.	required
neighborhood_model	Neighborhood	Neihborhood model used for weigths computation.	required
axes	List[Coord]	If solver is 2D or 3D. Defaults to [Coord.U, Coord.V, Coord.W].	[<Coord.U: 'U'>, <Coord.V: 'V'>, <Coord.W: 'W'>]

solve(self, obj, obj_region, obj_attribute, support, support_region, support_attribute, discr=None, kriging_slope=False, kriging_efficiency=False)

Solve Ordinary Kriging on a support using a conditioning object.

Parameters:

Name	Type	Description	Default
obj	GeoRefObject	Conditioning Object.	required
obj_region	str	Spatial subset of conditionining.	required
obj_attribute	str	Property to estimate.	required
support	GeoRefObject	Object to estimate onto.	required
support_region	str	Spatial subset of estimation.	required
support_attribute	str	Property name to add in support.	required
discr	Vector	Discretisation of each block if block kriging. Defaults to None.	None
kriging_slope	Bool	Extraction of kriging slope as attribute in support.	False
kriging_efficiency	Bool	Extraction of kriging efficiency as attribute in support.	False

Exceptions:

Type	Description
AttributeError	If maximum allowed neighbors is higher than number of conditioning data.

SimpleKriging (OrdinaryKriging)

Simple Kriging Solver class.

Kriging Solver where mean of data is supposed to be known and spatially constant.

Parameters:

Name	Type	Description	Default
covariance_model	Union[Covariance, CovarianceElem]	Covariance used for distance computation.	required
neighborhood_model	Neighborhood	Neihborhood model used for weigths computation.	required
mean	float	Mean of values for estimation.	required
axes	List[Coord]	If solver is 2D or 3D. Defaults to [Coord.U, Coord.V, Coord.W].	[<Coord.U: 'U'>, <Coord.V: 'V'>, <Coord.W: 'W'>]

mean: float property readonly

Return means of Kriging solver.

Returns:

Type	Description
float	Mean value.