Skip to content

Commit

Permalink
Update the docstring of eq_hist (#1322)
Browse files Browse the repository at this point in the history
  • Loading branch information
maximlt authored Apr 10, 2024
1 parent 9321159 commit 8b6c3a0
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion datashader/transfer_functions/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ def stack(*imgs, **kwargs):


def eq_hist(data, mask=None, nbins=256*256):
"""Return a numpy array after histogram equalization.
"""Compute the numpy array after histogram equalization.
For use in `shade`.
Expand All @@ -152,6 +152,12 @@ def eq_hist(data, mask=None, nbins=256*256):
this will determine when to switch from exact unique value counts to
a binned histogram.
Returns
-------
ndarray or tuple(ndarray, int)
Returns the array when mask isn't set, otherwise returns the
array and the computed number of discrete levels.
Notes
-----
This function is adapted from the implementation in scikit-image [1]_.
Expand Down

0 comments on commit 8b6c3a0

Please sign in to comment.