edges_analysis.averaging.averaging.get_bin_edges

edges_analysis.averaging.averaging.get_bin_edges(coords: ndarray, bins: ndarray | Quantity | int | float | None = None, start: float | Quantity | None = None, stop: float | Quantity | None = None) → ndarray

Get bin edges given input coordinates and a simple description of the binning.

Parameters:

• coords – The input co-ordinates to bin. These must be regular and monotonically increasing.

• bins – The bin edges (lower inclusive, upper not inclusive). If an int, simply use bins samples per bin, starting from the first bin. If a float, use equi-spaced bin edges, starting from the start of coords, and ending past the end of coords. If not provided, assume a single bin encompassing all the data.