QutEcoacoustics / audio-analysis

The audio analysis code (AnalysisPrograms.exe) for the QUT Ecoacoustics Research Group
https://ap.qut.ecoacoustics.info/
Apache License 2.0
52 stars 12 forks source link

Inconsistent generic recogniser APIs #461

Open atruskie opened 3 years ago

atruskie commented 3 years ago

Is your feature request related to a problem? Please describe.

The various generic recogniser APIs have some inconsistent parameters. We should clean these up.

Describe the solution you'd like

All the following APIs were identified by looking at references: most are only referenced in tests and not actually used or are duplicates of the newer PostProcessing stage. None of the following are hard requirements - if any of these are wrong, then strike them out. Seeking feedback.

(1) Actually used by algorithm, though still duplicates of PostProcessing parameters

... more to come...

For all renames: keep previous YamlTypeTag attribute for backwards combability. e.g.

+[YamlTypeTag(typeof(WhistleParameters))]
[YamlTypeTag(typeof(OnebinTrackParameters))]
+public class WhistleParameters: CommonParameters
-public class OnebinTrackParameters : CommonParameters
{
}