pynetdesign.modelling.utils.mag_detectable#

pynetdesign.modelling.utils.mag_detectable(Mw_min_stations, min_stations_p=None, min_stations_s=None, wave_mode='PS')[source]#

Computes detectable minimum magnitudes from magnitude sensitivities for individual stations with respect to number of stations necessary for event detection using P and/or S waves.

Parameters:
Mw_min_stationsnumpy.ndarray

Array of computed minimum magnitudes for individual stations

min_stations_pint, optional, default: 3

Minimum number of stations on which event must be detected with P waves

min_stations_sint, optional, default: 3

Minimum number of stations on which event must be detected with S waves

wave_mode: :obj:`str`, optional, default: ‘PS’

Wave mode to use, can be ‘P’, ‘SV’, ‘SH’, ‘S’ or ‘PS’

Returns:
Mw_min_gridnumpy.ndarray

Array of detectable minimum magnitudes on the grid

Raises:
ValueError

if minimum number of stations on which event must be detected with P or S waves is less than 1 or exceeds number of stations