scipp.bins

scipp.bins(*, data, dim, begin=None, end=None)

Create a binned variable from bin indices.

The elements of the returned variable are “bins”, defined as views into data. The returned variable keeps and manages a copy of data internally.

The variables begin and end must have the same dims and shape and dtype=sc.dtype.int64. The output dims and shape are given by begin. If only begin is given, each bucket is a slice containing a non-range slice of data at the given indices. If neither begin nor end are given, the output has dims=[dim] and contains all non-range slices along that dimension.

Parameters
Returns

Variable containing data in bins.

Seealso

scipp.bin() for creating DataArrays based on binning of coord value instead of explicitly given index ranges.

Return type

scipp._scipp.core.Variable