csep.utils.calc.bin1d_vec
- csep.utils.calc.bin1d_vec(p, bins, tol=None, right_continuous=False)[source]
Efficient implementation of binning routine on 1D Cartesian Grid.
Bins are inclusive on the lower bound and exclusive on the upper bound. In the case where a point does not fall within the bins a -1 will be returned. The last bin extends to infinity when right_continuous is set as true.
To correctly bin points that are practically on a bin edge, this function accounts for the limited precision of floating-point numbers (the roundoff error) with a numerical tolerance. If the provided points were subject to some floating-point operations after loading or generating them, the roundoff error increases (which is not accounted for) and requires overwriting the tol argument.
- Parameters:
p (array-like) – Point(s) to be placed into bins.
bins (array-like) – bin edges; must be sorted (monotonically increasing)
tol (float) – overwrite numerical tolerance, by default determined automatically from the points’ dtype to account for the roundoff error.
right_continuous (bool) – if true, consider last bin extending to infinity.
- Returns:
indices for the points corresponding to the bins.
- Return type:
- Raises: