libtcspc.BinIncrementEvent¶

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

Bases: EventType

Event representing a single increment of a histogram bin.

Emitted by MapToBins and consumed by Histogram and ClusterBinIncrements.

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 field bin_index (of bin_index_type).

A value is constructed by giving all fields, e.g. BinIncrementEvent(nt).value(bin_index=3); read them back as attributes (inst.bin_index).

Constructing and inspecting individual event values from Python is intended for debugging and learning only and is extremely slow; production graphs process events in compiled C++ and exchange bulk data via buckets.