Parser for raw acoustic data

This merge request provides a toolkit for the parsing of raw acoustic data with basic functionality for:

• reading PCM data;
• building the sequence of times corresponding to the samples;
• generating WAV files with optional gain.

The current file format is quite hacky so the toolkit tries to deal with it in a hopefully sensible manner, but some choices are bound to be not very elegant.

Nevertheless it works and provides an improvement in efficiency and usability compared to previous codes.

Thanks, that looks nice!

We need to add tests though... Could you add some small raw files to KM3NeT test data (if not already done) and then a few tests?

Let me know if I can help out :)

added awaiting feedback enhancement labels

added io label

added 39 commits

• 008eb6b6...8527c743 - 32 commits from branch master
• 0fb3dbda - first interface for acoustic data
• 8db2f713 - WAV output with optional gain
• fee2b725 - tentatively deprecating zero_time
• 15dac7fa - testing configurable FRAME_LENGTH
• 3ba2b6ee - black reformatting
• 06e3322e - fix comments and filename parsing
• 065fb883 - Cleanup and fix minor bugs

Compare with previous version

added 2 commits

• 27e2a0aa - Cleanup
• 874c3b7c - Add tests for acoustic reader

Compare with previous version

I added some tests using a file provided by @rlahmann. If everything looks OK, I'll merge. I have to create a release for km3net-testdata first though, which will include the acoustics test file.

added 1 commit

• ed63b79c - Require km3net-testdata>=0.2.26

Compare with previous version

Thanks @tgal unfortunately I could not keep up with this (I apologise for not answering the MR but I think we had a private exchange at the time).

No worries! It seems to be usable at this stage. I just need to add a workaround due to a bug in the current awkward package, see https://github.com/scikit-hep/awkward-1.0/issues/968#issuecomment-871699388

added 11 commits

• b08d2f3a - 1 commit from branch master
• 729d5eb0 - first interface for acoustic data
• 483fb14b - WAV output with optional gain
• 0cf07c61 - tentatively deprecating zero_time
• 0fd7c203 - testing configurable FRAME_LENGTH
• ec6b8ea4 - black reformatting
• 325a5201 - fix comments and filename parsing
• 86b0c71e - Cleanup and fix minor bugs
• bbbc3ac2 - Cleanup
• ce56a604 - Add tests for acoustic reader
• 62fecce4 - Require km3net-testdata>=0.2.26

Compare with previous version

added 12 commits

• 62fecce4...54ef99bd - 2 commits from branch master
• b796b5d1 - first interface for acoustic data
• 4d05a7a2 - WAV output with optional gain
• e9781620 - tentatively deprecating zero_time
• 8bb0dcf8 - testing configurable FRAME_LENGTH
• 8336fc32 - black reformatting
• 6ecb9926 - fix comments and filename parsing
• 8d1115ec - Cleanup and fix minor bugs
• dd057bab - Cleanup
• c8a19f0f - Add tests for acoustic reader
• cdbc1276 - Require km3net-testdata>=0.2.26

Compare with previous version

Alright @rlahmann the MR is ready and being merged now. I will release a new version of km3io immediately.

approved this merge request

merged

mentioned in commit b787d128

Great! I tried it and it works nicely. Many thanks @tgal !