aptapy 0.3.1__py3-none-any.whl → 0.3.2__py3-none-any.whl

aptapy/_version.py

@@ -1 +1 @@
-__version__ = "0.3.1"
+__version__ = "0.3.2"

aptapy/hist.py

@@ -17,7 +17,7 @@
 """
 
 from abc import ABC, abstractmethod
-from typing import List, Sequence
+from typing import List, Sequence, Tuple
 
 import numpy as np
 
@@ -93,6 +93,43 @@ class AbstractHistogram(ABC):
         """
         return np.diff(self._edges[axis])
 
+    def binned_statistics(self, axis: int = 0) -> Tuple[float, float]:
+        """Return the mean and standard deviation along a specific axis, based
+        on the binned data.
+
+        .. note::
+
+           This is a crude estimate of the underlying statistics that might be
+           useful for monitoring purposes, but should not be relied upon for
+           quantitative analysis.
+
+           This is not the same as computing the mean and standard deviation of
+           the unbinned data that filled the histogram, as some information is
+           lost in the binning process.
+
+           In addition, note that we are not applying any bias correction to
+           the standard deviation, as we are assuming that the histogram is
+           filled with a sufficiently large number of entries. (In most circumstances
+           the effect should be smaller than that of the binning itself.)
+
+        Arguments
+        ---------
+        axis : int
+            the axis along which to compute the statistics.
+
+        Returns
+        -------
+        mean : float
+            the mean value along the specified axis.
+        stddev : float
+            the standard deviation along the specified axis.
+        """
+        values = self.bin_centers(axis)
+        weights = self.content.sum(axis=tuple(i for i in range(self.content.ndim) if i != axis))
+        mean = np.average(values, weights=weights)
+        variance = np.average((values - mean)**2, weights=weights)
+        return float(mean), float(np.sqrt(variance))
+
     def fill(self, *values: ArrayLike, weights: ArrayLike = None) -> "AbstractHistogram":
         """Fill the histogram from unbinned data.
 
@@ -229,10 +266,18 @@ class Histogram1d(AbstractHistogram):
         """
         # If we are not explicitly providing a label at plotting time, use
         # the one attached to the histogram, if any.
-        kwargs.setdefault('label', self.label)
+        kwargs.setdefault("label", f"{self}")
         axes.hist(self.bin_centers(0), self._edges[0], weights=self.content, **kwargs)
         setup_axes(axes, xlabel=self.axis_labels[0], ylabel=self.axis_labels[1])
 
+    def __str__(self) -> str:
+        """String formatting.
+        """
+        mean, rms = self.binned_statistics()
+        text = self.label or self.__class__.__name__
+        text = f"{text}\nMean: {mean:g}\nRMS: {rms:g}"
+        return text
+
 
 class Histogram2d(AbstractHistogram):
 
@@ -259,10 +304,10 @@ class Histogram2d(AbstractHistogram):
         the text label for the z axis (default: "Entries/bin").
     """
 
-    DEFAULT_PLOT_OPTIONS = dict(cmap=plt.get_cmap('hot'))
+    DEFAULT_PLOT_OPTIONS = dict(cmap=plt.get_cmap("hot"))
 
     def __init__(self, xedges, yedges, label: str = None, xlabel: str = None,
-                 ylabel: str = None, zlabel: str = 'Entries/bin') -> None:
+                 ylabel: str = None, zlabel: str = "Entries/bin") -> None:
         """Constructor.
         """
         super().__init__((xedges, yedges), label, [xlabel, ylabel, zlabel])
@@ -272,9 +317,9 @@ class Histogram2d(AbstractHistogram):
         """
         # pylint: disable=arguments-differ
         if logz:
-            vmin = kwargs.pop('vmin', None)
-            vmax = kwargs.pop('vmax', None)
-            kwargs.setdefault('norm', matplotlib.colors.LogNorm(vmin, vmax))
+            vmin = kwargs.pop("vmin", None)
+            vmax = kwargs.pop("vmax", None)
+            kwargs.setdefault("norm", matplotlib.colors.LogNorm(vmin, vmax))
         mappable = axes.pcolormesh(*self._edges, self.content.T, **kwargs)
         plt.colorbar(mappable, ax=axes, label=self.axis_labels[2])
         setup_axes(axes, xlabel=self.axis_labels[0], ylabel=self.axis_labels[1])

