← Back to API reference

neuralset.events.etypes.SleepStage

pydantic model neuralset.events.etypes.SleepStage

Sleep stage event following AASM manual classification [sleep1].

Parameters:

stage ({'W', 'N1', 'N2', 'N3', 'R'}) –

Sleep stage:

• ’W’: Waking state

• ’N1’: Stage 1 of Non-Rapid Eye Movement (N-REM)

• ’N2’: Stage 2 of Non-Rapid Eye Movement (N-REM)

• ’N3’: Stage 3/4 of Non-Rapid Eye Movement (N-REM)

• ’R’: Rapid Eye Movement (REM)

References

[sleep1]

Berry, R., Quan, S. and Abreu, A. (2020) The AASM Manual for the Scoring of Sleep and Associated Events: Rules, Terminology and Technical Specifications, Version 2.6. American Academy of Sleep Medicine, Darien.

Fields:

• stage (Literal['W', 'N1', 'N2', 'N3', 'R'])

field stage: Literal['W', 'N1', 'N2', 'N3', 'R'] [Required]

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

type: tp.ClassVar[str] = 'SleepStage'

← Back to API reference