Skip to content

Commit 2c53ca0

Browse files
authored
Merge pull request MIT-LCP#211 from MIT-LCP/ann_doc_143
Makes annotation documentation clearer MIT-LCP#143
2 parents b2dda3b + 13164e4 commit 2c53ca0

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

wfdb/io/annotation.py

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,73 @@ class Annotation(object):
2626
text used to label annotations that are not one of these codes should go in
2727
the 'aux_note' field rather than the 'sym' field.
2828
29+
The current annotation values organized as such:
30+
31+
AnnotationLabel(label_store (or subtype), symbol (or aux_note), short_description, description)
32+
33+
where the associated values are:
34+
35+
ann_labels = [
36+
AnnotationLabel(0, " ", 'NOTANN', 'Not an actual annotation'),
37+
AnnotationLabel(1, "N", 'NORMAL', 'Normal beat'),
38+
AnnotationLabel(2, "L", 'LBBB', 'Left bundle branch block beat'),
39+
AnnotationLabel(3, "R", 'RBBB', 'Right bundle branch block beat'),
40+
AnnotationLabel(4, "a", 'ABERR', 'Aberrated atrial premature beat'),
41+
AnnotationLabel(5, "V", 'PVC', 'Premature ventricular contraction'),
42+
AnnotationLabel(6, "F", 'FUSION', 'Fusion of ventricular and normal beat'),
43+
AnnotationLabel(7, "J", 'NPC', 'Nodal (junctional) premature beat'),
44+
AnnotationLabel(8, "A", 'APC', 'Atrial premature contraction'),
45+
AnnotationLabel(9, "S", 'SVPB', 'Premature or ectopic supraventricular beat'),
46+
AnnotationLabel(10, "E", 'VESC', 'Ventricular escape beat'),
47+
AnnotationLabel(11, "j", 'NESC', 'Nodal (junctional) escape beat'),
48+
AnnotationLabel(12, "/", 'PACE', 'Paced beat'),
49+
AnnotationLabel(13, "Q", 'UNKNOWN', 'Unclassifiable beat'),
50+
AnnotationLabel(14, "~", 'NOISE', 'Signal quality change'),
51+
AnnotationLabel(16, "|", 'ARFCT', 'Isolated QRS-like artifact'),
52+
AnnotationLabel(18, "s", 'STCH', 'ST change'),
53+
AnnotationLabel(19, "T", 'TCH', 'T-wave change'),
54+
AnnotationLabel(20, "*", 'SYSTOLE', 'Systole'),
55+
AnnotationLabel(21, "D", 'DIASTOLE', 'Diastole'),
56+
AnnotationLabel(22, '"', 'NOTE', 'Comment annotation'),
57+
AnnotationLabel(23, "=", 'MEASURE', 'Measurement annotation'),
58+
AnnotationLabel(24, "p", 'PWAVE', 'P-wave peak'),
59+
AnnotationLabel(25, "B", 'BBB', 'Left or right bundle branch block'),
60+
AnnotationLabel(26, "^", 'PACESP', 'Non-conducted pacer spike'),
61+
AnnotationLabel(27, "t", 'TWAVE', 'T-wave peak'),
62+
AnnotationLabel(28, "+", 'RHYTHM', 'Rhythm change'),
63+
AnnotationLabel(29, "u", 'UWAVE', 'U-wave peak'),
64+
AnnotationLabel(30, "?", 'LEARN', 'Learning'),
65+
AnnotationLabel(31, "!", 'FLWAV', 'Ventricular flutter wave'),
66+
AnnotationLabel(32, "[", 'VFON', 'Start of ventricular flutter/fibrillation'),
67+
AnnotationLabel(33, "]", 'VFOFF', 'End of ventricular flutter/fibrillation'),
68+
AnnotationLabel(34, "e", 'AESC', 'Atrial escape beat'),
69+
AnnotationLabel(35, "n", 'SVESC', 'Supraventricular escape beat'),
70+
AnnotationLabel(36, "@", 'LINK', 'Link to external data (aux_note contains URL)'),
71+
AnnotationLabel(37, "x", 'NAPC', 'Non-conducted P-wave (blocked APB)'),
72+
AnnotationLabel(38, "f", 'PFUS', 'Fusion of paced and normal beat'),
73+
AnnotationLabel(39, "(", 'WFON', 'Waveform onset'),
74+
AnnotationLabel(40, ")", 'WFOFF', 'Waveform end'),
75+
AnnotationLabel(41, "r", 'RONT', 'R-on-T premature ventricular contraction')
76+
]
77+
78+
The current annotation classes are organized as such:
79+
80+
AnnotationClass(extension, description, human_reviewed)
81+
82+
where the associated values are:
83+
84+
ann_classes = [
85+
AnnotationClass('atr', 'Reference ECG annotations', True),
86+
AnnotationClass('blh', 'Human reviewed beat labels', True),
87+
AnnotationClass('blm', 'Machine beat labels', False),
88+
AnnotationClass('alh', 'Human reviewed alarms', True),
89+
AnnotationClass('alm', 'Machine alarms', False),
90+
AnnotationClass('qrsc', 'Human reviewed QRS detections', True),
91+
AnnotationClass('qrs', 'Machine QRS detections', False),
92+
AnnotationClass('bph', 'Human reviewed BP beat detections', True),
93+
AnnotationClass('bpm', 'Machine BP beat detections', False)
94+
]
95+
2996
Attributes
3097
----------
3198
record_name : str

0 commit comments

Comments
 (0)