twistpy.polarization.PolarizationModel3C#

class PolarizationModel3C(wave_type: str, scaling_velocity: float = 1, free_surface: bool = True, vp: Optional[ndarray] = None, vs: Optional[ndarray] = None, vl: Optional[ndarray] = None, vr: Optional[ndarray] = None, theta: Optional[ndarray] = None, phi: Optional[ndarray] = None, xi: Optional[ndarray] = None)[source]#

Three-component pure-state polarization model.

This class computes the three-component pure-state polarization vectors for the specified wave-type and wave-parameters. Polarization models can either be computed for recordings at the free surface or inside the medium. If the wave parameters are provided as an array, polarization vectors are generated for each entry.

Parameters
wave_typestr

Wave type for which the polarization model is computed. The following options are available:

‘P’: P-wave
‘SV’: SV-wave
‘SH’: SH-wave
‘L’: Love-wave
‘R’: Rayleigh-wave
vpnumpy.ndarray

P-wave velocity (m/s) at the receiver location (only relevant for free-surface models)

vsnumpy.ndarray

S-wave velocity (m/s) at the receiver location (only relevant for free-surface models)

thetanumpy.ndarray

Inclination angle (degree), only for body waves

xinumpy.ndarray

Ellipticity angle (degree), for Rayleigh waves

free_surfacebool

True (default): the wave is recorded at the free surface, False: the wave is recorded inside the medium

Methods

Attributes

polarization_vector

Pure state three-component polarization vector

Examples using twistpy.polarization.PolarizationModel3C#

3-C Polarization analysis and filtering in the time domain

3-C Polarization analysis and filtering in the time domain

3-C Polarization analysis and filtering in the time-frequency domain

3-C Polarization analysis and filtering in the time-frequency domain