scipp.binning.make_binned

scipp.binning.make_binned(x, *, edges=None, groups=None, erase=())

Create binned data by binning input along all dimensions given by edges or groups.

Usually scipp.bin() or scipp.group() should be preferred, unless the more precise control over which dimensions should be erased is required, or unless grouping and binning at the same time is required.

This does not histogram the data, each output bin will contain a “list” of input values.

At least one argument of edges and groups is required.

If the input is binned and certain bins are masked then changing the binning will apply the masks, i.e., masked bins are treated as empty.

Warning

When there is existing binning or grouping, the algorithm assumes that coordinates of the binned data are correct, i.e., compatible with the corresponding coordinate values in the individual bins. If this is not the case then the behavior is UNSPECIFIED. That is, the algorithm may or may not ignore the existing coordinates. If you encounter such as case, remove the conflicting coordinate, e.g., using scipp.DataArray.drop_coords().

Parameters:

• x (Variable | DataArray) – Input data.

• edges (Sequence[Variable] | None, default: None) – Bin edges, one per dimension to bin in.

• groups (Sequence[Variable] | None, default: None) – Keys to group input by one per dimension to group in.

• erase (Sequence[str], default: ()) – Dimension labels to remove from output.

Returns:

DataArray – Binned x.

See also

scipp.hist

For histogramming data.

scipp.bin

Recommended interface for binning data.

scipp.group

Recommended interface for grouping data.

scipp.bins

For creating binned data based on explicitly given index ranges.