From 0996883a98346747f113376d969ab0d1e11e140c Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Fri, 16 Jun 2023 18:00:49 -0600 Subject: [PATCH] Add docs for annotation offset (#6824) --- docs/docs/configuration/index.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index b66ff15f5..4d8cc4f17 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -225,6 +225,20 @@ detect: # Optional: Object specific values objects: person: 1000 + # Optional: Milliseconds to offset detect annotations by (default: shown below). + # There can often be latency between a recording and the detect process, + # especially when using separate streams for detect and record. + # Use this setting to make the timeline bounding boxes more closely align + # with the recording. The value can be positive or negative. + # TIP: Imagine there is an event clip with a person walking from left to right. + # If the event timeline bounding box is consistently to the left of the person + # then the value should be decreased. Similarly, if a person is walking from + # left to right and the bounding box is consistently ahead of the person + # then the value should be increased. + # TIP: This offset is dynamic so you can change the value and it will update existing + # events, this makes it easy to tune. + # WARNING: Fast moving objects will likely not have the bounding box align. + annotation_offset: 0 # Optional: Object configuration # NOTE: Can be overridden at the camera level