libtcspc.HistogramArrayProgressEvent¶

class libtcspc.HistogramArrayProgressEvent(numeric_traits=None)[source]¶

Bases: EventType

Event reporting progress while accumulating a histogram array.

Emitted by ScanHistograms on each bin-increment cluster, carrying a view of the entire histogram array updated so far.

Parameters:: numeric_traits (NumericTraits or None) – Set of integer types parameterising the C++ event. None (the default) uses NumericTraits defaults.

Notes

The corresponding C++ event has the fields valid_size and data_bucket (a tcspc::bucket of bin_type).

Can be delivered directly to a Python sink as an EventInstance whose data_bucket attribute reads as a read-only NumPy array, and constructed via value() (the bucket field accepts a 1-D array-like).

Receiving these events at a Python sink and reading the carried bucket as a NumPy array is an efficient bulk transfer intended for production use. Constructing an individual instance by hand via value(), on the other hand, is intended for debugging and learning only.