This documentation supports the latest PCIe host firmware, the latest OpenEphys.Onix1 package, and Bonsai 2.9+.

Table of Contents

TS4231V1PositionDataFrame

3D position of a single photodiode within a TS4231 sensor array.

A sequence of 12 oni.Frame objects produced by a single TS4231 sensor are required to geometrically calculate the position of the sensor's photodiode in 3D space.

Properties

Property Type Description
Position Vector3

Gets the 3D position of the photodiode connected to the TS4231 receiver with index SensorIndex in units determined by P and Q.

SensorIndex int

Gets the index of the TS4231 sensor that produced this data.

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.