Echoregions
Echoregions is a Python Package that interfaces with annotations of water column sonar data for training machine learning models or doing other downstream processing such as biomass estimation.
The annotations are typically regions indicating the presence of specific animal species or lines delineating ocean boundaries, such as the seafloor or sea surface, in the "echogram" (sonar images formed by echo returns). The interfacing functionalities operate in two directions:
- Annotation to ML: Parsing and organizing annotations for preparing training and test datasets for ML developments
- ML to annotation: Generating annotations from ML predictions that can be used for further downstream processing
At present, functionalities in the Annotation to ML direction have been built for interfacing the Echoview software that is widely used in the fisheries acoustics community. We plan to add functionalities in the ML to Annotation direction in the near future.
Functionalities
As of now, Echoregions contains functions to:
- Read, organize, and store Echoview manual annotations (regions and lines)
- Create masks by combining the manual annotations and xarray water column sonar datasets generated by Echopype
Note that in Echoregions, the underlying annotation data is stored as a Pandas dataframe, which allows users to directly leverage the powerful indexing and computing functionalities provided by Pandas.
Documentation
Learn more about Echoregions functions in the documentation at https://echoregions.readthedocs.io.
See the API documentation for all of the classes and functions available in echoregions.
Contributors
Echoregions development is currently led by Caesar Tuguinay (@ctuguinay), with inputs from Wu-Jung Lee (@leewujung), Valentina Staneva (@valentina-s), and Lloyd Izard (@LOCEANlloydizard). Kavin Nguyen (@ngkavin) contributed significantly to the initial version.
Acknowledgement
We thank the NOAA Northwest Fisheries Science Center (NWFSC) Fisheries Engineering and Acoustics Team (FEAT) for supporting this project.
License
Echoregions is licensed under the open source Apache 2.0 license.
Copyright (c) 2021-2026, Echoregions Developers.
Metadata
Release files for echoregions 0.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| echoregions-0.2.4.tar.gz | 2.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| echoregions-0.2.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.3 MB
Release files / echoregions-0.2.4.tar.gz
| Download URL | echoregions-0.2.4.tar.gz |
|---|---|
| Size | 2.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b69bd8587b5e69b490049b036b657cfcfed3b77139caec7c23dbed192df0edd4
|
|
BLAKE2b-256 checksum How to use checksums |
b737b6bec7460e076f5c7e9972601275efb1f9d54d58e05f7bdccf98fe14ff9e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
Release files / echoregions-0.2.4-py3-none-any.whl
| Download URL | echoregions-0.2.4-py3-none-any.whl |
|---|---|
| Size | 99.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5ebbbd28d5b6e1d386859646c33b8477290f44867a70b910bb8f323816e20698
|
|
BLAKE2b-256 checksum How to use checksums |
21fb40031348f4e10df83eb62e35be3984c0234d6ab1e84f63137a19570c47bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|