pynetdesign.modelling.homo.validate_parameters#

pynetdesign.modelling.homo.validate_parameters(density, v_p, v_s, Q_p, Q_s, min_amps_p, min_amps_s, wave_mode, station_coords)[source]#

Validates the input parameters.

Parameters:
densityfloat

Density of the medium

v_pfloat

P wave velocity

v_sfloat

S wave velocity

Q_pfloat

P wave attenuation factor

Q_sfloat

S wave attenuation factor

min_amps_pnumpy.ndarray

Minimal measurable displacement amplitudes of on stations [a1, a2, …] for P waves

min_amps_snumpy.ndarray

Minimal measurable displacement amplitudes on stations [a1, a2, …] for S waves

wave_mode: :obj:`str`

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

station_coordsnumpy.ndarray

Array of station coordinates [[xr1, yr1, zr1], [xr2, yr2, zr2], …]

Raises:
ValueError

if density, wave velocity or attenuation factor is not positive

ValueError

if number of minimal measurable amplitudes does not match number of stations

ValueError

if there is inconsistency in P/S wave parameters