Distributed acoustic sensing analysis tools for Bioacoustics
Project description
DAS4Whales
Documentation
The full documentation of the DAS4Whales package is available at das4whales.readthedocs.io
About DAS4Whales
Python package to analyze Distributed Acoustic Sensing (DAS) data for marine bioacoustics
Authors:
- Léa Bouffaut, Ph.D.
K. Lisa Yang Center for Conservation Bioacoustics, Cornell Lab of Ornithology, Cornell University. Ithaca (NY), USA
- Quentin Goestchel, Ph.D.
William Wilcock Lab - Ocean Data Lab, School of Oceanography, University of Washington. Seattle (WA), USA
Please cite this package as:
Léa Bouffaut (2023). DAS4Whales: A Python package to analyze Distributed Acoustic Sensing (DAS) data for marine bioacoustics (v0.1.0). Zenodo. https://doi.org/10.5281/zenodo.7760187
Background
Distributed acoustic sensing or DAS, offers exciting new opportunities to eavesdrop on whales by converting existing fiber optic cables into dense listening arrays of strain sensors. It exploits the physics of Raleigh backscattering following the introduction of an interrogating pulse in the fiber, converting time-delays (or phase changes) of the backscattered pulses into strain measurements, analogous to acoustic pressure. DAS is also known as Distributed Fiber Optic Sensing (DFOS), coherent backscattering, Phase Optical Time Domain Reflectometry ($\Phi$-OTDR).
For a complete DAS technical overview see:
Hartog, A. H. (2017). An Introduction to Distributed Optical Fibre Sensors (1st ed.). CRC Press. https://doi.org/10.1201/9781315119014
For the specific application of DAS for whale bioacoustics (we will use the same terminology) see:
Bouffaut, L., Taweesintananon, K., Kriesell, H. J., Rørstadbotnen, R. A., Potter, J. R., Landrø, M., Johansen, S. E., Brenne, J. K., Haukanes, A., Schjelderup, O., & Storvik, F. (2022). Eavesdropping at the Speed of Light: Distributed Acoustic Sensing of Baleen Whales in the Arctic. Frontiers in Marine Science, 9, 901348. https://doi.org/10.3389/fmars.2022.901348
How-to use the das4whales package
This Jupyter notebook available in Colab provides an illustration of the current functionalities of the DAS4Whales python package, available on this GitHub repository. For now, the package enables basic manipulations and visualizations of DAS data such as:
- reading the metadata and loading DAS strain data from a hdf5 file -- functionalities available in the module
das4whales.data_handle, - high-pass, band-pass and frequency-wavenumber (f-k) filtering -- functionalities available in the module
das4whales.dsp, - spatio-temporal (t-x plot), spatio-spectral (f-x plot) and single channel spectro-temporal (spectrogram) representations -- functionalities available in the module
das4whales.plot, - single channel sound playbacks -- functionality available in this notebook
All functions have built-in documentation accessible through the pythonic help(das4whales.module.function) and on the DAS4Whales documentation.
DAS data
If you don't have DAS data, we've got you covered! This notebook is set to automatically download a file from the RAPID: Distributed Acoustic Sensing on the OOI’s Regional Cabled Array experiment in Oregon, which is available in open access. The data we'll look at was recorded using an OptaSense interrogator and is saved in the hdf5 format. To learn more about this experiment see:
Wilcock, W., & Ocean Observatories Initiative. (2023). Rapid: A Community Test of Distributed Acoustic Sensing on the Ocean Observatories Initiative Regional Cabled Array [Data set]. Ocean Observatories Initiative. https://doi.org/10.58046/5J60-FJ89
A final word
Please, report any bugs or issues you may have using this package and notebook either through GitHub Issues or directly by email. This is our first Python package, and we are always keen on learning how to make our work more inclusive, accessible and modular. New contributors are Welcome!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file das4whales-0.2.0.tar.gz.
File metadata
- Download URL: das4whales-0.2.0.tar.gz
- Upload date:
- Size: 79.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
006febec851cabbfda0b0a71cc8f19516d9e32391149cbd6ee881decad23ae08
|
|
| MD5 |
3e47195e2e3b4365d60673f0e9ca1b23
|
|
| BLAKE2b-256 |
61b7d3451230904344ebc454faaed4b516f8452abd91572d052e17bd734edd8f
|
Provenance
The following attestation bundles were made for das4whales-0.2.0.tar.gz:
Publisher:
publish.yml on DAS4Whales/DAS4Whales
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
das4whales-0.2.0.tar.gz -
Subject digest:
006febec851cabbfda0b0a71cc8f19516d9e32391149cbd6ee881decad23ae08 - Sigstore transparency entry: 768624296
- Sigstore integration time:
-
Permalink:
DAS4Whales/DAS4Whales@042cc9e199216b119190da14fdab2e39f8b04adb -
Branch / Tag:
refs/heads/main - Owner: https://github.com/DAS4Whales
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@042cc9e199216b119190da14fdab2e39f8b04adb -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file das4whales-0.2.0-py2.py3-none-any.whl.
File metadata
- Download URL: das4whales-0.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 88.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
081898fba3e12489f08d9739cf09a45d360532390b997824fce8bc8d0efcdaf8
|
|
| MD5 |
35535beb61f5a1b9b9ab1fdb576dafdd
|
|
| BLAKE2b-256 |
7cfca8a3f97b3740cfc874e506600b3b852d364340f9d13136e07514275694bf
|
Provenance
The following attestation bundles were made for das4whales-0.2.0-py2.py3-none-any.whl:
Publisher:
publish.yml on DAS4Whales/DAS4Whales
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
das4whales-0.2.0-py2.py3-none-any.whl -
Subject digest:
081898fba3e12489f08d9739cf09a45d360532390b997824fce8bc8d0efcdaf8 - Sigstore transparency entry: 768624299
- Sigstore integration time:
-
Permalink:
DAS4Whales/DAS4Whales@042cc9e199216b119190da14fdab2e39f8b04adb -
Branch / Tag:
refs/heads/main - Owner: https://github.com/DAS4Whales
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@042cc9e199216b119190da14fdab2e39f8b04adb -
Trigger Event:
workflow_dispatch
-
Statement type: