Struct HistogramSnapshot 

pub struct HistogramSnapshot {

    pub kind: HistogramSnapshotKind,
    pub title: String,
    pub type_description: String,
    pub phase: ObservablePhase,
    pub value_transform: ObservableValueTransform,
    pub supports_misbinning_mitigation: bool,
    pub x_min: Option<f64>,
    pub x_max: Option<f64>,
    pub sample_count: usize,
    pub log_x_axis: bool,
    pub log_y_axis: bool,
    pub discrete_min_bin_id: Option<isize>,
    pub discrete_ordering: Option<DiscreteBinOrdering>,
    pub bins: Vec<HistogramBinSnapshot>,
    pub underflow_bin: HistogramBinSnapshot,
    pub overflow_bin: HistogramBinSnapshot,
    pub statistics: HistogramStatisticsSnapshot,
}

Fields

kind: HistogramSnapshotKind

Determines whether bins represent continuous ranges or discrete identifiers.

title: String

Human-readable histogram title used by JSON and HwU output.

type_description: String

HwU TYPE@ description retained with the histogram metadata.

phase: ObservablePhase

Real or imaginary component of the complex event weight accumulated in this histogram.

value_transform: ObservableValueTransform

Transformation applied to observable coordinates before continuous binning.

supports_misbinning_mitigation: bool

Whether the observable supports paired fills that mitigate boundary misbinning.

x_min: Option<f64>

Lower bound of a continuous histogram, or None for a discrete histogram.

x_max: Option<f64>

Upper bound of a continuous histogram, or None for a discrete histogram.

sample_count: usize

Number of statistically independent Monte Carlo samples represented by the snapshot.

log_x_axis: bool

Whether compatible renderers should display the horizontal axis logarithmically.

log_y_axis: bool

Whether compatible renderers should display the vertical axis logarithmically.

discrete_min_bin_id: Option<isize>

Smallest discrete bin identifier, or None for a continuous histogram.

discrete_ordering: Option<DiscreteBinOrdering>

Display ordering for discrete bins, or None for a continuous histogram.

bins: Vec<HistogramBinSnapshot>

Raw statistics for every in-range bin.

underflow_bin: HistogramBinSnapshot

Raw statistics for entries below the configured histogram range.

overflow_bin: HistogramBinSnapshot

Raw statistics for entries above the configured histogram range.

statistics: HistogramStatisticsSnapshot

Histogram-wide entry, non-finite-value, and mitigation counters.

Implementations

impl HistogramSnapshot

pub fn to_json_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

pub fn from_json_file<P: AsRef<Path>>(path: P) -> Result<Self>

pub fn merge(&self, other: &HistogramSnapshot) -> Result<Self>

pub fn merged(&self, other: &HistogramSnapshot) -> Result<Self>

pub fn merge_in_place(&mut self, other: &HistogramSnapshot) -> Result<()>

pub fn rescale(&mut self, factor: f64)

pub fn rescaled(&self, factor: f64) -> Self

pub fn change_bin_ordering( &mut self, ordering: DiscreteBinOrdering, ) -> Result<()>

pub fn changed_bin_ordering( &self, ordering: DiscreteBinOrdering, ) -> Result<Self>

pub fn rebin(&self, contiguous_bins: usize) -> Result<Self>

pub fn rebinned(&self, contiguous_bins: usize) -> Result<Self>

pub fn into_accumulator_state(self) -> HistogramAccumulatorState

Trait Implementations

impl Clone for HistogramSnapshot

fn clone(&self) -> HistogramSnapshot

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HistogramSnapshot

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HistogramSnapshot

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HistogramSnapshot

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for HistogramSnapshot

fn eq(&self, other: &HistogramSnapshot) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HistogramSnapshot

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HistogramSnapshot