libtcspc.BatchBinIncrementClusters

final class libtcspc.BatchBinIncrementClusters(bucket_size, batch_size, *, buffer_provider=None, numeric_traits=None)

Bases: Node

Processor that collects bin increment clusters into encoded batches.

An optimized analogue of Batch for BinIncrementClusterEvent. Each completed batch is emitted as a BucketEvent of bin indices. Must be paired with UnbatchBinIncrementClusters downstream to recover the clusters.

Parameters:

• bucket_size (int or Param[int]) – Size (in elements) of each storage bucket.

• batch_size (int or Param[int]) – Number of clusters per batch.

• buffer_provider (BucketSource or Param[PyBucketSource] or None) – Source of buckets. If None, a default RecyclingBucketSource is used.

• numeric_traits (NumericTraits or None) – Numeric traits specifying bin_index_type. Defaults to NumericTraits().

Notes

Events handled:

• BinIncrementClusterEvent: encoded into a batch; emitted when full.

• All other event types: pass through unchanged.

• End of input: emit any partial batch, then pass through.

See also

tcspc::batch_bin_increment_clusters()

The underlying C++ factory function.