Skip to content

Commit df0ea40

Browse files
author
arch
committed
update doc
1 parent 228d0b6 commit df0ea40

File tree

1 file changed

+1
-34
lines changed

1 file changed

+1
-34
lines changed

docs/app/docs/user-guide/config.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,37 +15,4 @@ Config Files:
1515
- `ui.yaml`: user interface settings
1616
- `projection.yaml`: the FFmpeg filter parameter for different video types
1717

18-
### Config Parameter
19-
20-
#### `settings.yaml`
21-
22-
- `use_zoom` (bool): Enable or disable an additional step to zoom in the Video before selecting a tracking feature for the Woman or Men.
23-
- `zoom_factor:` (float): Set the desired zoom value which will be used when the zoom function is activated.
24-
- `max_playback_fps` (int): Limit the max player speed in the tracking preview window (0 = disable limit)
25-
- `preview_scaling` (float): Set the preview image scaling factor. With a value of `1.0`, the window should fill the height or width of the screen depending on the aspect ratio of the video.
26-
- `tracker`: (str) Specify the tracker algorithm. Available options are `'MIL'`, `'KCF'`, `'CSRT'`.
27-
- `notification_sound` (str) Specify the `wav` file to play when tracking finished (write 'off' to disable the sound notification).
28-
- `tracking_lost_time` (int) Time in milliseconds at which the tracking is stopped if the selected feature is not found.
29-
- `scene_detector` (str): Specify the scene detector algorithm. Available options: `'CSV'`, `'CONTENT'`, `'THRESHOLD'`
30-
- `raw_output` (bool): Output an position for each frame. This option disable post processing!
31-
- `additional_changepoints` (bool): Insert change points at high second derivative
32-
33-
#### `hyperparameter.yaml`
34-
35-
- `skip_frames` (int): This parameter specifies how many frames are skipped and interpolated during tracking. Increase this parameter to improve the processing speed on slow hardware. But higher values result in poorer predictions!
36-
- `avg_sec_for_local_min_max_extraction` (float): Specify the window size for the calculation of the reference value for the local min and max search.
37-
- `local_max_delta_in_percent` (float): Specify the maximum deviation for a max point in percent (recommend range: `0.0 - 10.0`)
38-
- `local_min_delta_in_percent` (float): Specify the maximum deviation for a min point in percent (recommend range: `0.0 - 10.0`)
39-
- `min_frames` (int): Specify the minimum required frames for the tracking. Wee need this parameter to ensure there is at leas two strokes in the tracking result.
40-
- `changepoint_detection_threshold` (float): threshold value tor get additional change points by comparing second derivative with the rolling standard deviation and given threshold
41-
- `additional_changepoints_merge_threshold_in_ms` (int): threshold value in milliseconds to merge additional change points
42-
- `user_reaction_time_in_milliseconds` (int): reaction time of the user to stop the tracking when scene changed or tracking box shifts
43-
- `shift_top_points` (int): Shift predicted top points by given frame number. Positive values delay the position and negative values result in an earlier position.
44-
- `shift_bottom_points` (int): Shift predicted bottom points by given frame number. Positive values delay the position and negative values result in an earlier position.
45-
- `top_points_offset` (float): An fix offset to the top points (positive values move the point up and negative values move the point down). The offset respect the user defined upper and lower limit.
46-
- `bottom_points_offset` (float): An fix offset to the bottom points (positive values move the point up and negative values move the point down). The offset respect the user defined upper and lower limit.
47-
- `top_threshold` (float): Define the top threshold. All top points greater than `(max - threshold)` will be set to the specified max value. Set 0.0 to disable this function.
48-
- `bottom_threshold` (float): Define the bottom threshold. All bottom points lower than `(min + threshold)` will be set to the specified min value. Set 0.0 to disable this function.
49-
- `min_scene_len` (int): Specify the minimum scene length in seconds for the scene detector
50-
- `scene_content_detector_threshold` (float): Threshold value for the content detector to detect an scene change
51-
- `scene_threshold_detector_threshold` (int): Threshold value for the threshold detector to detect an scene change
18+
All available config parameter are described with an comment inside the config file.

0 commit comments

Comments
 (0)