Table of Contents
TIP

This is a device configuration operator. Aggregate configuration operators are recommended in lieu of device configuration operators for interfacing with Open Ephys Onix hardware.

ConfigureOutputClock

sink Operator

Configures the ONIX breakout board's output clock.

The output clock provides a 3.3V logic level, 50 Ohm output impedance, frequency divided copy of the Acquisition Clock that is used to generate Clock values for all data streams within an ONIX system. This clock runs at a user defined rate, duty cycle, and start delay. It can be used to drive external hardware or can be logged by external recording systems for post-hoc synchronization with ONIX data.

ConfigureOutputClock Workflow

Inputs & Outputs

Configures a clock output.

This will schedule configuration actions to be applied by a StartAcquisition instance prior to data acquisition.

A sequence of ContextTask instances that holds configuration actions.

right-arrow
representation of a sink operator
right-arrow

The original sequence modified by adding additional configuration actions required to configure a clock output device./>

Properties

Property Type Description
ClockGate bool

Gets or sets a value specifying if the output clock is active.

If set to true, the clock output will be connected to the clock output line. If set to false, the clock output line will be held low. This value can be toggled in real time to gate acquisition of external hardware.

Delay double

Gets or sets the delay following acquisition commencement before the clock becomes active in seconds.

Valid values are between 0 and and 3600 seconds. Setting to a value greater than 0 can be useful for ensuring data sources that are driven by the output clock start significantly after ONIX has begun acquisition for the purposes of ordering acquisition start times.

The delay must be an integer multiple of the Acquisition Clock frequency. Therefore, the true delay cycle will be set to a value that is as close as possible to the requested setting while respecting this constraint. The value as actualized in hardware is reported by OutputClockData.

DutyCycle double

Gets or sets the output clock duty cycle in percent.

Valid values are between 10% and 90%. The output clock high and low times must each be an integer multiple of the Acquisition Clock frequency. Therefore, the true duty cycle will be set to a value that is as close as possible to the requested setting while respecting this constraint. The value as actualized in hardware is reported by OutputClockData.

Frequency double

Gets or sets the output clock frequency in Hz.

Valid values are between 0.1 Hz and 10 MHz. The output clock high and low times must each be an integer multiple of the Acquisition Clock frequency. Therefore, the true clock frequency will be set to a value that is as close as possible to the requested setting while respecting this constraint. The value as actualized in hardware is reported by OutputClockData.

DeviceName string

Gets or sets a unique device name.

The device name provides a unique, human-readable identifier that is used to link software elements for configuration, control, and data streaming to hardware. For instance, it can be used to link configuration operators to data IO operators within a workflow. This value is usually not set manually, but is assigned in a MultiDeviceFactory to correspond to a fixed address with a piece of hardware such as a headstage. This address is used for software communication.

DeviceAddress uint

Gets or sets the device address.

This is a fully-qualified numerical hardware address of a device within the device table produced by an Open Neuro Interface (ONI) compliant acquisition system. This value is usually not set manually, but is assigned in a MultiDeviceFactory to correspond to a fixed address with a piece of hardware such as a headstage. This address is used for hardware communication.

DeviceType Type

Gets or sets the device identity.

This type provides a device identity to each device within the device table produced by an Open Neuro Interface (ONI) compliant acquisition system.