From fc623b3097e0b437ea67b9c04271a1463fb4a111 Mon Sep 17 00:00:00 2001 From: Blake Blackshear Date: Sun, 28 Jan 2024 20:09:08 -0600 Subject: [PATCH] move false positive guide to config folder --- .../object_filters.md} | 10 +++++++--- docs/sidebars.js | 2 +- 2 files changed, 8 insertions(+), 4 deletions(-) rename docs/docs/{guides/false_positives.md => configuration/object_filters.md} (95%) diff --git a/docs/docs/guides/false_positives.md b/docs/docs/configuration/object_filters.md similarity index 95% rename from docs/docs/guides/false_positives.md rename to docs/docs/configuration/object_filters.md index bd095c9eb..5ffb205d0 100644 --- a/docs/docs/guides/false_positives.md +++ b/docs/docs/configuration/object_filters.md @@ -1,8 +1,10 @@ --- -id: false_positives -title: Reducing false positives +id: object_filters +title: Filters --- +There are several types of object filters that can be used to reduce false positive rates. + ## Object Scores For object filters in your configuration, any single detection below `min_score` will be ignored as a false positive. `threshold` is based on the median of the history of scores (padded to 3 values) for a tracked object. Consider the following frames when `min_score` is set to 0.6 and threshold is set to 0.85: @@ -18,6 +20,8 @@ For object filters in your configuration, any single detection below `min_score` In frame 2, the score is below the `min_score` value, so Frigate ignores it and it becomes a 0.0. The computed score is the median of the score history (padding to at least 3 values), and only when that computed score crosses the `threshold` is the object marked as a true positive. That happens in frame 4 in the example. +show image of snapshot vs event with differing scores + ### Minimum Score Any detection below `min_score` will be immediately thrown out and never tracked because it is considered a false positive. If `min_score` is too low then false positives may be detected and tracked which can confuse the object tracker and may lead to wasted resources. If `min_score` is too high then lower scoring true positives like objects that are further away or partially occluded may be thrown out which can also confuse the tracker and cause valid events to be lost or disjointed. @@ -36,7 +40,7 @@ False positives can also be reduced by filtering a detection based on its shape. ### Object Proportions -`min_ratio` and `max_ratio` values are compared against a given detected object's width/height ratio (in pixels). If the ratio is outside this range, the object will be ignored as a false positive. This allows objects that are proportionally too short-and-wide (higher ratio) or too tall-and-narrow (smaller ratio) to be ignored. +`min_ratio` and `max_ratio` values are compared against a given detected object's width/height ratio (in pixels). If the ratio is outside this range, the object will be ignored as a false positive. This allows objects that are proportionally too short-and-wide (higher ratio) or too tall-and-narrow (smaller ratio) to be ignored. :::info diff --git a/docs/sidebars.js b/docs/sidebars.js index 408b7042c..2a9fe7d0b 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -11,7 +11,6 @@ module.exports = { Guides: [ "guides/getting_started", "guides/configuring_go2rtc", - "guides/false_positives", "guides/ha_notifications", "guides/ha_network_storage", "guides/stationary_objects", @@ -43,6 +42,7 @@ module.exports = { "configuration/camera_specific", ], Objects: [ + "configuration/object_filters", "configuration/masks", "configuration/zones", "configuration/objects",