update the pad utility function and make it part of the public API #478
Conversation
correct boundary mode name: zeros->zero
DOC: enable intersphinx extension to allow linking to numpy docs DOC: consistently link Modes documentation from docstrings
pywt/_dwt.py
Outdated
| def pad(x, pad_widths, mode): | ||
| """Extend a 1D signal using a given boundary mode. | ||
|
|
||
| This function operates like ``numpy.pad`` but supports all signal extension |
There was a problem hiding this comment.
given that you added intersphinx, I think you wanted this to be single backticks to create a link?
There was a problem hiding this comment.
That just gave me numpy.pad in italics. To get the intersphinx link to work I have to use :func:`numpy.pad`. Is there a configuration option that removes the need for explicitly adding :func:? What do you prefer?
There was a problem hiding this comment.
I know for SciPy it works, see for example sweep_poly linking to numpy.poly1d in its Notes section.
In the SciPy conf.py I don't immediately see what makes it work though, and that conf.py isn't exactly maintainable. So happy to use :func: here, simpler.
There was a problem hiding this comment.
In the SciPy conf.py I don't immediately see what makes it work though
in a recent discussion at scikit-image, @NelleV indicated that it is the presence of
default_role = "autolink" in SciPy's conf.py
(We have not set a default_role in PyWavelets conf.py)
|
Merged, thanks @grlee77! |
This PR moves
padfrom_doc_utils.pyto_dwt.pyand adds it to the top-level API (aspywt.pad). I chose_dwt.pybecause the DWT-based functions are the ones that currently use this type of boundary handling, but it could just as well go into_utils.pyor elsewhere.The function was updated to have n-dimensional support and handle
pad_widthsin a manner consistent with NumPy .The handling of pad_widths is based on inspection of numpy.lib.arraypad._as_pairs. Because it is not part of the public numpy API, I thought it was best to just replicate the behavior locally.
closes #473