Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent generic recogniser APIs #461

Open
12 tasks
atruskie opened this issue Mar 4, 2021 · 0 comments
Open
12 tasks

Inconsistent generic recogniser APIs #461

atruskie opened this issue Mar 4, 2021 · 0 comments
Assignees

Comments

@atruskie
Copy link
Member

atruskie commented Mar 4, 2021

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.

  • Remove: UpwardTrackParameters.CombineProximalSimilarEvents
  • Remove: UpwardTrackParameters.SyllableStartDifference
  • Remove: UpwardTrackParameters.SyllableHertzDifference
  • Remove: ForwardTrackParameters.CombinePossibleSyllableSequence
  • Remove: OnebinTrackParameters.CombinePossibleSyllableSequence
  • Rename: OnebinTrackParameters (to HorizontalTrackParameters? WhistleParameters? Add an alias for both?)
  • Rename: UpwardTrackParameters (to SlopingTrackParameters? WhipParameters? Add an alias for both?)
  • Rename/Alias: VerticalTrackParameters (to Click?)
  • Remove: UpwardTrackParameters.CombineProximalSimilarEvents¹
  • Remove: UpwardTrackParameters.SyllableStartDifference¹
  • Remove: UpwardTrackParameters.SyllableHertzDifference¹
  • Remove: OneframeTrackParameters.CombineProximalSimilarEvents (currently commented out)

(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
{
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants