send_stim_train
Deliver a timed train of stimulation pulses within a session, blocking until completion—ideal for rTMS bursts and repeated cues. Each pulse is logged individually to capture exact delivery timing.
Instructions
Deliver a regular train of pulses, blocking until it completes.
For rTMS bursts and repeated cues. The call holds until the train finishes, so it is capped at 1000 pulses and 60 seconds total; build longer protocols from several calls so there are decision points in between.
Every pulse is logged individually, so the event log reconstructs the exact delivered timing rather than the intended timing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | Yes | Base event name; pulses are logged as '<label>_<n>'. | |
| value | No | Numeric code for each pulse. | |
| backend | No | Which attached backend. Defaults to the session default. | |
| n_pulses | Yes | How many pulses to deliver. | |
| intensity | No | Physical dose per pulse, clamped against the ceiling. | |
| session_id | Yes | The session to stimulate within. | |
| duration_ms | No | Pulse width. | |
| interval_ms | Yes | Inter-pulse interval. For rTMS this is 1000/frequency. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||