twistpy.polarization.TimeDomainAnalysis3C.filter

TimeDomainAnalysis3C.filter(suppress: bool = False, smooth_mask: bool = False, plot_filtered_attributes: bool = False, **kwargs)

Filter data based on polarization attributes.

Parameters

**kwargsFor example elli=[0, 0.3]

Polarization attributes used for filtering. The filter parameters are specified as a list with two entries, specifying the range of the polarization attributes that are kept by the filter. In the above example the filter would only retain all signal with an ellipticity between 0 and 0.3 and suppress all signal with an ellipticity larger than 0.3. Multiple polarization attributes can be specified.

Hint

Supported polariziation attributes are:

dop (degree of polarization)

elli (Ellipticity)

inc1 (Incidence angle of major semi axis)

inc2 (Incidence angle of minor semi axis)

azi1 (Azimuth of the major semi axis)

azi2 (Azimuth of the minor semi axis)

suppressbool, default = False

If set to True the polarization states that fulfill the filtering criterion will be suppressed from the data while preserving any underlying signal that is orthogonal to the polarization state.

smooth_maskbool, default = False

If set to True, the filter mask will be additionally smoothed.

plot_filtered_attributesbool, default = False

If set to True, a plot will be generated that shows the polarization attributes after filtering

Returns

data_filteredStream

Filtered data. The order of traces in the stream is N, E, Z.