libtcspc.ConcludingHistogramArrayEvent¶
- class libtcspc.ConcludingHistogramArrayEvent(numeric_traits=None)[source]¶
Bases:
EventTypeEvent carrying the final accumulated histogram array of a round.
Emitted by
ScanHistograms(when concluding events are enabled) once per round, before each reset.- Parameters:
numeric_traits (NumericTraits or None) – Set of integer types parameterising the C++ event.
None(the default) usesNumericTraitsdefaults.
Notes
The corresponding C++ event has the field
data_bucket, atcspc::bucketofbin_type.Can be delivered directly to a Python sink as an
EventInstancewhosedata_bucketattribute reads as a read-only NumPy array, and constructed viavalue()(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.See also
- tcspc::concluding_histogram_array_event
The underlying C++ event type.
ExtractBucketExtract the carried bucket as a bare NumPy array (without the event wrapper).