arviz_stats.base.array_stats.hexbin

array_stats.hexbin(x, y, gridsize='auto', extent=None, weights=None, axis=-1, density=True, regular=True)

Compute a batched hexagonal histogram.

Parameters:

x, yarray_like

Paired samples with identical shapes.

weightsarray_like, optional

Sample weights with the same shape as x and y. Values in each cell are the sum of its sample weights.

gridsize“auto” or int or pair of int, default “auto”

Number of hexagons in the x and y directions. "auto" applies the default two-dimensional bin rule to each marginal (the counts histogram2d would use on those marginals), reduced to shared counts over batched input. A pair sets both directions explicitly.

extentarray_like, optional

Limits (xmin, xmax, ymin, ymax) of the hexagon grid.

axisint, sequence of int or None, default -1

Axis or axes along which to reduce.

densitybool, default True

Divide counts by the valid sample count and hexagon area.

regularbool, default True

Whether to use a regular hexagonal grid. Ignored if gridsize is not "auto".

Returns:

values, offsetsndarray

Values for every cell and their (x, y) center coordinates.