Skip to content

Commit

Permalink
DOC: describe idwt2 behavior for coefficients set to None.
Browse files Browse the repository at this point in the history
  • Loading branch information
grlee77 committed Mar 7, 2017
1 parent 493561d commit 0367caf
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions pywt/_multidim.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ def idwt2(coeffs, wavelet, mode='symmetric', axes=(-2, -1)):
----------
coeffs : tuple
(cA, (cH, cV, cD)) A tuple with approximation coefficients and three
details coefficients 2D arrays like from `dwt2()`
details coefficients 2D arrays like from `dwt2()`. If any of these
components are set to ``None``, it will be treated as zeros.
wavelet : Wavelet object or name string, or 2-tuple of wavelets
Wavelet to use. This can also be a tuple containing a wavelet to
apply along each axis in ``axes``.
Expand Down Expand Up @@ -220,8 +221,8 @@ def idwtn(coeffs, wavelet, mode='symmetric', axes=None):
Parameters
----------
coeffs: dict
Dictionary as in output of `dwtn`. Missing or None items
will be treated as zeroes.
Dictionary as in output of ``dwtn``. Missing or ``None`` items
will be treated as zeros.
wavelet : Wavelet object or name string, or tuple of wavelets
Wavelet to use. This can also be a tuple containing a wavelet to
apply along each axis in ``axes``.
Expand Down

0 comments on commit 0367caf

Please sign in to comment.