Method SendCustomPulseTrain

Namespace

Bonsai.PulsePal

Assembly

Bonsai.PulsePal.dll

SendCustomPulseTrain(CustomTrainId, double[], double[])

Sends a sequence of onset times and voltages describing a train of pulses.

public void SendCustomPulseTrain(CustomTrainId id, double[] pulseTimes, double[] pulseVoltages)

Parameters

id CustomTrainId

The identity of the custom pulse train to program.

pulseTimes double[]

The array of pulse onset times, where each time is specified in seconds from the start of the pulse train.

pulseVoltages double[]

The array of pulse voltages, with one voltage per pulse.

Remarks

Pulses that are continuous or overlapping will merge. If an output channel is set to produce biphasic pulses, the voltage specified for each pulse is sign-inverted for the second phase, i.e. if +5 V is used for phase 1, -5 V is used automatically for phase 2.

Exceptions

ArgumentException

The specified pulse train id is invalid.

ArgumentNullException

Either pulseTimes or pulseVoltages is null.

ArgumentOutOfRangeException

The maximum length of 1,000 pulses has been exceeded.

SendCustomPulseTrain(CustomTrainId, PulseOnset[])

Sends a sequence of onset times and voltages describing a train of pulses.

public void SendCustomPulseTrain(CustomTrainId id, PulseOnset[] pulseTrain)

Parameters

id CustomTrainId

The identity of the custom pulse train to program.

pulseTrain PulseOnset[]

The array specifying all pulse onset times and voltages, respectively in seconds and volts.

Remarks

Pulses that are continuous or overlapping will merge. If an output channel is set to produce biphasic pulses, the voltage specified for each pulse is sign-inverted for the second phase, i.e. if +5 V is used for phase 1, -5 V is used automatically for phase 2.

Exceptions

ArgumentException

The specified pulse train id is invalid.

ArgumentNullException

pulseTrain is null.

ArgumentOutOfRangeException

The maximum length of 1,000 pulses has been exceeded.

SendCustomPulseTrain(CustomTrainId, double[,])

Sends a sequence of onset times and voltages describing a train of pulses.

public void SendCustomPulseTrain(CustomTrainId id, double[,] pulseTrain)

Parameters

id CustomTrainId

The identity of the custom pulse train to program.

pulseTrain double[,]

A rectangular array of pulse times and pulse voltages, where the first row represents the vector of pulse onset times in seconds, and the second row the corresponding vector of pulse voltages in volts.

Exceptions

ArgumentException

The specified pulse train id is invalid.-or- pulseTrain does not have exactly two rows.

ArgumentNullException

pulseTrain is null.

ArgumentOutOfRangeException

The maximum length of 1,000 pulses has been exceeded.