Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Commit

Permalink
fix(propagate_DWT): adjust __all__ variable
Browse files Browse the repository at this point in the history
  • Loading branch information
Maximilian Gruber committed Mar 17, 2020
1 parent 76d978e commit 4a3fd5e
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion PyDynamic/uncertainty/propagate_DWT.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from PyDynamic.uncertainty.propagate_filter import IIRuncFilter, get_initial_state, FIRuncFilter


__all__ = ["dwt", "wave_dec", "idwt", "wave_rec", "filter_design"]
__all__ = ["dwt", "wave_dec", "wave_dec_realtime", "idwt", "wave_rec", "filter_design"]


def dwt(x, Ux, l, h, kind, states=None, realtime=False, subsample_start=1):
Expand Down Expand Up @@ -40,6 +40,10 @@ def dwt(x, Ux, l, h, kind, states=None, realtime=False, subsample_start=1):
only meaningfull in combination with isinstance(Ux, numpy.ndarray)
"diag": point-wise standard uncertainties of non-stationary white noise
"corr": single sided autocovariance of stationary (colored/corrlated) noise (default)
states: dictionary of internal high/lowpass-filter states
allows to continue at the last used internal state from previous call
realtime: Boolean
for realtime applications, no signal padding has to be done before decomposition
Returns
-------
Expand All @@ -51,6 +55,8 @@ def dwt(x, Ux, l, h, kind, states=None, realtime=False, subsample_start=1):
subsampled high-pass output signal
U_detail: np.ndarray
subsampled high-pass output uncertainty
states: dictionary of internal high/lowpass-filter states
allows to continue at the last used internal state in next call
"""

# prolongate signals if no realtime is needed
Expand Down Expand Up @@ -103,13 +109,19 @@ def idwt(c_approx, U_approx, c_detail, U_detail, l, h, kind, states=None, realti
only meaningfull in combination with isinstance(Ux, numpy.ndarray)
"diag": point-wise standard uncertainties of non-stationary white noise
"corr": single sided autocovariance of stationary (colored/corrlated) noise (default)
states: dictionary of internal high/lowpass-filter states
allows to continue at the last used internal state from previous call
realtime: Boolean
for realtime applications, no signal padding has to be undone after reconstruction
Returns
-------
x: np.ndarray
upsampled reconstructed signal
Ux: np.ndarray
upsampled uncertainty of reconstructed signal
states: dictionary of internal high/lowpass-filter states
allows to continue at the last used internal state in next call
"""

# upsample to double the length
Expand Down

0 comments on commit 4a3fd5e

Please sign in to comment.