Uniform Conditioning

LocalisedUniformConditioning

Bases: Entity

Localised Uniform Conditioning Solver class.

Parameters:

Name	Type	Description	Default
covariance_model	Covariance	Covariance used for distance computation.	required
neighborhood_model	Neighborhood	Neighborhood model used for weights computation.	required
axes	List[Coord]	If solver is 2D or 3D. Defaults to [Coord.U, Coord.V, Coord.W].	[U, V, W]

Attributes:

Name	Type	Description
covariance_model	Union[Covariance, CovarianceElem]	Covariance used for distance computation.
neighborhood_model	Neighborhood	Neighborhood model used for weights computation.
axes	Neighborhood	If solver is 2D or 3D.

covariance_model: Union[Covariance, CovarianceElem] property

Return Covariance Model.

Returns:

Type	Description
Union[Covariance, CovarianceElem]	Covariance model.

neighborhood_model: Neighborhood property

Return Neighborhood Model.

Returns:

Type	Description
Neighborhood	Neighborhood model.

solve(obj, obj_region, obj_attribute, anamorphosis, support, support_region, panel_support, panel_support_region, cutoff_grades, support_attribute, discr=None, panel_discr=None, slope_anamorphosis_classes=None)

Solve Localised Uniform Conditioning on a small size support (SMU) using a conditioning object and larger size support (panel).

Parameters:

Name	Type	Description	Default
obj	GeoRefObject	Conditioning Object.	required
obj_region	Optional[str]	Spatial subset of conditioning.	required
obj_attribute	str	Property to estimate.	required
anamorphosis	Anamorphosis	Anamorphosis class, allowing change of support computation, and local estimation.	required
support	GeoRefObject	Object to estimate onto (SMU).	required
support_region	Optional[str]	Spatial subset of estimation.	required
panel_support	GeoRefObject	Object to estimate onto (Panel).	required
panel_support_region	Optional[str]	Spatial subset of estimation.	required
cutoff_grades	Vector	Discretised range of values of input data.	required
support_attribute	str	Property name to add in support.	required
discr	Optional[Vector]	Discretisation of each block (SMU) if block kriging. Defaults to None.	None
panel_discr	Optional[Vector]	Discretisation of each block (Panel) if block kriging. Defaults to None.	None
slope_anamorphosis_classes	Optional[Vector]	Slope of regression values used to average the panel anamorphosis change of support. Defaults to None.	None

Raises:

Type	Description
Warning	Maximum allowed neighbors is higher than number of conditioning data.
ValueError	Slope anamorphosis classes must be between 0 and 1.
ValueError	Slope anamorphosis classes must be in increasing order.

solve_api(neighborhood_model, covariance_model, dim, obj_coords, obj_data, anamorphosis, support_coords, support_cell_size, panel_coords, panel_cell_size, cutoff_grades, discr=None, panel_discr=None, slope_anamorphosis_classes=None) staticmethod

Low-level Localised Uniform Conditioning solving method.

Parameters:

Name	Type	Description	Default
covariance_model	Covariance	Covariance used for distance computation.	required
neighborhood_model	Neighborhood	Neighborhood model used for weights computation.	required
dim	int	Number of dimensions.	required
obj_coords	ndarray	Conditioning object coordinates in region along specified axes.	required
obj_data	ndarray	Values in selected region.	required
anamorphosis	Anamorphosis	Anamorphosis class, allowing change of support computation, and local estimation.	required
support_coords	ndarray	Support coordinates in region along specified axes.	required
support_cell_size	ndarray	Support cell size for support effect determination.	required
panel_coords	ndarray	Panel coordinates in region along specified axes.	required
panel_cell_size	ndarray	Panel cell size.	required
cutoff_grades	Vector	Discretised range of values of input data.	required
discr	Optional[Vector]	Discretisation of each block if block kriging. Defaults to None.	None
panel_discr	Optional[Vector]	Discretisation of each block (Panel) if block kriging. Defaults to None.	None
slope_anamorphosis_classes	Optional[Vector]	Slope of regression values used to average the panel anamorphosis change of support. Defaults to None.	None

Returns:

Type	Description
Tuple[ndarray, ndarray, ndarray, ndarray, ndarray, ndarray, ndarray, ndarray]	LUC results, variance, variance estimation, slope, efficiency, ore, metal and luc_values ndarrays.

Raises:

Type	Description
Warning	Maximum allowed neighbors is higher than number of conditioning data.
ValueError	Slope anamorphosis classes must be between 0 and 1.
ValueError	Slope anamorphosis classes must be in increasing order.