gstools_cython.variogram.directional

gstools_cython.variogram.directional(const double[:, :] f, const double[:] bin_edges, const double[:, :] pos, const double[:, :] direction, double angles_tol=M_PI / 8.0, double bandwidth=-1.0, bool separate_dirs=False, str estimator_type='m', num_threads=None)

Directional variogram estimator.

Parameters:

• f (double[:, :]) – unstructured random field

• bin_edges (double[:]) – edges for the variogram bins

• pos (double[:, :]) – the position (d,n) tuple with d dimensions and n points.

• directions (double[:, :]) – vectors specifying the directions

• angles_tol (double, optional) – angle tolerance around direction vectors in radians, default: PI/8.0

• bandwidth (double, optional) – maximal distance to direction vector. negative values used to turn of bandwidth search. Default: -1.0

• separate_dirs (bint, optional) – whether the direction bands shouldn’t overlap, default: False

• estimator_type (str, optional) –

  the estimator function, possible choices:

  • “m”: the standard method of moments of Matheron

  • “c”: an estimator more robust to outliers by Cressie

  Default: “m”

• num_threads (None or int, optional) – number of OpenMP threads, default: None

Returns:

• variogram (double[:, :]) – estimated variogram per direction

• counts (np.int64_t[:, :]) – counts of samples per bin and direciton