docs and proper n_sigma=0 path

docs/src/index.rst

@@ -28,6 +28,7 @@ AARE
     pycalibration
     python/cluster/index
     python/file/index
+    python/histogram/index
     pyFit
     
 
@@ -63,4 +64,4 @@ AARE
     
     Philosophy
     Workflow
-    Tests
+    Tests

docs/src/python/histogram/index.rst

@@ -0,0 +1,9 @@
+Histogram
+=========
+
+.. toctree::
+   :caption: Histogram
+   :maxdepth: 1
+
+   pyPixelHistogram
+   pyPedestalTrackingPixelHistogram

docs/src/python/histogram/pyPedestalTrackingPixelHistogram.rst

@@ -0,0 +1,24 @@
+PedestalTrackingPixelHistogram
+==============================
+
+.. warning::
+
+    ``PedestalTrackingPixelHistogram`` is specifically designed for use in the Jungfrau calibration
+    pipeline. Make sure you understand the behaviour before using it in other contexts.
+
+``PedestalTrackingPixelHistogram`` accumulates a pixel-wise histogram of
+``frame - pedestal`` residuals while maintaining a running per-pixel pedestal
+estimate.
+
+Use ``push_pedestal_no_update()`` to seed the pedestal estimate, then
+``update_mean()`` before submitting frames with ``fill_async()``. Pending
+asynchronous fills are drained by ``flush()``, and snapshot methods such as
+``values()`` and ``pedestal_mean()`` return numpy arrays.
+
+.. py:currentmodule:: aare
+
+.. autoclass:: PedestalTrackingPixelHistogram
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:

docs/src/python/histogram/pyPixelHistogram.rst

@@ -0,0 +1,41 @@
+PixelHistogram
+==============
+
+``PixelHistogram`` accumulates one histogram per detector pixel from 2D
+``float64`` images. The public ``PixelHistogram`` name is an alias for
+``PixelHistogram_d``, which stores bin counts as ``float64``.
+
+.. note::
+
+    ``PixelHistogram`` is designed for fast filling from 2D images, utilizing multiple threads, 
+    and contiguous storage of a specific type. No over/underflow bins are provided. For generic use cases consider
+    boost-histogram. (https://boost-histogram.readthedocs.io/en/latest/)
+
+
+Storage-specific variants are also available when a smaller or integer count
+type is preferred:
+
+* ``PixelHistogram_d``: ``float64`` storage
+* ``PixelHistogram_f``: ``float32`` storage
+* ``PixelHistogram_u64``: ``uint64`` storage
+* ``PixelHistogram_u32``: ``uint32`` storage
+* ``PixelHistogram_u16``: ``uint16`` storage
+* ``PixelHistogram_u8``: ``uint8`` storage
+
+.. py:currentmodule:: aare
+
+.. autoclass:: PixelHistogram
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
+
+Showing API for PixelHistogram_d, all variant share the same API.
+
+.. autoclass:: aare._aare.PixelHistogram_d
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
+    :noindex:
+