class pyinterp.Binning2D(x: pyinterp.core.Axis, y: pyinterp.core.Axis, wgs: Optional[pyinterp.geodetic.System] = None, dtype: numpy.dtype = dtype('float64'))[source]#

Bases: object

Group a number of more or less continuous values into a smaller number of “bins” located on a grid.

  • x – Definition of the bin centers for the X axis of the grid.

  • y – Definition of the bin centers for the Y axis of the grid.

  • wgs – WGS of the coordinate system used to manipulate geographic coordinates. If this parameter is not set, the handled coordinates will be considered as Cartesian coordinates. Otherwise, x and y are considered to represents the longitudes and latitudes.

  • dtype – Data type of the instance to create.


The axes define the centers of the different cells where the statistics will be calculated, as shown in the figure below.


In this example, to calculate the statistics in the different cells defined, the coordinates of the axes must be shifted by half a grid step, 0.5 in this example.



Gets the geodetic system handled of the grid.


Gets the bin centers for the X Axis of the grid.


Gets the bin centers for the Y Axis of the grid.

Public Methods


Clears the data inside each bin.

push(x, y, z[, simple])

Push new samples into the defined bins.

push_delayed(x, y, z[, simple])

Push new samples into the defined bins from dask array.


Gets the regular grid containing the calculated statistics.

Special Methods


Overrides the default behavior of the + operator.


Called by the repr() built-in function to compute the string representation of this instance.