pynetdesign.modelling.utils.resolve_radiation_pattern

pynetdesign.modelling.utils.resolve_radiation_pattern(phase, rad_pattern_p=None, rad_pattern_s=None, rad_patterns=None)

Resolve the radiation-pattern magnitude to use for a phase.

Overrides take precedence over the root-mean-square defaults of phase_radiation_pattern, which makes it possible to reproduce results published with other conventions, for instance the combined S-wave value \(R_S = 0.63\).

Parameters:

phasestr

Phase, one of 'P', 'SV' or 'SH'.

rad_pattern_pfloat, optional

Override for the P phase. If None, the default is used.

rad_pattern_sfloat, optional

Override applied to both S phases. If None, the defaults are used.

rad_patternsdict, optional

Per-phase overrides, e.g. {'SV': 0.63}. Takes precedence over rad_pattern_p and rad_pattern_s.

Returns:

rad_patternfloat

Radiation-pattern magnitude to use.

Raises:

ValueError

If a resolved value is not in the interval (0, 1].