libtcspc.ClusterBinIncrements¶

final class libtcspc.ClusterBinIncrements(start_event_type, stop_event_type, numeric_traits=None)[source]¶

Bases: Node

Processor that collects bin increments between start and stop events into clusters.

Bin increments received while within a cluster (after a start_event_type and before a stop_event_type) are collected; each completed cluster is emitted as a BinIncrementClusterEvent.

Parameters:

start_event_type (EventType) – Event type that starts a cluster.
stop_event_type (EventType) – Event type that ends a cluster.
numeric_traits (NumericTraits or None) – Numeric traits for the events. Defaults to NumericTraits().

Notes

Events handled:

start_event_type: begin a new cluster (consumed).
stop_event_type: emit the current cluster as a BinIncrementClusterEvent (consumed).
BinIncrementEvent: recorded into the current cluster (consumed).
All other event types: pass through unchanged.
End of input: pass through.