aptapy/modeling.py

@@ -316,10 +316,10 @@ class FitStatus:
         if self.chisquare is None:
             return "N/A"
         if spec.endswith(Format.LATEX):
-            return f"$\\chi^2$ = {self.chisquare:.2f} / {self.dof} dof"
+            return f"$\\chi^2$: {self.chisquare:.2f} / {self.dof} dof"
         if spec.endswith(Format.PRETTY):
-            return f"χ² = {self.chisquare:.2f} / {self.dof} dof"
-        return f"chisquare = {self.chisquare:.2f} / {self.dof} dof"
+            return f"χ²: {self.chisquare:.2f} / {self.dof} dof"
+        return f"chisquare: {self.chisquare:.2f} / {self.dof} dof"
 
     def __str__(self) -> str:
         """String formatting.

{aptapy-0.3.1.dist-info → aptapy-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aptapy
-Version: 0.3.1
+Version: 0.3.2
 Summary: Statistical tools for online monitoring and analysis
 Project-URL: Homepage, https://github.com/lucabaldini/aptapy
 Project-URL: Issues, https://github.com/lucabaldini/aptapy/issues

aptapy-0.3.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+aptapy/__init__.py,sha256=a7Au1ukdeJbjiIZ-UL-qZE1xk-d2WnKKkoqjg_0SzqA,1707
+aptapy/_version.py,sha256=vNiWJ14r_cw5t_7UDqDQIVZvladKFGyHH2avsLpN7Vg,22
+aptapy/hist.py,sha256=ZY9Yfqr4ImtUTxKirprSS6FEGKkSj3q7EsXKpTiIs6U,11534
+aptapy/modeling.py,sha256=PK5OSVeQZAizlLBwg67oqt_MfKAbc5P3y0K_WVL0yCs,32563
+aptapy/plotting.py,sha256=p9YNdrcFcTimRCtoXcV3zORaEd4EfMtsDd4ETxGKKHM,27483
+aptapy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aptapy/strip.py,sha256=qGsVXWp-Dz-lz7KQxktMifUTNkSxh8ZQwYme8_bealQ,3026
+aptapy/typing_.py,sha256=JIbEqKI8kn_fd90yDt0JmI1AojjmLhAEB_1RfMFxLx4,807
+aptapy-0.3.2.dist-info/METADATA,sha256=Cc2Ct3DH0htSAiNpwC5OWuVywtTijpaboUepUUGWq9g,42796
+aptapy-0.3.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+aptapy-0.3.2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+aptapy-0.3.2.dist-info/RECORD,,

aptapy-0.3.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-aptapy/__init__.py,sha256=a7Au1ukdeJbjiIZ-UL-qZE1xk-d2WnKKkoqjg_0SzqA,1707
-aptapy/_version.py,sha256=r4xAFihOf72W9TD-lpMi6ntWSTKTP2SlzKP1ytkjRbI,22
-aptapy/hist.py,sha256=jvHULR2lW_gyoemNaRI-vpqhFqmLLCB319CaKjwU69E,9752
-aptapy/modeling.py,sha256=mHHHFMYmMuXTRQD2yR1XLM6E4KaBk8md7Z7dDp5ReD8,32566
-aptapy/plotting.py,sha256=p9YNdrcFcTimRCtoXcV3zORaEd4EfMtsDd4ETxGKKHM,27483
-aptapy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aptapy/strip.py,sha256=qGsVXWp-Dz-lz7KQxktMifUTNkSxh8ZQwYme8_bealQ,3026
-aptapy/typing_.py,sha256=JIbEqKI8kn_fd90yDt0JmI1AojjmLhAEB_1RfMFxLx4,807
-aptapy-0.3.1.dist-info/METADATA,sha256=KZP-aljwTsIKUi-1nE-X9ZfIxc44ijFhKCkoyK0EXjY,42796
-aptapy-0.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-aptapy-0.3.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-aptapy-0.3.1.dist-info/RECORD,,