libtcspc.BinIncrementClusterEvent¶

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

Bases: EventType

Event carrying a cluster of histogram bin increments.

Emitted by ClusterBinIncrements and UnbatchBinIncrementClusters, and consumed by ScanHistograms and BatchBinIncrementClusters. It carries a bucket of bin indices.

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_indices, a tcspc::bucket of bin_index_type.

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

Even though this event carries a bucket, individual clusters are small and numerous, so constructing or inspecting them from Python is intended for debugging and learning only and is extremely slow. In production these clusters stay within the compiled graph.