Skip to content

Reorganize and potentially rename the clean package #1545

Description

@leewujung

The clean package has a mixture of locations of the noise removal functions: Some existing functions sit entirely within api.py and some in a separate .py file. The newly added transient noise functions (fieldings and matecho algorithms) are in a different submodule transient_noise and call by a dispatcher in api.py. Since there are multiple type noises and for each type there are multiple algorithms, we should reorganize where things sit and how they are imported.

I like the dispatcher approach @LOCEANlloydizard implemented since it is easy to follow, and the parallel with other functionalities like seafloor and shoal detection. Perhaps we can follow that to organize all noise removal functions.

Another consideration is to rename the subpackage. I am not super happy with the clean naming. Should we go with the more standard remove_noise? Am trying to use a verb here since all other subpackages are verbs.

@LOCEANlloydizard @ctuguinay : Thoughts?

This is related to #1544.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

enhancementThis makes echopype better

Type

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions