Pyread7k is a library for reading 7k files. It provides a high-level interface to the data in a file, with an API that is a compromise between being ergonomic, while still being easy to correllate with the Data Format Definition.
Using the PingDataset class, file data can be read on an as-needed basis with low overhead. Each Ping in the dataset contains the full set of records which are related to that specifc ping. This means you can read the amplitudes, settings, motion, etc. for any single ping without worrying about file offsets or any low-level details at all.
Low-level direct control is available with the _utils.py functions, which are reexported at top level. These allow you to read all records of a specific type manually
The 7k protocol is described in the Data Format Definition document.
The library can be installed using pip, directly from PyPI, or from the Teledyne github repository as seen below. All dependencies should be automatically installed.
pip install pyread7k
pip install git+https://github.com/Teledyne-Marine/pyread7k.gitWorking with the pyread7k library is quite intuitive, and given that you have a s7k file, you can load a dataset using the PingDataset class:
import pyread7k
dataset = pyread7k.PingDataset("path/to/file.7k")This gives you access to the pings, which consist of IQ or beamformed records, along with related data. All data is loaded on-demand when accessed:
import numpy as np
for ping in dataset:
if ping.has_beamformed:
# Print mean amplitude for each ping with 7018 data
print("Mean:", np.mean(ping.beamformed.amplitudes))
# Print selected gain level for each ping
print("Gain:", ping.sonar_settings.gain_selection)Python3.8 or laterpsutil5.8.0numpy1.20.1geopy2.1.0
It is easy to add new functionality, such as supporting more record types, to pyread7k. Get up and running:
- Install the Poetry dependency/package manager
- Clone the repositorty by executing
git clone git@github.com:Teledyne-Marine/pyread7k.git - Create a development environment by navigating to the repo folder and running
poetry install
You should now have a functional environment! You can run the test suite by executing poetry run pytest. The first time you do so, you must run it with the -s argument: poetry run pytest -s. This allows the test suite to ask you to input paths to 7k files to use for the testing.
Issues and pull requests are always welcome!
Copyright 2021 Teledyne RESON A/S Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.