pynetdesign.modelling.classes.DetectionParameters

class pynetdesign.modelling.classes.DetectionParameters(min_SNR_p, min_SNR_s, min_stations_p, min_stations_s, f_p=None, f_s=None, f_p_corner=None, f_s_corner=None, fs_mode=None, fs_level=None, fs_deviation=None, free_surface=None)

Container for the parameters controlling event detection.

Parameters:

min_SNR_pfloat

Minimum signal-to-noise ratio required to detect a P wave on one receiver.

min_SNR_sfloat

Minimum signal-to-noise ratio required to detect an S wave on one receiver.

min_stations_pint

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

min_stations_sint

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

f_pfloat, optional

Representative frequency of the P wave (Hz). If None, the peak frequency is computed from the model.

f_sfloat, optional

Representative frequency of the S wave (Hz). If None, the peak frequency is computed from the model.

f_p_cornerfloat, optional, default: None (100 Hz)

Corner frequency of the P wave (Hz), limiting the peak frequency.

f_s_cornerfloat, optional, default: None (100 Hz)

Corner frequency of the S wave (Hz), limiting the peak frequency.

fs_modestr, optional, default: None ('auto')

Free surface correction mode, one of 'auto', 'on' or 'off'. In 'auto' mode the correction is applied to receivers that are within fs_deviation of the free surface level, or according to the Surface column of the geometry when present.

fs_levelfloat, optional, default: None (0.0)

Level of the free surface in metres above the reference level.

fs_deviationfloat, optional, default: None (1.0)

Permitted deviation from the free surface level in metres.

free_surfacebool, optional

Deprecated override kept for backward compatibility. True maps to fs_mode='on' and False to fs_mode='off'. If None, fs_mode is used.

Notes

The free surface correction is applied per receiver, so a geometry combining surface and downhole receivers is handled correctly. This differs from PyNetDesign 1.0.x, where free_surface=True amplified every receiver irrespective of its depth.

Methods

__init__(min_SNR_p, min_SNR_s, ...[, f_p, ...])
validate()