Skip to main content

Parsers and functions for working with EVR and EVL files

Project description

Echoregions

example workflow

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) and Valentina Staneva (@valentina-s). 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.

NOAA_fisheries_logo

License

Echoregions is licensed under the open source Apache 2.0 license.


Copyright (c) 2021-2025, Echoregions Developers.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

echoregions-0.2.3.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

echoregions-0.2.3-py3-none-any.whl (94.8 kB view details)

Uploaded Python 3

File details

Details for the file echoregions-0.2.3.tar.gz.

File metadata

  • Download URL: echoregions-0.2.3.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for echoregions-0.2.3.tar.gz
Algorithm Hash digest
SHA256 ff6c2489321b2e12c51a922476255e9ac906484282376826c55e12ccb3203fb0
MD5 108e83ccb008ab53484fee16f9d7639f
BLAKE2b-256 73053353393183094d31ef6b29c25008a12e3538a479a9e83a2ff95045946fcf

See more details on using hashes here.

File details

Details for the file echoregions-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: echoregions-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 94.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for echoregions-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e0c6bd2de1e5c83c749a2de7ea8c65ab9513aa49353352c7368ba8505dce703d
MD5 82ad1a4998b62c0e827a8db95e6b9976
BLAKE2b-256 0b6b3ff64afe471c5bb9a01e63209089ed5124b3f0b40658923b9d5c28b9a679

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page