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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
|
%global _empty_manifest_terminate_build 0
Name: python-bioread
Version: 3.0.1
Release: 1
Summary: Utilities to read BIOPAC AcqKnowledge files
License: MIT
URL: https://github.com/uwmadison-chm/bioread
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ed/b7/8b02a8ceffbbfccc5f5190eb369faa93dd6a013ace4875bc68b679eadd60/bioread-3.0.1.tar.gz
BuildArch: noarch
Requires: python3-numpy
Requires: python3-docopt
Requires: python3-scipy
Requires: python3-h5py
Requires: python3-h5py
Requires: python3-scipy
%description
# Libraries for reading BIOPAC files
[](https://zenodo.org/badge/latestdoi/970625)
These utilities are for reading the files produced by BIOPAC's AcqKnowledge software. Much of the information is based on [Application Note 156](http://www.biopac.com/Manuals/app_pdf/app156.pdf) from BIOPAC; however, newer file formats were decoded through the tireless efforts of John Ollinger and Nate Vack.
This library is mostly concerned with getting you the data, and less so with interpreting UI-related header values.
## Status
As far as I know, this should read any AcqKnowledge file you throw at it. Windows, Mac, uncompressed, compressed, old, new... it should happily read 'em all. If you have trouble with a file, I'd love to get a copy and make bioread work with it.
## Installation
We're up in [pypi](http://pypi.python.org/pypi), so installing should be as simple as:
```
pip install bioread
```
Some of the optional parts of bioread depend on external libraries. `acq2hdf5` depends on [h5py](https://www.h5py.org/) and `acq2mat` depends on [scipy](https://www.scipy.org/), but as neither of those are core parts of bioread (and can be hairy to get working on some systems), they aren't installed by default. To get them, do:
```
# Just h5py
pip install bioread[hdf5]
# Just scipy
pip install bioread[mat]
# The whole shebang
pip install bioread[all]
```
As of May 2020 (version 2), we now require Python 3.6 or later. Versions 1.0.4 and below should work with Python 2.7 and up.
## API Usage:
* [jupyter notebook: Quick Demo](http://uwmadison-chm.github.io/bioread/bioread_quick_demo.html)
## Command-line usage:
### acq2hdf5
If you want to convert files out of AcqKnowledge, this is probably what you want to use -- Matlab can read these out of the box and there are libraries for R and such. This converts the file, storing channels as datasets with names like `/channels/channel_0` and metadata in attributes. Event markers are stored in `/event_markers/marker_X`
```
Convert an AcqKnowledge file to an HDF5 file.
Usage:
acq2hdf5 [options] <acq_file> <hdf5_file>
acq2hdf5 -h | --help
acq2hdf5 --version
Options:
--values-as=<type> Save raw measurement values, stored as integers in the
base file, as either 'raw' or 'scaled'. If stored as
raw, you can convert to scaled using the scale and
offset attributes on the channel. If storing scaled
values, scale and offset will be 1 and 0.
[default: scaled]
--compress=<method> How to compress data. Options are gzip, lzf, none.
[default: gzip]
--data-only Only save data and required headers -- do not save
journal or marker information.
-v, --verbose Print extra messages for debugging.
```
Note this does *not* need to read the entire dataset into memory, so if you have a 2G dataset, this will work great.
To get the values you see in AcqKnowledge, leave the `--values-as` option to its default ('scaled'). For faster performance, less memory usage, and smaller files, you can use 'raw' and convert the channel later (if you care) with the scale and offset attributes.
Generally, gzip compression seems to work very well, but if you're making something really big you might want to use lzf (worse compression, much faster).
What you'll find in the file:
#### Root-level attributes:
* `file_revision` The internal AckKnowledge file version number
* `samples_per_second` The base sampling rate of the file
* `byte_order` The original file's byte ordering
* `journal` The file's journal data.
#### Channel-level attributes:
* `scale` The scale factor of raw data (for float-type data, will be 1)
* `offset` The offset of raw data (for float-type data, will be 0)
* `frequency_divider` The sampling rate divider for this channel
* `samples_per_second` The channel's sampling rate
* `name` The name of the channel
* `units` The units for the channel
* `channel_number` The display number for the channel (used in markers)
#### Markers
* `label` A text label for the channel
* `type` A description of this marker's type
* `type_code` A short, 4-character code for type
* `global_sample_index` The index, in units of the main sampling rate, of this marker
* `channel` A hard link to the referred channel (only for non-global events)
* `channel_number` The display number for the channel (only for non-global events)
* `channel_sample_index` The in the channel's data where this marker belongs (only for non-global events)
### acq2mat
**Note:** I recommend `acq2hdf5` for exporting to Matlab. This program is still around because hey: It works.
This program creates a Matlab (version 5) file from an AcqKnowledge file. On the back-end, it uses [scipy.io.savemat](http://docs.scipy.org/doc/scipy/reference/generated/scipy.io.savemat.html). Channels are stored in a cell array named 'channels'.
```
Convert an AcqKnowledge file to a MATLAB file.
Usage:
acq2mat [options] <acq_file> <mat_file>
acq2mat -h | --help
acq2mat --version
Options:
-c, --compress Save compressed Matlab file
--data-only Only save data and required header information -- do not
save event markers.
Note: scipy is required for this program.
```
If you've saved a file as `myfile.mat`, you can, in Matlab:
```
>> data = load('myfile.mat')
data =
channels: {1x2 cell}
markers: {1x3 cell}
headers: [1x1 struct]
samples_per_second: 1000
>> data.channels{1}
ans =
units: 'Percent'
frequency_divider: 1
samples_per_second: 1000
data: [1x10002 double]
name: 'CO2'
>> plot(data.channels{1}.data)
(Plots the data)
>> data.markers{1}
ans =
style: 'apnd'
sample_index: 0
label: 'Segment 1'
channel: Global
```
### acq2txt
acq2txt will take the data in an AcqKnowledge file and write it to a tab-delimited text file. By default, all channels (plus a time index) will be
written.
```
Write the data from an AcqKnowledge file channel to a text file.
Usage:
acq2txt [options] <acq_file>
acq2txt -h | --help
acq2txt --version
Options:
--version Show program's version number and exit.
-h, --help Show this help message and exit.
--channel-indexes=<indexes> The indexes of the channels to extract.
Separate numbers with commas. Default is to
extract all channels.
-o, --outfile=<file> Write to a file instead of standard out.
--missing-as=<val> What value to write where a channel is not
sampled. [default: ]
The first column will always be time in seconds. Channel raw values are
converted with scale and offset into native units.
```
### acq_info
acq_info prints out some simple debugging information about an AcqKnowledge file. It'll do its best to print something out even for damaged files.
```
Print some information about an AcqKnowledge file.
Usage:
acq_info [options] <acq_file>
acq_info -h | --help
acq_info --version
Options:
-d, --debug print lots of debugging data
Note: Using - for <acq_file> reads from stdin.
```
As noted in the usage instructions, acq_info will read from stdin, so if your files are gzipped, you can say:
```
zcat myfile.acq.gz | acq_info -
```
### acq_markers
Prints all of the markers in an AcqKnowlege file to a tab-delimited format, either to stdout or to a specified file. Fields are:
`filename time (s) label channel style`
```
Print the event markers from an AcqKnowledge file.
Usage:
acq_markers [options] <file>...
acq_markers -h | --help
acq_markers --version
Options:
-o <file> Write to a file instead of standard output.
```
Note that this one does not read from stdin; in this case, printing the markers from a large number of files was more important than feeding from `zcat` or something.
## Notes
I've tested all the various vintages of files I can think of and find, except very old (AcqKnowledge 2.x) files.
Also, the channel order I read is not the one displayed in the AcqKnowledge interface. Neither the order of the data nor any channel header value I can find seems to entirely control that. I'm gonna just assume it's not a very big deal.
## File Format Documentation
While there's no substite for code diving to see how things really work, I've written some [quick documentation of the file format.](https://github.com/njvack/bioread/blob/master/notes/file_format.md)
In addition, developer Mike Davison did a great job figuring out additional .acq file format information (far more than is implemented in bioread!); his contribuions are in notes/acqknowledge_file_structure.pdf
## Credits
This code was pretty much all written by Nate Vack <njvack@wisc.edu>, with a lot of initial research done by John Ollinger.
## Copyright & Disclaimers
bioread is distributed under the MIT license. For more details, see LICENSE.
BIOPAC and AcqKnowledge are trademarks of BIOPAC Systems, Inc. The authors of this software have no affiliation with BIOPAC Systems, Inc, and that company neither supports nor endorses this software package.
%package -n python3-bioread
Summary: Utilities to read BIOPAC AcqKnowledge files
Provides: python-bioread
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-bioread
# Libraries for reading BIOPAC files
[](https://zenodo.org/badge/latestdoi/970625)
These utilities are for reading the files produced by BIOPAC's AcqKnowledge software. Much of the information is based on [Application Note 156](http://www.biopac.com/Manuals/app_pdf/app156.pdf) from BIOPAC; however, newer file formats were decoded through the tireless efforts of John Ollinger and Nate Vack.
This library is mostly concerned with getting you the data, and less so with interpreting UI-related header values.
## Status
As far as I know, this should read any AcqKnowledge file you throw at it. Windows, Mac, uncompressed, compressed, old, new... it should happily read 'em all. If you have trouble with a file, I'd love to get a copy and make bioread work with it.
## Installation
We're up in [pypi](http://pypi.python.org/pypi), so installing should be as simple as:
```
pip install bioread
```
Some of the optional parts of bioread depend on external libraries. `acq2hdf5` depends on [h5py](https://www.h5py.org/) and `acq2mat` depends on [scipy](https://www.scipy.org/), but as neither of those are core parts of bioread (and can be hairy to get working on some systems), they aren't installed by default. To get them, do:
```
# Just h5py
pip install bioread[hdf5]
# Just scipy
pip install bioread[mat]
# The whole shebang
pip install bioread[all]
```
As of May 2020 (version 2), we now require Python 3.6 or later. Versions 1.0.4 and below should work with Python 2.7 and up.
## API Usage:
* [jupyter notebook: Quick Demo](http://uwmadison-chm.github.io/bioread/bioread_quick_demo.html)
## Command-line usage:
### acq2hdf5
If you want to convert files out of AcqKnowledge, this is probably what you want to use -- Matlab can read these out of the box and there are libraries for R and such. This converts the file, storing channels as datasets with names like `/channels/channel_0` and metadata in attributes. Event markers are stored in `/event_markers/marker_X`
```
Convert an AcqKnowledge file to an HDF5 file.
Usage:
acq2hdf5 [options] <acq_file> <hdf5_file>
acq2hdf5 -h | --help
acq2hdf5 --version
Options:
--values-as=<type> Save raw measurement values, stored as integers in the
base file, as either 'raw' or 'scaled'. If stored as
raw, you can convert to scaled using the scale and
offset attributes on the channel. If storing scaled
values, scale and offset will be 1 and 0.
[default: scaled]
--compress=<method> How to compress data. Options are gzip, lzf, none.
[default: gzip]
--data-only Only save data and required headers -- do not save
journal or marker information.
-v, --verbose Print extra messages for debugging.
```
Note this does *not* need to read the entire dataset into memory, so if you have a 2G dataset, this will work great.
To get the values you see in AcqKnowledge, leave the `--values-as` option to its default ('scaled'). For faster performance, less memory usage, and smaller files, you can use 'raw' and convert the channel later (if you care) with the scale and offset attributes.
Generally, gzip compression seems to work very well, but if you're making something really big you might want to use lzf (worse compression, much faster).
What you'll find in the file:
#### Root-level attributes:
* `file_revision` The internal AckKnowledge file version number
* `samples_per_second` The base sampling rate of the file
* `byte_order` The original file's byte ordering
* `journal` The file's journal data.
#### Channel-level attributes:
* `scale` The scale factor of raw data (for float-type data, will be 1)
* `offset` The offset of raw data (for float-type data, will be 0)
* `frequency_divider` The sampling rate divider for this channel
* `samples_per_second` The channel's sampling rate
* `name` The name of the channel
* `units` The units for the channel
* `channel_number` The display number for the channel (used in markers)
#### Markers
* `label` A text label for the channel
* `type` A description of this marker's type
* `type_code` A short, 4-character code for type
* `global_sample_index` The index, in units of the main sampling rate, of this marker
* `channel` A hard link to the referred channel (only for non-global events)
* `channel_number` The display number for the channel (only for non-global events)
* `channel_sample_index` The in the channel's data where this marker belongs (only for non-global events)
### acq2mat
**Note:** I recommend `acq2hdf5` for exporting to Matlab. This program is still around because hey: It works.
This program creates a Matlab (version 5) file from an AcqKnowledge file. On the back-end, it uses [scipy.io.savemat](http://docs.scipy.org/doc/scipy/reference/generated/scipy.io.savemat.html). Channels are stored in a cell array named 'channels'.
```
Convert an AcqKnowledge file to a MATLAB file.
Usage:
acq2mat [options] <acq_file> <mat_file>
acq2mat -h | --help
acq2mat --version
Options:
-c, --compress Save compressed Matlab file
--data-only Only save data and required header information -- do not
save event markers.
Note: scipy is required for this program.
```
If you've saved a file as `myfile.mat`, you can, in Matlab:
```
>> data = load('myfile.mat')
data =
channels: {1x2 cell}
markers: {1x3 cell}
headers: [1x1 struct]
samples_per_second: 1000
>> data.channels{1}
ans =
units: 'Percent'
frequency_divider: 1
samples_per_second: 1000
data: [1x10002 double]
name: 'CO2'
>> plot(data.channels{1}.data)
(Plots the data)
>> data.markers{1}
ans =
style: 'apnd'
sample_index: 0
label: 'Segment 1'
channel: Global
```
### acq2txt
acq2txt will take the data in an AcqKnowledge file and write it to a tab-delimited text file. By default, all channels (plus a time index) will be
written.
```
Write the data from an AcqKnowledge file channel to a text file.
Usage:
acq2txt [options] <acq_file>
acq2txt -h | --help
acq2txt --version
Options:
--version Show program's version number and exit.
-h, --help Show this help message and exit.
--channel-indexes=<indexes> The indexes of the channels to extract.
Separate numbers with commas. Default is to
extract all channels.
-o, --outfile=<file> Write to a file instead of standard out.
--missing-as=<val> What value to write where a channel is not
sampled. [default: ]
The first column will always be time in seconds. Channel raw values are
converted with scale and offset into native units.
```
### acq_info
acq_info prints out some simple debugging information about an AcqKnowledge file. It'll do its best to print something out even for damaged files.
```
Print some information about an AcqKnowledge file.
Usage:
acq_info [options] <acq_file>
acq_info -h | --help
acq_info --version
Options:
-d, --debug print lots of debugging data
Note: Using - for <acq_file> reads from stdin.
```
As noted in the usage instructions, acq_info will read from stdin, so if your files are gzipped, you can say:
```
zcat myfile.acq.gz | acq_info -
```
### acq_markers
Prints all of the markers in an AcqKnowlege file to a tab-delimited format, either to stdout or to a specified file. Fields are:
`filename time (s) label channel style`
```
Print the event markers from an AcqKnowledge file.
Usage:
acq_markers [options] <file>...
acq_markers -h | --help
acq_markers --version
Options:
-o <file> Write to a file instead of standard output.
```
Note that this one does not read from stdin; in this case, printing the markers from a large number of files was more important than feeding from `zcat` or something.
## Notes
I've tested all the various vintages of files I can think of and find, except very old (AcqKnowledge 2.x) files.
Also, the channel order I read is not the one displayed in the AcqKnowledge interface. Neither the order of the data nor any channel header value I can find seems to entirely control that. I'm gonna just assume it's not a very big deal.
## File Format Documentation
While there's no substite for code diving to see how things really work, I've written some [quick documentation of the file format.](https://github.com/njvack/bioread/blob/master/notes/file_format.md)
In addition, developer Mike Davison did a great job figuring out additional .acq file format information (far more than is implemented in bioread!); his contribuions are in notes/acqknowledge_file_structure.pdf
## Credits
This code was pretty much all written by Nate Vack <njvack@wisc.edu>, with a lot of initial research done by John Ollinger.
## Copyright & Disclaimers
bioread is distributed under the MIT license. For more details, see LICENSE.
BIOPAC and AcqKnowledge are trademarks of BIOPAC Systems, Inc. The authors of this software have no affiliation with BIOPAC Systems, Inc, and that company neither supports nor endorses this software package.
%package help
Summary: Development documents and examples for bioread
Provides: python3-bioread-doc
%description help
# Libraries for reading BIOPAC files
[](https://zenodo.org/badge/latestdoi/970625)
These utilities are for reading the files produced by BIOPAC's AcqKnowledge software. Much of the information is based on [Application Note 156](http://www.biopac.com/Manuals/app_pdf/app156.pdf) from BIOPAC; however, newer file formats were decoded through the tireless efforts of John Ollinger and Nate Vack.
This library is mostly concerned with getting you the data, and less so with interpreting UI-related header values.
## Status
As far as I know, this should read any AcqKnowledge file you throw at it. Windows, Mac, uncompressed, compressed, old, new... it should happily read 'em all. If you have trouble with a file, I'd love to get a copy and make bioread work with it.
## Installation
We're up in [pypi](http://pypi.python.org/pypi), so installing should be as simple as:
```
pip install bioread
```
Some of the optional parts of bioread depend on external libraries. `acq2hdf5` depends on [h5py](https://www.h5py.org/) and `acq2mat` depends on [scipy](https://www.scipy.org/), but as neither of those are core parts of bioread (and can be hairy to get working on some systems), they aren't installed by default. To get them, do:
```
# Just h5py
pip install bioread[hdf5]
# Just scipy
pip install bioread[mat]
# The whole shebang
pip install bioread[all]
```
As of May 2020 (version 2), we now require Python 3.6 or later. Versions 1.0.4 and below should work with Python 2.7 and up.
## API Usage:
* [jupyter notebook: Quick Demo](http://uwmadison-chm.github.io/bioread/bioread_quick_demo.html)
## Command-line usage:
### acq2hdf5
If you want to convert files out of AcqKnowledge, this is probably what you want to use -- Matlab can read these out of the box and there are libraries for R and such. This converts the file, storing channels as datasets with names like `/channels/channel_0` and metadata in attributes. Event markers are stored in `/event_markers/marker_X`
```
Convert an AcqKnowledge file to an HDF5 file.
Usage:
acq2hdf5 [options] <acq_file> <hdf5_file>
acq2hdf5 -h | --help
acq2hdf5 --version
Options:
--values-as=<type> Save raw measurement values, stored as integers in the
base file, as either 'raw' or 'scaled'. If stored as
raw, you can convert to scaled using the scale and
offset attributes on the channel. If storing scaled
values, scale and offset will be 1 and 0.
[default: scaled]
--compress=<method> How to compress data. Options are gzip, lzf, none.
[default: gzip]
--data-only Only save data and required headers -- do not save
journal or marker information.
-v, --verbose Print extra messages for debugging.
```
Note this does *not* need to read the entire dataset into memory, so if you have a 2G dataset, this will work great.
To get the values you see in AcqKnowledge, leave the `--values-as` option to its default ('scaled'). For faster performance, less memory usage, and smaller files, you can use 'raw' and convert the channel later (if you care) with the scale and offset attributes.
Generally, gzip compression seems to work very well, but if you're making something really big you might want to use lzf (worse compression, much faster).
What you'll find in the file:
#### Root-level attributes:
* `file_revision` The internal AckKnowledge file version number
* `samples_per_second` The base sampling rate of the file
* `byte_order` The original file's byte ordering
* `journal` The file's journal data.
#### Channel-level attributes:
* `scale` The scale factor of raw data (for float-type data, will be 1)
* `offset` The offset of raw data (for float-type data, will be 0)
* `frequency_divider` The sampling rate divider for this channel
* `samples_per_second` The channel's sampling rate
* `name` The name of the channel
* `units` The units for the channel
* `channel_number` The display number for the channel (used in markers)
#### Markers
* `label` A text label for the channel
* `type` A description of this marker's type
* `type_code` A short, 4-character code for type
* `global_sample_index` The index, in units of the main sampling rate, of this marker
* `channel` A hard link to the referred channel (only for non-global events)
* `channel_number` The display number for the channel (only for non-global events)
* `channel_sample_index` The in the channel's data where this marker belongs (only for non-global events)
### acq2mat
**Note:** I recommend `acq2hdf5` for exporting to Matlab. This program is still around because hey: It works.
This program creates a Matlab (version 5) file from an AcqKnowledge file. On the back-end, it uses [scipy.io.savemat](http://docs.scipy.org/doc/scipy/reference/generated/scipy.io.savemat.html). Channels are stored in a cell array named 'channels'.
```
Convert an AcqKnowledge file to a MATLAB file.
Usage:
acq2mat [options] <acq_file> <mat_file>
acq2mat -h | --help
acq2mat --version
Options:
-c, --compress Save compressed Matlab file
--data-only Only save data and required header information -- do not
save event markers.
Note: scipy is required for this program.
```
If you've saved a file as `myfile.mat`, you can, in Matlab:
```
>> data = load('myfile.mat')
data =
channels: {1x2 cell}
markers: {1x3 cell}
headers: [1x1 struct]
samples_per_second: 1000
>> data.channels{1}
ans =
units: 'Percent'
frequency_divider: 1
samples_per_second: 1000
data: [1x10002 double]
name: 'CO2'
>> plot(data.channels{1}.data)
(Plots the data)
>> data.markers{1}
ans =
style: 'apnd'
sample_index: 0
label: 'Segment 1'
channel: Global
```
### acq2txt
acq2txt will take the data in an AcqKnowledge file and write it to a tab-delimited text file. By default, all channels (plus a time index) will be
written.
```
Write the data from an AcqKnowledge file channel to a text file.
Usage:
acq2txt [options] <acq_file>
acq2txt -h | --help
acq2txt --version
Options:
--version Show program's version number and exit.
-h, --help Show this help message and exit.
--channel-indexes=<indexes> The indexes of the channels to extract.
Separate numbers with commas. Default is to
extract all channels.
-o, --outfile=<file> Write to a file instead of standard out.
--missing-as=<val> What value to write where a channel is not
sampled. [default: ]
The first column will always be time in seconds. Channel raw values are
converted with scale and offset into native units.
```
### acq_info
acq_info prints out some simple debugging information about an AcqKnowledge file. It'll do its best to print something out even for damaged files.
```
Print some information about an AcqKnowledge file.
Usage:
acq_info [options] <acq_file>
acq_info -h | --help
acq_info --version
Options:
-d, --debug print lots of debugging data
Note: Using - for <acq_file> reads from stdin.
```
As noted in the usage instructions, acq_info will read from stdin, so if your files are gzipped, you can say:
```
zcat myfile.acq.gz | acq_info -
```
### acq_markers
Prints all of the markers in an AcqKnowlege file to a tab-delimited format, either to stdout or to a specified file. Fields are:
`filename time (s) label channel style`
```
Print the event markers from an AcqKnowledge file.
Usage:
acq_markers [options] <file>...
acq_markers -h | --help
acq_markers --version
Options:
-o <file> Write to a file instead of standard output.
```
Note that this one does not read from stdin; in this case, printing the markers from a large number of files was more important than feeding from `zcat` or something.
## Notes
I've tested all the various vintages of files I can think of and find, except very old (AcqKnowledge 2.x) files.
Also, the channel order I read is not the one displayed in the AcqKnowledge interface. Neither the order of the data nor any channel header value I can find seems to entirely control that. I'm gonna just assume it's not a very big deal.
## File Format Documentation
While there's no substite for code diving to see how things really work, I've written some [quick documentation of the file format.](https://github.com/njvack/bioread/blob/master/notes/file_format.md)
In addition, developer Mike Davison did a great job figuring out additional .acq file format information (far more than is implemented in bioread!); his contribuions are in notes/acqknowledge_file_structure.pdf
## Credits
This code was pretty much all written by Nate Vack <njvack@wisc.edu>, with a lot of initial research done by John Ollinger.
## Copyright & Disclaimers
bioread is distributed under the MIT license. For more details, see LICENSE.
BIOPAC and AcqKnowledge are trademarks of BIOPAC Systems, Inc. The authors of this software have no affiliation with BIOPAC Systems, Inc, and that company neither supports nor endorses this software package.
%prep
%autosetup -n bioread-3.0.1
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-bioread -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Wed May 31 2023 Python_Bot <Python_Bot@openeuler.org> - 3.0.1-1
- Package Spec generated
|