neuralset.events.etypes.Stimulus¶

pydantic model neuralset.events.etypes.Stimulus[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: “”

See also

neuralset.events.testing.mne2013sample: Example usage

Examples

stim = Stimulus(start=1.0, timeline="exp", code=1,
               description="Visual checkerboard")

Fields:

code (int)
description (str)
modality (Literal['audio', 'visual', 'tactile'] | None)

field code: int = -100[source]¶

field modality: Literal['audio', 'visual', 'tactile'] | None = None[source]¶

field description: str = ''[source]¶

requirements: tp.ClassVar[tuple[str, ...]] = ()[source]¶

type: tp.ClassVar[str] = 'Stimulus'[source]¶

← Back to API reference