lookfor.py 845 B

123456789101112131415161718192021222324252627282930313233
  1. import sys
  2. from .._vendored.numpy_lookfor import lookfor as _lookfor
  3. __doctest_requires__ = {("lookfor",): ["SimpleITK"]}
  4. def lookfor(what):
  5. """Do a keyword search on scikit-image docstrings and print results.
  6. .. warning::
  7. This function may also print results that are not part of
  8. scikit-image's public API.
  9. Parameters
  10. ----------
  11. what : str
  12. Words to look for.
  13. Examples
  14. --------
  15. >>> import skimage as ski
  16. >>> ski.util.lookfor('regular_grid')
  17. Search results for 'regular_grid'
  18. ---------------------------------
  19. skimage.util.regular_grid
  20. Find `n_points` regularly spaced along `ar_shape`.
  21. skimage.util.lookfor
  22. Do a keyword search on scikit-image docstrings and print results.
  23. """
  24. return _lookfor(what, sys.modules[__name__.split('.')[0]])