-
Notifications
You must be signed in to change notification settings - Fork 64
Open
Labels
documentationUpdates and improvements to documentation and examplesUpdates and improvements to documentation and examplesenhancementAddition of new features, or improved functionality of existing featuresAddition of new features, or improved functionality of existing features
Description
I'm working on some new tracking code (using lat/lon), and am working through differences between PBC tracking and lat/lon based tracking. Our documentation around adaptive search in tracking has always been somewhat vague, and even I didn't fully understand what was happening upstream. After digging into it some more, I want to make the following clear:
adaptive_stopshould be in the same units assearch_range, which we don't currently do the converison for.adaptive_stepshould probably be closer to 1 for most applications than what we're doing now, as it is whatsearch_rangeis multiplied by.
Suggested resolutions:
- Improve our documentation both in the API calls and with a new tracking parameter documentation page around these parameters
- Add a (or multiple) new parameters to tracking functions that allow for
adaptive_stopto be either set in the same units asd_maxorv_maxor as a multiple thereof (I would be inclined to pick one or the other, and I would lean toward picking the multiple).
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationUpdates and improvements to documentation and examplesUpdates and improvements to documentation and examplesenhancementAddition of new features, or improved functionality of existing featuresAddition of new features, or improved functionality of existing features