libtcspc.MarkerEvent¶
- class libtcspc.MarkerEvent(numeric_traits=None)[source]¶
Bases:
EventTypeEvent representing a timing marker or external trigger.
Used for frame, line, and pixel markers in scanning microscopy, and for other external trigger signals that the TCSPC hardware records alongside detections.
- Parameters:
numeric_traits (NumericTraits or None) – Set of integer types parameterising the C++ event.
None(the default) usesNumericTraitsdefaults.
Notes
The corresponding C++ event has fields
abstimeandchannel. When the hardware reports multiple simultaneous markers, one event is emitted per channel sharing the sameabstime; the ordering among simultaneous markers is unspecified. The marker channel numbering may or may not share a namespace with detection channels, depending on the device.A value is constructed by giving all fields, e.g.
MarkerEvent(nt).value(abstime=42, channel=1); 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.
See also
- tcspc::marker_event
The underlying C++ event type.