Repository navigation
Commit a96668a
authored
Fix ann2rr intervals split by non-beat annotations (#584)
## Problem
Fixes #479.
`ann2rr` currently differences every annotation sample, including rhythm
changes and comments. A rhythm marker between two beats splits one RR
interval into two. For example, at 100 Hz, beats at samples 100, 200 and
300 with rhythm markers at 0, 150 and 250 and a comment at 400 produce
`[0, 100, 50, 50, 50, 50, 100]` instead of `[100, 100, 100]`.
## Changes
- Select QRS annotation codes using the existing `is_qrs` table before
calculating intervals. Read numeric `label_store` values so renamed
symbols and gaps in the standard symbol table do not change
classification.
- Keep the first interval measured from sample zero to the first
selected annotation, and return an empty array when no annotations are
selected.
- Add the trailing optional argument `all_annotations=True` to retain
the previous all-annotation behavior. This is also useful for comment
annotations produced by `rr2ann` when no symbols are supplied.
- Update the documentation and add regression tests with locally written
annotation files and the existing `sample-data/100` fixture.
The default beat-only selection and the all-annotation opt-in follow the
[WFDB command-line ann2rr
behavior](https://www.physionet.org/physiotools/wag/ann2rr-1.htm). The
[WFDB RR tutorial](https://archive.physionet.org/tutorials/hrv/)
describes the initial interval's time-zero convention.
**Compatibility:** callers that intentionally used non-beat annotations
should pass `all_annotations=True`. The existing `start_time` /
`stop_time` filtering and unit conversion logic are unchanged.
## Validation
Windows, Python 3.12.14:
```text
python -m pytest tests/test_hr.py -q --tb=short
50 passed
python -m pytest tests/test_processing.py tests/test_annotation.py -k "not test_1 and not test_2 and not test_3" -q --tb=short
11 passed, 3 deselected
python -m ruff format --check wfdb/processing/hr.py tests/test_hr.py
2 files already formatted
python -m ruff check wfdb/processing/hr.py tests/test_hr.py
All checks passed!
git diff --cached --check
```
The new tests cover mixed beat/rhythm/comment annotations, all standard
beat and non-beat symbols, sample/second/minute/hour output, coincident
markers, a single beat, empty selection, a renamed beat symbol, printed
output and the compatibility option. Against the unmodified
implementation they report **29 failed, 21 passed**; restoring that
implementation in an isolated copy reproduces the same failures.
The three deselected annotation tests fetch data from PhysioNet. This is
a targeted local test run, not a claim that the full test matrix has
passed.3 files changed
Lines changed: 155 additions & 13 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
80 | 83 | | |
81 | 84 | | |
82 | 85 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
177 | 177 | | |
178 | 178 | | |
179 | 179 | | |
| 180 | + | |
180 | 181 | | |
181 | 182 | | |
182 | 183 | | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
183 | 188 | | |
184 | 189 | | |
185 | 190 | | |
| |||
201 | 206 | | |
202 | 207 | | |
203 | 208 | | |
204 | | - | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
205 | 214 | | |
206 | 215 | | |
207 | 216 | | |
208 | | - | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
209 | 220 | | |
210 | 221 | | |
211 | 222 | | |
212 | | - | |
213 | | - | |
214 | | - | |
215 | | - | |
216 | | - | |
217 | | - | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
218 | 230 | | |
219 | 231 | | |
220 | 232 | | |
| |||
223 | 235 | | |
224 | 236 | | |
225 | 237 | | |
226 | | - | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
227 | 245 | | |
228 | | - | |
229 | | - | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
230 | 249 | | |
231 | 250 | | |
232 | 251 | | |
| |||
265 | 284 | | |
266 | 285 | | |
267 | 286 | | |
268 | | - | |
| 287 | + | |
| 288 | + | |
269 | 289 | | |
270 | 290 | | |
271 | 291 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
0 commit comments