gstools.variogram.standard_bins

gstools.variogram.standard_bins(pos=None, dim=2, latlon=False, mesh_type='unstructured', bin_no=None, max_dist=None, geo_scale=1.0)[source]

Get standard binning.

Parameters

  • pos (list, optional) – the position tuple, containing either the point coordinates (x, y, …) or the axes descriptions (for mesh_type=’structured’)

  • dim (int, optional) – Field dimension.

  • latlon (bool, optional) – Whether the data is representing 2D fields on earths surface described by latitude and longitude. When using this, the estimator will use great-circle distance for variogram estimation. Note, that only an isotropic variogram can be estimated and a ValueError will be raised, if a direction was specified. Bin edges need to be given in radians in this case. Default: False

  • mesh_type (str, optional) – ‘structured’ / ‘unstructured’, indicates whether the pos tuple describes the axis or the point coordinates. Default: ‘unstructured’

  • bin_no (int, optional) – number of bins to create. If None is given, will be determined by Sturges’ rule from the number of points. Default: None

  • max_dist (float, optional) – Cut of length for the bins. If None is given, it will be set to one third of the box-diameter from the given points. Default: None

  • geo_scale (float, optional) – Geographic unit scaling in case of latlon coordinates to get a meaningful bins unit. By default, bins are assumed to be in radians with latlon=True. Can be set to KM_SCALE to have bins in km or DEGREE_SCALE to have bins in degrees. Default: RADIAN_SCALE

Returns

The generated bin edges.

Return type

numpy.ndarray

Notes

Internally uses double precision and also returns doubles.