Latest Release |
|
License |
|
Documentation |
|
Build Status |
|
Code style |
|
Citation |
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:
entrained air (turbulence) line
seafloor line
surface line
nearfield line
passive data regions
(unreliable) bad data regions for entirely removed periods of time, in the form of boxes covering the entire vertical depth
(unreliable) 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). The training and evaluation data is available for download. Queries regarding dataset access should be directed to FORCE, info@fundyforce.ca.
The experimental methodology and results can be found in our companion paper, published in Frontiers in Marine Science.
Full documentation of how to use echofilter can be viewed at readthedocs.
If you encounter a specific problem please open a new issue.
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 --helpFor more details, see the Usage Guide, and the command line interface (CLI) reference documentation.
Installation
Installing as a stand-alone executable
For your convenience, we provide a copy of Echofilter compiled as a stand-alone executable for Windows. To install this, download and unzip the echofilter-executable-M.N.P.zip file from the latest release in the releases tab. For example: echofilter-executable-1.2.0.zip
For more details, see the step-by-step instructions in the Usage Guide.
Note: The precompiled executable has only CPU support, and does not support running on GPU.
Installing in Python
Alternatively, the echofilter package can be installed for Python 3.6 or 3.7 using pip as follows.
First, install torch.
Either with CPU-only capabilities:
pip install torch==1.4.0+cpu torchvision==0.5.0+cpu -f https://download.pytorch.org/whl/torch_stable.htmlOr with CUDA GPU support as well:
pip install torch==1.4.0 torchvision==0.5.0 -f https://download.pytorch.org/whl/torch_stable.htmlThen install the rest of the requirements.
pip install -r frozen_requirements.txt
pip install echofilterCiting Echofilter
For technical details about how the Echofilter model was trained, and our findings about its empirical results, please consult our companion paper:
SC Lowe, LP McGarry, J Douglas, J Newport, S Oore, C Whidden, DJ Hasselman (2022). Echofilter: A Deep Learning Segmention Model Improves the Automation, Standardization, and Timeliness for Post-Processing Echosounder Data in Tidal Energy Streams. Front. Mar. Sci., 9, 1–21. doi: 10.3389/fmars.2022.867857.
If you use Echofilter for your research, we would be grateful if you could cite this paper in any resulting publications.
For your convenience, we provide a copy of this citation in bibtex format.
You can browse papers which utilise Echofilter here.
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/>.
1 maintainer
Metadata
1 maintainer
Release files for echofilter 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| echofilter-1.2.0.tar.gz | 165.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| echofilter-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 344.8 kB
Release files / echofilter-1.2.0.tar.gz
| Download URL | echofilter-1.2.0.tar.gz |
|---|---|
| Size | 165.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f0d326f35a7ac06114e27ae645aa2517f23a633dbc599522b20edd3acb0cbdea
|
|
BLAKE2b-256 checksum How to use checksums |
e696149ccb3a34f64c488d05e1b1b5b35254f5780b1cede7574a25621acf8cfd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.7.15
|
Release files / echofilter-1.2.0-py3-none-any.whl
| Download URL | echofilter-1.2.0-py3-none-any.whl |
|---|---|
| Size | 179.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
26b5b475b59b97aea06bede0ae2b5864b4e9909c81248cfce8248e4ff79c174c
|
|
BLAKE2b-256 checksum How to use checksums |
1fe7cbc6776148660d783c235b2dbeff2f69fbf028e0cd2aa7f74c4b87ad90ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.7.15
|
