nessai.utils.hist
=================

.. py:module:: nessai.utils.hist

.. autoapi-nested-parse::

   Utilities related to histogramming.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   nessai.utils.hist.auto_bins


Module Contents
---------------

.. py:function:: auto_bins(x, max_bins=50)

   
   Compute the number bins for a histogram using numpy.histogram_bin_edges
   but enforces a maximum number of bins.


   :Parameters:

       **array** : array_like
           Input data

       **bins** : int or sequence of scalars or str, optional
           Method for determining number of bins, see numpy documentation

       **max_bins** : int, optional (1000)
           Maximum number of bins



   :Returns:

       int
           Number of bins











   ..
       !! processed by numpydoc !!