Compumedics Annotation Format - nsrr/edf-editor-translator GitHub Wiki

Compumedics uses XML for annotation file format that includes five sections:

  • Epoch length in seconds, normally 30 seconds

      <CMPStudyConfig>
        <EpochLength>30</EpochLength>
      </CMPStudyConfig>
    
  • Step channel information

      <StepChannels>
        <StepChannel>
          <Input>LIGHT</Input>
          <Labels>
            <Label>ON</Label>
            <Label>OFF</Label>
          </Labels>
        </StepChannel>
      </StepChannels>
    
  • Scored event settings including colors, text colors, and input

      <ScoredEventSettings>
        <ScoredEventSetting>
          <Name>Obstructive Apnea</Name>
          <Colour>16628921</Colour>
          <TextColour>4194304</TextColour>
          <Input>ABDO RES</Input>
        </ScoredEventSetting>
      <ScoredEventSettings>
    
  • Scored events: event observed during sleep study, including event name, start time in seconds, duration in seconds, input. Desaturation and LowestSpO2 are optional.

      <ScoredEvents>
        <ScoredEvent>
          <LowestSpO2>90</LowestSpO2>
          <Desaturation>3</Desaturation>
          <Name>SpO2 desaturation</Name>
          <Start>2400.4</Start>
          <Duration>13.4</Duration>
          <Input>SaO2</Input>
        </ScoredEvent>
        <ScoredEvent>
          <Name>Hypopnea</Name>
          <Start>2423.8</Start>
          <Duration>27.5</Duration>
          <Input>ABDO RES</Input>
        </ScoredEvent>
      </ScoredEvents>
    
  • Sleep stages: hypnogram is broken into periods of 30 seconds (epoch). 0 is wake stage, 1-4: sleep stage 1-4 and 5 is REM sleep. 9 is Active.

      <SleepStage>0</SleepStage>
      <SleepStage>2</SleepStage>
      <SleepStage>2</SleepStage>
      <SleepStage>2</SleepStage>
      <SleepStage>2</SleepStage>
      <SleepStage>1</SleepStage>
      <SleepStage>1</SleepStage>
      <SleepStage>2</SleepStage>
      <SleepStage>5</SleepStage>
      <SleepStage>5</SleepStage>
      <SleepStage>0</SleepStage>
    
⚠️ **GitHub.com Fallback** ⚠️