pynetdesign.modelling.utils.normalize_wave_mode#

pynetdesign.modelling.utils.normalize_wave_mode(wave_mode)[source]#

Return the canonical form of a wave mode.

'S' is a composite mode representing the better recorded of the two isotropic S polarizations, SV and SH.

Parameters:

wave_modestr: Wave mode, one of 'P', 'SV', 'SH', 'S' or 'PS', in any letter case and with surrounding whitespace ignored.

Returns:

modestr: Canonical upper-case wave mode.

Raises:

ValueError: If wave_mode is not one of the supported modes.