.. _Histogram:


The Histogram class
-------------------

.. autoclass:: rockverse.voxel_image.histogram.Histogram

   .. rubric:: Attributes summary

   .. autosummary::

      ~Histogram.image
      ~Histogram.region
      ~Histogram.mask
      ~Histogram.segmentation
      ~Histogram.phases
      ~Histogram.bins
      ~Histogram.bin_centers
      ~Histogram.min
      ~Histogram.max
      ~Histogram.count
      ~Histogram.pdf
      ~Histogram.cdf

   .. rubric:: Methods summary

   .. autosummary::
      ~Histogram.percentile


   .. rubric:: Attributes documentation

   .. autoattribute:: image
   .. autoattribute:: region
   .. autoattribute:: mask
   .. autoattribute:: segmentation
   .. autoattribute:: phases
   .. autoattribute:: bins
   .. autoattribute:: bin_centers
   .. autoattribute:: min
   .. autoattribute:: max
   .. autoattribute:: count
   .. autoattribute:: pdf
   .. autoattribute:: cdf

   .. rubric:: Methods

   .. automethod:: percentile