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

Table of Contents
TIP

This is a Device configuration operator. Device Group configuration operators are recommended instead of Device configuration operators for interfacing with Open Ephys Onix hardware.

ConfigureHeadstage64OpticalStimulator

sink Operator

Configures a headstage-64 dual-channel optical stimulator.

This configuration operator can be linked to a data IO operator, such as Headstage64OpticalStimulatorTrigger, using a shared DeviceName.

ConfigureHeadstage64OpticalStimulator Workflow

Inputs & Outputs

Configure a headstage-64 dual-channel optical stimulator.

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 headstage-64 dual-channel optical stimulator.

Properties

Property Type Description
Arm bool

Gets or sets the device arm state.

If set to true, then the optical stimulator circuit will respect triggers. If set to false, triggers will be ignored.

BurstCurrent double

Gets total direct current required during the application of a burst.

This value should be kept below 50 mA to prevent excess head accumulation on the headstage.

BurstsPerTrain uint

Gets or sets the number of bursts in a stimulus train.

ChannelOneCurrent double

Gets or sets the percent of MaxCurrent that will delivered to channel 1 in each pulse.

ChannelTwoCurrent double

Gets or sets the percent of MaxCurrent that will delivered to channel 2 in each pulse.

Delay double

Gets or sets a delay from receiving a trigger to the start of stimulus sequence application in msec.

InterBurstInterval double

Gets or sets the duration of the inter-burst interval within a stimulus train in msec.

MaxCurrent double

Gets or sets the Maximum current per channel per pulse in mA.

This value defines the maximal possible current that can be delivered to each channel. To get different amplitudes for each channel use the ChannelOneCurrent and ChannelTwoCurrent properties.

PulseDuration double

Gets or sets the duration of each pulse in msec.

PulsesPerBurst uint

Gets or sets the number of pulses per burst.

PulsesPerSecond double

Gets or sets the pulse frequency within a burst in Hz.

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 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 ONI-compliant acquisition system.