Skip to content

Commit

Permalink
Merge pull request #621 from girder/fix-histogram-docstring
Browse files Browse the repository at this point in the history
Improve histogram docstring.
  • Loading branch information
manthey authored Jul 6, 2021
2 parents eb1bb36 + a424e48 commit bb2a280
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions large_image/tilesource/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1393,6 +1393,15 @@ def histogram(self, dtype=None, onlyMinMax=False, bins=256,
accessible via kwargs as it otherwise overloads the range function.
:param args: parameters to pass to the tileIterator.
:param kwargs: parameters to pass to the tileIterator.
:returns: if onlyMinMax is true, this is a dictionary with keys min and
max, each of which is a numpy array with the minimum and maximum of
all of the bands. If onlyMinMax is False, this is a dictionary
with a single key 'histogram' that contains a list of histograms
per band. Each entry is a dictionary with min, max, range, hist,
and bin_edges. range is [min, (max + 1)]. hist is the counts
(normalized if density is True) for each bin. bin_edges is an
array one longer than the hist array that contains the boundaries
between bins.
"""
kwargs = kwargs.copy()
histRange = kwargs.pop('range', None)
Expand Down

0 comments on commit bb2a280

Please sign in to comment.