radiens_core.models.triggers

Trigger control domain models and enums.

CLASS	DESCRIPTION
ManualStimTriggerRequest	Request for manual stimulation trigger.
ManualStimTriggerToggleRequest	Request to toggle manual stimulation trigger.
TriggerChannel	Trigger channel identifier.
TriggerState	Current trigger channel configuration.

ATTRIBUTE	DESCRIPTION
FlexTriggerChannel	TriggerChannel that also accepts a string name or int value.

Attributes

FlexTriggerChannel module-attribute

FlexTriggerChannel = TriggerChannel | str | int

TriggerChannel that also accepts a string name or int value.

String inputs use the short name without the T_ prefix, case-insensitively (e.g. "din_0", "dout_5", "none").

Classes

ManualStimTriggerRequest

Bases: BaseModel

Request for manual stimulation trigger.

Only the deprecated AllegoClient.manual_stim_trigger() takes this.

ATTRIBUTE	DESCRIPTION
trigger	Keypress trigger (1-8). TYPE: StimKeypressIndex
trigger_on	Whether to turn the trigger on or off. TYPE: bool

ManualStimTriggerToggleRequest

Bases: BaseModel

Request to toggle manual stimulation trigger.

Only the deprecated AllegoClient.manual_stim_trigger_toggle() takes this.

ATTRIBUTE	DESCRIPTION
trigger	Keypress trigger (1-8). TYPE: StimKeypressIndex

TriggerChannel

Bases: IntEnum

Trigger channel identifier.

TriggerState

Bases: BaseModel

Current trigger channel configuration.

ATTRIBUTE	DESCRIPTION
enabled_channels	List of currently enabled trigger channels. TYPE: list[TriggerChannel]
ports	Port of each enabled trigger, parallel to enabled_channels. TYPE: list[Port]