GaussianSummary.GaussianSummary Class Reference

Collaboration diagram for GaussianSummary.GaussianSummary:

Public Member Functions
"GaussianSummary"	from_cpp (cls, Any cpp_obj)
	to_cpp (self)

Static Public Attributes
BinnedObservableId	id
float	mu = 0.0
float	sigma = 0.0
float	sigma_p = 0.0
float	sigma_m = 0.0
float	mode = 0.0
float	skew = 0.0
bool	symmetric = False

Detailed Description

Gaussian or split-Gaussian approximation of one observable distribution.

This class mirrors the C++ ``GaussianSummary`` struct returned by the
Monte-Carlo uncertainty machinery. When the empirical skewness is small, the
distribution is summarized by ``mu`` and ``sigma``. Otherwise, the backend
also provides a mode and asymmetric widths ``sigma_p`` and ``sigma_m``.

Attributes:
    id: Binned observable identifier.
    mu: Population mean of the sampled observable.
    sigma: Unbiased standard deviation used in the symmetric approximation.
    sigma_p: Right-side width for a split-Gaussian approximation.
    sigma_m: Left-side width for a split-Gaussian approximation.
    mode: Estimated population mode.
    skew: Empirical skewness estimator.
    symmetric: Whether the backend classified the sample as symmetric.

Examples:
    >>> summary = GaussianSummary(id=obs_id, mu=1.0, sigma=0.1, symmetric=True)
    >>> summary.mu, summary.sigma
    (1.0, 0.1)

Definition at line 13 of file GaussianSummary.py.

Member Function Documentation

from_cpp()

"GaussianSummary" GaussianSummary.GaussianSummary.from_cpp	(		cls,
		Any	cpp_obj
	)

Create a Python summary from a bound C++ summary.

Args:
    cpp_obj: Bound C++ ``GaussianSummary`` instance.

Returns:
    The equivalent Python dataclass.

Definition at line 47 of file GaussianSummary.py.

to_cpp()

GaussianSummary.GaussianSummary.to_cpp

(

self

)

Convert this dataclass to a bound C++ ``GaussianSummary``.

Returns:
    A newly allocated bound C++ summary object.

Definition at line 67 of file GaussianSummary.py.

Member Data Documentation

id

BinnedObservableId GaussianSummary.GaussianSummary.id

static

Definition at line 37 of file GaussianSummary.py.

mode

float GaussianSummary.GaussianSummary.mode = 0.0

static

Definition at line 42 of file GaussianSummary.py.

mu

float GaussianSummary.GaussianSummary.mu = 0.0

static

Definition at line 38 of file GaussianSummary.py.

sigma

float GaussianSummary.GaussianSummary.sigma = 0.0

static

Definition at line 39 of file GaussianSummary.py.

sigma_m

float GaussianSummary.GaussianSummary.sigma_m = 0.0

static

Definition at line 41 of file GaussianSummary.py.

sigma_p

float GaussianSummary.GaussianSummary.sigma_p = 0.0

static

Definition at line 40 of file GaussianSummary.py.

skew

float GaussianSummary.GaussianSummary.skew = 0.0

static

Definition at line 43 of file GaussianSummary.py.

symmetric

bool GaussianSummary.GaussianSummary.symmetric = False

static

Definition at line 44 of file GaussianSummary.py.

---

The documentation for this class was generated from the following file:

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/pyhyperiso/core/Statistic/GaussianSummary.py