neuralset.events.etypes.Stimulus¶

class neuralset.events.etypes.Stimulus(*, start: float, timeline: str, duration: Annotated[float, Ge(ge=0)] = 0.0, extra: dict[str, Any] = {}, code: int = -100, modality: Literal['audio', 'visual', 'tactile'] | None = None, description: str = '')[source][source]¶

General stimulus presentation event identified by a code.

Unlike specific stimulus events (Image, Audio) which point to actual stimulus files, this event only registers a code/trigger value mapped to an event.

Parameters:

code (int, optional) – Stimulus code or trigger value. Default: -100 (ignored by CrossEntropyLoss)
description (str, optional) – Human-readable description of the stimulus. Default: “”