echofilter 1.0.2

Remove echosounder noise by identifying the ocean floor and entrained air at the ocean surface.

Echofilter is an application for segmenting an echogram. It takes as its input an Echoview .EV file, and produces as its output several lines and regions:

• turbulence (entrained air) line

• bottom (seafloor) line

• surface line

• nearfield line

• passive data regions

• *bad data regions for entirely removed periods of time, in the form of boxes covering the entire vertical depth

• *bad data regions for localised anomalies, in the form of polygonal contour patches

Echofilter uses a machine learning model to complete this task. The machine learning model was trained on upfacing stationary and downfacing mobile data provided by Fundy Ocean Research Centre for Energy (FORCE).

Full documentation can be viewed here.

Usage

After installing, the model can be applied at the command prompt with:

echofilter PATH PATH2 ...

Any number of paths can be specified. Each path can either be a path to a single csv file to process (exported using the Echoview application), or a directory containing csv files. If a directory is given, all csv files within nested subfolders of the directory will be processed.

All optional parameters can be seen by running echofilter with the help argument.

echofilter -h

Installation

The package can be installed using pip as follows:

pip install git+https://github.com/DeepSenseCA/echofilter

License

Copyright (C) 2020-2022 Scott C. Lowe and Offshore Energy Research Association (OERA)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.