arviz_stats.histogram2d

arviz_stats.histogram2d(x, y, bins=None, range=None, weights=None, axis=-1, density=True, dim=None)

Compute a two-dimensional histogram for paired samples.

Plain arrays return (histogram, x_edges, y_edges). DataArray inputs return a Dataset with variables named histogram, x_edges, and y_edges.

Parameters:

x, yarray_like or xarray.DataArray

Paired samples with identical shapes.

binsNone, str, int or array_like or pair, default None

Bin specification passed to numpy.histogram2d. None or "auto" applies the default two-dimensional bin rule to each marginal, reduced to shared counts over batched input.

rangearray_like, optional

((xmin, xmax), (ymin, ymax)) passed to numpy.histogram2d.

weightsarray_like or xarray.DataArray, optional

Sample weights with the same shape as the samples.

axisint, sequence of int or None, default -1

Array axis or axes along which to reduce.

densitybool, default True

Normalize the histogram as a probability density.

dimstr or sequence of str, optional

DataArray dimension or dimensions along which to reduce.

Returns:

tuple or xarray.Dataset

Histogram values and x and y bin edges.