Skip to content

Commit b626ee4

Browse files
committed
DOC: describe idwt2 behavior for coefficients set to None.
1 parent 5d87261 commit b626ee4

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

pywt/_multidim.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,14 @@ def idwt2(coeffs, wavelet, mode='symmetric', axes=(-2, -1)):
7979
----------
8080
coeffs : tuple
8181
(cA, (cH, cV, cD)) A tuple with approximation coefficients and three
82-
details coefficients 2D arrays like from `dwt2()`
82+
details coefficients 2D arrays like from `dwt2`. If any of these
83+
components are set to ``None``, it will be treated as zeros.
8384
wavelet : Wavelet object or name string
8485
Wavelet to use
8586
mode : str, optional
8687
Signal extension mode, see Modes (default: 'symmetric')
88+
details coefficients 2D arrays like from `dwt2`. If any of these
89+
components are set to ``None``, it will be treated as zeros.
8790
axes : 2-tuple of ints, optional
8891
Axes over which to compute the IDWT. Repeated elements mean the IDWT
8992
will be performed multiple times along these axes.
@@ -211,8 +214,8 @@ def idwtn(coeffs, wavelet, mode='symmetric', axes=None):
211214
Parameters
212215
----------
213216
coeffs: dict
214-
Dictionary as in output of `dwtn`. Missing or None items
215-
will be treated as zeroes.
217+
Dictionary as in output of `dwtn`. Missing or ``None`` items
218+
will be treated as zeros.
216219
wavelet : Wavelet object or name string
217220
Wavelet to use
218221
mode : str, optional

0 commit comments

Comments
 (0)