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

Table of Contents

Headstage64OpticalStimulatorTrigger

sink Operator

Trigger a headstage-64 onboard optical stimulus sequencer.

This data IO operator must be linked to an appropriate configuration, such as a ConfigureHeadstage64OpticalStimulator, using a shared DeviceName. Headstage-64's onboard optical stimulator can be used to drive current through laser diodes or LEDs connected to two contacts on the probe connector on the bottom of the headstage or the corresponding contacts on a compatible electrode interface board.

Headstage64OpticalStimulatorTrigger Workflow

Inputs & Outputs

Start an optical stimulus sequence.

A sequence of boolean values indicating the start of a stimulus sequence when true.

right-arrow
representation of a sink operator
right-arrow

A sequence of boolean values that is identical to source

Important

Headstages manufactured before October 2024 have an optical stimulator that behaves differently from those manufactured after that date. On older headstages, a True value at this operator's input continuously delivers stimuli, while a False value stops delivery. On newer headstages, a True value delivers a single stimulus. Additionally, on older headstages, the frequency parameter controls the interval between the end of one pulse and the start of the next, meaning the actual repetition rate equals the pulse duration plus 1/frequency. If your headstage was purchased around the transition date and you want to use the optical stimulator, you can confirm whether you have an older or newer headstage by observing the trigger behavior on the headstage's Intan chip's auxiliary input, to which the electrical stimulus signal is hard-wired. The optical stimulator does not have a direct read-back path, but the trigger behavior is the same for both stimulators. If your headstage exhibits the older trigger/stimulus behavior and you specifically require the newer behavior, contact us.

Properties

Property Type Description
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.