Module mjoindices.omi.quick_temporal_filter¶

This module provides a simple 1-dim filtering algorithm, which can be used during the PC calculation instead of the full 2-dim Wheeler-Kiladis-Filter.

This module is not intended to be used stand-alone outside the OMI context, as it has only been extensively tested for the specific OMI filtering conditions.

Hence, there is usually no need for the users of the mjoindices package to call functions of this module themselves. Instead, they probably want to use the module mjoindices.omi.omi_calculator directly.

mjoindices.omi.quick_temporal_filter.filter_olr_for_mjo_pc_calculation_1d_spectral_smoothing(olrdata: OLRData) → OLRData[source]¶

Filters OLR data temporally using a 1d Fourier transform filter.

The temporal filtering constants are chosen to meet the values in the description by Kiladis et al. (2014).

Parameters:: olrdata – The original OLR data
Returns:: The filtered OLR.

mjoindices.omi.quick_temporal_filter.filter_olr_temporally_1d_spectral_smoothing(olrdata: OLRData, period_min: float, period_max: float) → OLRData[source]¶

Filters OLR data temporally using a 1d Fourier transform filter.

Parameters:

olrdata – The original OLR data
period_min – Temporal filter constant: Only greater periods (in days) remain in the data.
period_max – Temporal filter constant: Only lower periods (in days) remain in the data.

Returns:

The filtered OLR.