Simplify API #106
Merged
Simplify API #106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- removing point_transience argument - removing hit_inertia_min (set to 0) - create a pointwise_hit_counter_max argument - rename hit_inertia_max to hit_counter_max Also, change '_' to '-' in motmetics4norfair arguments
joaqo
suggested changes
Apr 27, 2022
| @@ -20,25 +22,29 @@ | |||
| help="Path to the MOT Challenge train dataset folder (test dataset doesn't provide labels)", | |||
| ) | |||
| parser.add_argument( | |||
| "--make_video", | |||
| "--make-video", | |||
| dest="make_video", | |||
There was a problem hiding this comment.
I don't think its necessary to add dest="make_video", this library automatically converts - to _ in the argument string.
| action="store_true", | ||
| help="Generate an output video, using the frames provided by the MOTChallenge dataset.", | ||
| ) | ||
| parser.add_argument( | ||
| "--save_pred", | ||
| "--save-pred", | ||
| dest="save_pred", |
| action="store_true", | ||
| help="Generate an output video, using the frames provided by the MOTChallenge dataset.", | ||
| ) | ||
| parser.add_argument( | ||
| "--save_pred", | ||
| "--save-pred", | ||
| dest="save_pred", |
| action="store_true", | ||
| help="Generate a text file with your predictions", | ||
| ) | ||
| parser.add_argument( | ||
| "--save_metrics", | ||
| "--save-metrics", | ||
| dest="save_metrics", |
| action="store_true", | ||
| help="Generate a text file with your predictions", | ||
| ) | ||
| parser.add_argument( | ||
| "--save_metrics", | ||
| "--save-metrics", | ||
| dest="save_metrics", |
| hit_inertia_min=10, | ||
| hit_inertia_max=12, | ||
| point_transience=4, | ||
| detection_threshold = detection_threshold, |
| - `initialization_delay (optional)`: Each tracked object waits till its internal hit intertia counter goes over `hit_inertia_min` to be considered as a potential object to be returned to the user by the Tracker. The argument `initialization_delay` determines by how much the object's hit inertia counter must exceed `hit_inertia_min` to be considered as initialized, and get returned to the user as a real object. If set to 0, objects will get returned to the user as soon as they exceed their `hit_inertia_min`, which can be problematic as this is also the threshold for object destruction, and can result in objects appearing and immediately dissapearing. Defaults to `(hit_inertia_max - hit_inertia_min) / 2`. | ||
| - `hit_counter_max (optional)`: Each tracked objects keeps an internal hit counter which tracks how often it's getting matched to a detection, each time it gets a match this counter goes up, and each time it doesn't it goes down. If it goes below 0 the object gets destroyed. This argument (`hit_counter_max`) defines how large this inertia can grow, and therefore defines how long an object can live without getting matched to any detections, before it is destroyed. Defaults to `15`. | ||
| - `initialization_delay (optional)`: The argument `initialization_delay` determines by how large the object's hit counter must be in order to be considered as initialized, and get returned to the user as a real object. If set to 0, objects will get returned to the user as soon as they are detected for the first time, which can be problematic as this can result in objects appearing and immediately dissapearing. Defaults to `hit_counter_max / 2`. | ||
| - `pointwise_hit_counter_max (optional)`: Each tracked object keeps track of how often the points it's tracking have been getting matched. Points that are getting matched (`pointwise_hit_counter > 0`) are said to be live, and points which aren't (`pointwise_hit_counter = 0`) are said to not be live. This is used to determine things like which individual points in a tracked object get drawn by [`draw_tracked_objects`](#draw_tracked_objects) and which don't. This argument (`pointwise_hit_counter_max`) defines how large the inertia for each point of a tracker can grow. Defaults to `5`. |
There was a problem hiding this comment.
Mention that it must be smaller than hit_counter_max as a point can't live longer than the object it belongs to. I think this will make how hit_counter_max and pointwise_hit_counter_max relate clearer.
| - `initialization_delay (optional)`: Each tracked object waits till its internal hit intertia counter goes over `hit_inertia_min` to be considered as a potential object to be returned to the user by the Tracker. The argument `initialization_delay` determines by how much the object's hit inertia counter must exceed `hit_inertia_min` to be considered as initialized, and get returned to the user as a real object. If set to 0, objects will get returned to the user as soon as they exceed their `hit_inertia_min`, which can be problematic as this is also the threshold for object destruction, and can result in objects appearing and immediately dissapearing. Defaults to `(hit_inertia_max - hit_inertia_min) / 2`. | ||
| - `hit_counter_max (optional)`: Each tracked objects keeps an internal hit counter which tracks how often it's getting matched to a detection, each time it gets a match this counter goes up, and each time it doesn't it goes down. If it goes below 0 the object gets destroyed. This argument (`hit_counter_max`) defines how large this inertia can grow, and therefore defines how long an object can live without getting matched to any detections, before it is destroyed. Defaults to `15`. | ||
| - `initialization_delay (optional)`: The argument `initialization_delay` determines by how large the object's hit counter must be in order to be considered as initialized, and get returned to the user as a real object. If set to 0, objects will get returned to the user as soon as they are detected for the first time, which can be problematic as this can result in objects appearing and immediately dissapearing. Defaults to `hit_counter_max / 2`. | ||
| - `pointwise_hit_counter_max (optional)`: Each tracked object keeps track of how often the points it's tracking have been getting matched. Points that are getting matched (`pointwise_hit_counter > 0`) are said to be live, and points which aren't (`pointwise_hit_counter = 0`) are said to not be live. This is used to determine things like which individual points in a tracked object get drawn by [`draw_tracked_objects`](#draw_tracked_objects) and which don't. This argument (`pointwise_hit_counter_max`) defines how large the inertia for each point of a tracker can grow. Defaults to `5`. |
There was a problem hiding this comment.
Mention that it must be smaller than hit_counter_max as a point can't live longer than the object it belongs to.
norfair/tracker.py
Outdated
| initialization_delay: Optional[int] = None, | ||
| pointwise_hit_counter_max: int = 5, |
There was a problem hiding this comment.
According to my math this should be actually 4 instead of 5, to be the closest to 15/4? Or is this not the correct calculation?
norfair/tracker.py
Outdated
| initialization_delay: Optional[int] = None, | ||
| pointwise_hit_counter_max: int = 5, |
There was a problem hiding this comment.
According to my math this should be actually 4 instead of 5, to be the closest as it was when we used point_transience?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
hit_inertia_min-> Removedhit_inertia_max->hit_counter_maxpoint_transience->pointwise_hit_counter_max