csep.core.forecasts.GriddedForecast.get_magnitude_index
- GriddedForecast.get_magnitude_index(mags, tol=None)
Returns the indices into the magnitude bins of selected magnitudes
Note: the right-most bin is treated as extending to infinity.
- Parameters:
mags (array-like) – magnitudes bin edges.
tol (float) – overwrite numerical tolerance, by default determined automatically from the magnitudes’ dtype to account for the limited precision of floating-point values. Only necessary to specify if the magnitudes were subject to some floating-point operations after loading or generating them (increased roundoff error, see
csep.utils.calc.bin1d_vec()).
- Returns:
indices corresponding to the magnitude bins
- Return type:
- Raises: