Experimental Variography Analysis

variogram(object, attribute, region, geographic_azimuth, dip, pitch, lags, tol, atol=45.0, slice_width=None, slice_height=None, weights_attribute=None, working_memory=None)

Given boundary input arguments (lag and its associated tolerance, angular reference and its associated tolerance), compute the variogram for a set of points (value associated with cartesian coordinates for a specific point)

Parameters:

Name	Type	Description	Default
object	GeoRefObject	Geo-ref Object.	required
attribute	str	Object attribute to compute variography on.	required
region	Optional[str]	Object region or condition to select data from.	required
geographic_azimuth	float	Azimuth angle, in degrees, comprised between 0 and 360.	required
dip	float	Dip angle, in degrees, comprised between 0 and 90.	required
pitch	float	Pitch angle, in degrees, comprised between -90 and 90.	required
lags	Vector	List of lags (in the same unit as the object, e.g. meters).	required
tol	float	Lag tolerance (in the same unit as the object, e.g. meters).	required
atol	float	Angular tolerance in degrees.	45.0
slice_width	Optional[float]	Slicing width (in the same unit as the object, e.g. meters).	None
slice_height	Optional[float]	Slicing height (in the same unit as the object, e.g. meters).	None
weights_attribute	Optional[str]	Weights attribute for ponderation, generally coming from declustering.	None
working_memory	[Experimental]	The sought maximum memory for temporary distance matrix chunks in Mb (see scikit-learn).	None

Returns:

Type	Description
pd.DataFrame	A variogram dataframe, Isatis compliant output (rank, number of pairs, input lag, average distance, variogram value and indices)

generate_lags(lag, plag, nlags)

Generate lags array to be used with variogram

Parameters:

Name	Type	Description	Default
lag	float	Calculation lag	required
plag	float	Tolerance (percentage of lag)	required
nlags	int	Length of array to be generated	required

Returns:

Type	Description
Tuple[np.ndarray, float]	An array of lags and the tolerance.