HistogramSnapshot

gammaloop Class

HistogramSnapshot()

Immutable, mergeable histogram snapshot containing raw per-bin statistics.

Member details

`kind`

Property · read-only

kind: str

"continuous" or "discrete".

`title`

Property · read-only

title: str

Human-readable histogram title.

`type_description`

Property · read-only

type_description: str

HwU TYPE@ description retained with the histogram.

`phase`

Property · read-only

phase: str

Complex-weight component accumulated: "real" or "imag".

`value_transform`

Property · read-only

value_transform: str

Coordinate transform: "identity" or "log10".

`supports_misbinning_mitigation`

Property · read-only

supports_misbinning_mitigation: bool

Whether paired fills can mitigate bin-boundary instability.

`x_min`

Property · read-only

x_min: Optional[float]

Lower bound of a continuous histogram, otherwise None.

`x_max`

Property · read-only

x_max: Optional[float]

Upper bound of a continuous histogram, otherwise None.

`sample_count`

Property · read-only

sample_count: int

Number of statistically independent Monte Carlo samples represented.

`log_x_axis`

Property · read-only

log_x_axis: bool

Whether compatible renderers should use a logarithmic horizontal axis.

`log_y_axis`

Property · read-only

log_y_axis: bool

Whether compatible renderers should use a logarithmic vertical axis.

`discrete_min_bin_id`

Property · read-only

discrete_min_bin_id: Optional[int]

Smallest discrete bin identifier, otherwise None.

`discrete_ordering`

Property · read-only

discrete_ordering: Optional[str]

Discrete display ordering, otherwise None.

`bins`

Property · read-only

bins: list[HistogramBin]

Raw statistics for every in-range bin, in display order.

`underflow_bin`

Property · read-only

underflow_bin: HistogramBin

Raw statistics for entries below a continuous histogram's range.

`overflow_bin`

Property · read-only

overflow_bin: HistogramBin

Raw statistics for entries above a continuous histogram's range.

`statistics`

Property · read-only

statistics: HistogramStats

Histogram-wide entry and mitigation counters.

View generated signature source: docs/api/python/gammaloop-python.pyi:1266