Metadata-Version: 2.1
Name: echofilter
Version: 1.0.2
Summary: Remove echosounder noise by identifying the ocean floor and entrained air at the ocean surface.
Home-page: https://github.com/DeepSenseCA/echofilter
Author: Scott C. Lowe
Author-email: scott.code.lowe@gmail.com
License: AGPLv3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/x-rst
License-File: COPYING
Requires-Dist: appdirs
Requires-Dist: colorama
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: pyyaml
Requires-Dist: scikit-image
Requires-Dist: scipy
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: tqdm
Requires-Dist: pywin32 ; platform_system == "Windows"
Provides-Extra: all
Requires-Dist: apex ; extra == 'all'
Requires-Dist: black (==22.10.0) ; extra == 'all'
Requires-Dist: jupyter[notebook] ; extra == 'all'
Requires-Dist: matplotlib ; extra == 'all'
Requires-Dist: myst-parser ; extra == 'all'
Requires-Dist: nbstripout ; extra == 'all'
Requires-Dist: pre-commit ; extra == 'all'
Requires-Dist: pypandoc (>=1.6.3) ; extra == 'all'
Requires-Dist: pytest (>=3.5.0) ; extra == 'all'
Requires-Dist: seaborn ; extra == 'all'
Requires-Dist: sphinx-argparse ; extra == 'all'
Requires-Dist: sphinx-autobuild ; extra == 'all'
Requires-Dist: sphinx (<5,>=3.5.4) ; extra == 'all'
Requires-Dist: sphinx-book-theme ; extra == 'all'
Requires-Dist: tensorboard ; extra == 'all'
Requires-Dist: torch-lr-finder (>=0.2.0) ; extra == 'all'
Requires-Dist: tqdm ; extra == 'all'
Provides-Extra: dev
Requires-Dist: black (==22.10.0) ; extra == 'dev'
Requires-Dist: nbstripout ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: myst-parser ; extra == 'docs'
Requires-Dist: pypandoc (>=1.6.3) ; extra == 'docs'
Requires-Dist: sphinx (<5,>=3.5.4) ; extra == 'docs'
Requires-Dist: sphinx-autobuild ; extra == 'docs'
Requires-Dist: sphinx-argparse ; extra == 'docs'
Requires-Dist: sphinx-book-theme ; extra == 'docs'
Provides-Extra: plots
Requires-Dist: jupyter[notebook] ; extra == 'plots'
Requires-Dist: matplotlib ; extra == 'plots'
Requires-Dist: seaborn ; extra == 'plots'
Requires-Dist: tqdm ; extra == 'plots'
Provides-Extra: test
Requires-Dist: pytest (>=3.5.0) ; extra == 'test'
Provides-Extra: train
Requires-Dist: apex ; extra == 'train'
Requires-Dist: seaborn ; extra == 'train'
Requires-Dist: tensorboard ; extra == 'train'
Requires-Dist: torch-lr-finder (>=0.2.0) ; extra == 'train'

echofilter
==========

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 <https://deepsenseca.github.io/echofilter/>`__.


Usage
-----

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

.. code:: bash

    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.

.. code:: bash

    echofilter -h


Installation
------------

The package can be installed using pip as follows:

.. code:: bash

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


.. _Echoview: https://www.echoview.com/


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/>.
