Rhs2116TriggerDataFrame

A trigger event received by an Rhs2116 trigger device.

These events provide synchronized recordings of stimulus trigger times. They provide information about the source of the trigger and if it was applied or ignored and for what reason.

Properties

Property	Type	Description
Delay	double	Gets the delay, in microseconds, from this trigger to the physical application of the stimulus sequence. This value is determined by the delay sequence provided as input to Rhs2116StimulusTrigger.
Origin	Rhs2116TriggerOrigin	Gets the origin of the trigger. Unknown = 0 Gpio = 1 Register = 2 External = 4
Status	Rhs2116TriggerResult	Gets the status of the trigger. Delivered = 0 Disarmed = 1 SequencerBusy = 2
Clock	ulong	Gets the acquisition clock count. Acquisition clock count that is synchronous for all frames collected within an ONI context created using CreateContext. The acquisition clock rate is given by AcquisitionClockHz. This clock value provides a common, synchronized time base for all data collected with an single ONI context.
HubClock	ulong	Gets the hub clock count. Local, potentially asynchronous, clock count. Aside from the synchronous Clock value, data frames also contain a local clock count produced within the oni.Hub that the data was actually produced within. For instance, a headstage may contain an onboard controller for controlling devices and arbitrating data stream that runs asynchronously from the AcquisitionClockHz. This value is therefore the most precise way to compare the sample time of data collected within a given oni.Hub. However, the delay between time of data collection and synchronous time stamping by Clock is very small (sub-microsecond) and this value can therefore be disregarded in most scenarios in favor of Clock.