pynetdesign.modelling.utils.check_min_stations

pynetdesign.modelling.utils.check_min_stations(min_stations_p, min_stations_s, n_stations, wave_mode='PS')

Check that the minimum numbers of stations required for detection are valid.

Parameters:

min_stations_pint

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

min_stations_sint

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

n_stationsint

Total number of stations in the geometry.

wave_modestr, optional, default: 'PS'

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

Raises:

ValueError

If a minimum number of stations is not positive or exceeds the number of stations.

Notes

Each of min_stations_p and min_stations_s is checked only if it is not None and only if the corresponding branch is part of wave_mode.