Table of Contents

Headstage64ElectricalStimulatorTrigger

sink Operator

Controls a headstage-64 onboard electrical stimulus sequencer.

This data IO operator must be linked to an appropriate configuration, such as a ConfigureHeadstage64ElectricalStimulator, using a shared DeviceName. Headstage-64's onboard electrical stimulator can be used to deliver current controlled micro-stimulation through a contact on the probe connector on the bottom of the headstage or the corresponding contact on a compatible electrode interface board.

Headstage64ElectricalStimulatorTrigger Workflow

Inputs & Outputs

Start an electrical 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

Properties

Property Type Description
BurstPulseCount uint

Gets or sets the number of pulses per burst.

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.

Enable bool

Gets or sets the device enable state.

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

InterBurstInterval uint

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

InterPhaseCurrent double

Gets or sets the amplitude of the interphase current of each pulse in μA.

InterPhaseInterval uint

Gets or sets the duration of the interphase interval of each pulse in μsec.

InterPulseInterval uint

Gets or sets the duration of the inter-pulse interval within a single burst in μsec.

PhaseOneCurrent double

Gets or sets the amplitude of the first phase of each pulse in μA.

PhaseOneDuration uint

Gets or sets the duration of the first phase of each pulse in μsec.

PhaseTwoCurrent double

Gets or sets the amplitude of the second phase of each pulse in μA.

PhaseTwoDuration uint

Gets or sets the duration of the second phase of each pulse in μsec.

PowerEnable bool

Gets or sets the electrical stimulator's power state.

If set to true, then the electrical stimulator's ±15V power supplies will be turned on. If set to false, they will be turned off. It may be desirable to power down the electrical stimulator's power supplies outside of stimulation windows to reduce power consumption and electrical noise. This property must be set to true in order for electrical stimuli to be delivered properly. It takes ~10 milliseconds for these supplies to stabilize.

TrainBurstCount uint

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

TriggerDelay uint

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