libtcspc C++ API
Streaming TCSPC and time tag data processing
Loading...
Searching...
No Matches
tcspc::marker_event< DataTypes > Struct Template Reference

Description

template<typename DataTypes = default_data_types>
struct tcspc::marker_event< DataTypes >

Event indicating a timing marker.

These events indicate the timing of some process (e.g. laser scanning) in the acquisition and are generated by external triggers or internally.

Becker & Hickl calls these (frame, line, or pixel) markers. PicoQuant calls these external markers. Swabian does not have a dedicated marker facility.

Some devices produce single events with potentially multiple markers on different channels, using, e.g., a bitmask. In such cases, a separate tcspc::marker_event must be generated for each channel, bearing the same abstime. Ordering of simultaneous marker events within the stream is undefined (but ordering should be made deterministic when arbitrarily determined by software).

The channel numbering of marker events may or may not be shared with detection channels, depending on the hardware or data source.

Template Parameters
DataTypesdata type set specifying abstime_type and channel_type

Public Attributes

DataTypes::abstime_type abstime
 The absolute time (a.k.a. macrotime) of this event.
DataTypes::channel_type channel
 The channel on which this event occurred.

Friends

auto operator<< (std::ostream &s, marker_event const &e) -> std::ostream &
 Stream insertion operator.
auto operator== (marker_event const &lhs, marker_event const &rhs) noexcept -> bool=default
 Equality comparison operator.

The documentation for this struct was generated from the following file: