send_stim_event
Send stimulation events, log them against the EEG clock, and record failures as part of the session. Optionally add markers to the acquisition stream for self-describing data.
Instructions
Deliver one stimulation command, and log it against the EEG clock.
The event is written to the session log whether the transport succeeds or fails -- a failed stimulation attempt matters just as much to the record. When the acquisition source supports markers, the same event is also punched into the stream itself so the recording is self-describing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | 'marker' (event code only), 'pulse' (code then clear after duration_ms), 'train', 'ramp', or 'custom'. Backends advertise which kinds they support via list_stim_backends. | marker |
| unit | No | Unit label for intensity, for the record. | |
| label | Yes | Event name, e.g. 'tms_pulse' or 'cue_left'. | |
| value | No | Numeric code for marker streams and trigger lines. Nonzero. | |
| params | No | Extra fields made available to command templates. | |
| target | No | Coil, montage or channel identifier, for the record. | |
| backend | No | Which attached backend to use. Defaults to the session default. | |
| intensity | No | Physical dose for hardware backends -- %MSO for TMS, mA for tES. Clamped against the configured ceiling; ignored by software backends. | |
| session_id | Yes | The session to stimulate within. | |
| duration_ms | No | Pulse width or stimulation duration. | |
| also_mark_source | No | Also write the code into the acquisition stream's own marker channel. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||