libtcspc.TimeCorrelatedDetectionEvent¶

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

Bases: EventType

The canonical TCSPC detection event.

Represents a single detection (typically a photon) carrying both a macrotime (abstime) and a microtime (difftime, also known as nanotime), along with the detector channel. This is the central event type processed in applications such as FLIM and FCS.

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 fields abstime, channel, and difftime.

A value is constructed by giving all fields, e.g. TimeCorrelatedDetectionEvent(nt).value(abstime=42, channel=1, difftime=5); read them back as attributes (inst.abstime).

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.