wfdb 0.1.6

A library for decoding and encoding Waveform Database format files.
Documentation 
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329

use std::io::Cursor;
use wfdb::{Error, Header};

// [Basic Parsing Tests]

#[test]
fn test_single_segment_record() {
    let header_text = "100 2 360 650000\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n\
                      # Info string 1\n\
                      # Info string 2\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "100");
    assert_eq!(header.metadata().num_signals(), 2);
    assert!(!header.is_multi_segment());
    assert_eq!(header.signals().unwrap().len(), 2);
    assert!(header.segments().is_none());
    assert_eq!(header.info_strings().len(), 2);
    assert_eq!(header.info_strings()[0], " Info string 1");
    assert_eq!(header.info_strings()[1], " Info string 2");
}

#[test]
fn test_multi_segment_record() {
    let header_text = "multi/3 2 360 45000\n\
                      100s 21600\n\
                      null 1800\n\
                      100s 21600\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "multi");
    assert_eq!(header.metadata().num_signals(), 2);
    assert!(header.is_multi_segment());
    assert_eq!(header.num_segments(), Some(3));
    assert!(header.signals().is_none());
    assert_eq!(header.segments().unwrap().len(), 3);
    assert_eq!(header.info_strings().len(), 0);
}

#[test]
fn test_with_leading_comments() {
    let header_text = "# Comment 1\n\
                      # Comment 2\n\
                      100 2 360\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "100");
    assert_eq!(header.signals().unwrap().len(), 2);
}

#[test]
fn test_empty_lines_before_record() {
    let header_text = "\n\n100 2 360\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "100");
    assert_eq!(header.signals().unwrap().len(), 2);
}

#[test]
fn test_mixed_comments_and_empty_lines() {
    let header_text = "# Comment 1\n\
                      \n\
                      # Comment 2\n\
                      100 2 360\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "100");
}

// [Info Strings Tests]

#[test]
fn test_info_strings_without_leading_space() {
    let header_text = "100 2 360\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n\
                      #Info1\n\
                      #Info2\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.info_strings().len(), 2);
    assert_eq!(header.info_strings()[0], "Info1");
    assert_eq!(header.info_strings()[1], "Info2");
}

#[test]
fn test_multiple_info_strings() {
    let header_text = "100 2 360\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n\
                      # Line 1\n\
                      # Line 2\n\
                      # Line 3\n\
                      # Line 4\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.info_strings().len(), 4);
}

#[test]
fn test_no_info_strings() {
    let header_text = "100 2 360\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.info_strings().len(), 0);
}

// [Multi-Segment Record Tests]

#[test]
fn test_multi_segment_with_null_segment() {
    let header_text = "rec/3 2 360 45000\n\
                      seg1 21600\n\
                      ~ 1800\n\
                      seg2 21600\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert!(header.is_multi_segment());
    let segments = header.segments().unwrap();
    assert_eq!(segments.len(), 3);
    assert_eq!(segments[0].record_name(), "seg1");
    assert_eq!(segments[1].record_name(), "~");
    assert!(segments[1].is_null_segment());
    assert_eq!(segments[2].record_name(), "seg2");
}

#[test]
fn test_multi_segment_single_segment() {
    let header_text = "rec/1 2 360 21600\n\
                      seg1 21600\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert!(header.is_multi_segment());
    assert_eq!(header.num_segments(), Some(1));
    assert_eq!(header.segments().unwrap().len(), 1);
}

// [Error Cases]

#[test]
fn test_missing_record_line() {
    let header_text = "# Only comments\n\
                      # No record line\n";

    let mut reader = Cursor::new(header_text);
    let result = Header::from_reader(&mut reader);

    assert!(result.is_err());
    if let Err(Error::InvalidHeader(msg)) = result {
        assert!(msg.contains("Missing record line"));
    } else {
        panic!("Expected InvalidHeader error");
    }
}

#[test]
fn test_insufficient_signal_specifications() {
    let header_text = "100 2 360\n\
                      100.dat 212 200\n";

    let mut reader = Cursor::new(header_text);
    let result = Header::from_reader(&mut reader);

    assert!(result.is_err());
    if let Err(Error::InvalidHeader(msg)) = result {
        assert!(msg.contains("Expected 2 signal specifications"));
    } else {
        panic!("Expected InvalidHeader error");
    }
}

#[test]
fn test_insufficient_segment_specifications() {
    let header_text = "multi/3 2 360\n\
                      100s 21600\n";

    let mut reader = Cursor::new(header_text);
    let result = Header::from_reader(&mut reader);

    assert!(result.is_err());
    if let Err(Error::InvalidHeader(msg)) = result {
        assert!(msg.contains("Expected 3 segment specifications"));
    } else {
        panic!("Expected InvalidHeader error");
    }
}

#[test]
fn test_empty_header() {
    let header_text = "";

    let mut reader = Cursor::new(header_text);
    let result = Header::from_reader(&mut reader);

    assert!(result.is_err());
}

#[test]
fn test_only_whitespace() {
    let header_text = "   \n\t\n   ";

    let mut reader = Cursor::new(header_text);
    let result = Header::from_reader(&mut reader);

    assert!(result.is_err());
}

// [Accessor Tests]

#[test]
fn test_metadata_accessor() {
    let header_text = "100 2 360 650000\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    let metadata = header.metadata();
    assert_eq!(metadata.name(), "100");
    assert_eq!(metadata.num_signals(), 2);
    assert!((metadata.sampling_frequency() - 360.0).abs() < f64::EPSILON);
}

#[test]
fn test_num_signals_accessor() {
    let header_text = "100 3 360\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n\
                      100.dat 212 200\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.num_signals(), 3);
}

// [Real-World Examples]

#[test]
fn test_mit_bih_style_header() {
    let header_text = "100 2 360 650000\n\
                      100.dat 212 200 11 1024 995 43405 0 MLII\n\
                      100.dat 212 200 11 1024 1011 20052 0 V5\n\
                      # 69 M 1085 1629 x1\n\
                      # Aldomet, Inderal\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "100");
    assert_eq!(header.num_signals(), 2);
    assert!(!header.is_multi_segment());

    let signals = header.signals().unwrap();
    assert_eq!(signals[0].description(), Some("MLII"));
    assert_eq!(signals[1].description(), Some("V5"));

    assert_eq!(header.info_strings().len(), 2);
}

#[test]
fn test_aha_db_style_header() {
    let header_text = "7001 2 250 525000\n\
                      data0 8 100 10 0 -53 64257 0 ECG signal 0\n\
                      data1 8 100 10 0 -69 15626 0 ECG signal 1\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "7001");
    assert!((header.metadata().sampling_frequency() - 250.0).abs() < f64::EPSILON);
    assert_eq!(header.signals().unwrap().len(), 2);
}

// [Edge Cases]

#[test]
fn test_carriage_return_line_endings() {
    let header_text = "100 2 360\r\n100.dat 212 200\r\n100.dat 212 200\r\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "100");
    assert_eq!(header.signals().unwrap().len(), 2);
}

#[test]
fn test_mixed_line_endings() {
    let header_text = "100 2 360\r\n100.dat 212 200\n100.dat 212 200\r\n";

    let mut reader = Cursor::new(header_text);
    let header = Header::from_reader(&mut reader).unwrap();

    assert_eq!(header.metadata().name(), "100");
    assert_eq!(header.signals().unwrap().len(), 2);
}