Skip to main content
`Ctrl`+`K`

# hist

astropy.visualization.hist(x, bins=10, ax=None, max_bins=100000.0, **kwargs)

  Enhanced histogram function.

  This is a histogram function that enables the use of more sophisticated algorithms for determining bins. Aside from the `bins` argument allowing a string specified how bins are computed, the parameters are the same as matplotlib.pyplot.hist().

  This function was ported from astroML: https://www.astroml.org/

  Parameters:
    x numpy:array_like

      array of data to be histogrammed

    bins `python:int`, `python:list`, or `python:str`, optional

      If bins is a string, then it must be one of:

      - ‘blocks’ : use bayesian blocks for dynamic bin widths

      - ‘knuth’ : use Knuth’s rule to determine bins

      - ‘scott’ : use Scott’s rule to determine bins

      - ‘freedman’ : use the Freedman-Diaconis rule to determine bins

    ax `Axes` instance, optional

      Specify the Axes on which to draw the histogram. If not specified, then the current active axes will be used.

    max_bins `python:int`, optional

      Maximum number of bins allowed. With more than a few thousand bins the performance of matplotlib will not be great. If the number of bins is large and the number of input data points is large then the it will take a very long time to compute the histogram.

    **kwargs

      other keyword arguments are described in `plt.hist()`.

  See also

  `astropy.stats.histogram`

  Notes

  Return values are the same as for `plt.hist()`