Skip to content

Commit 0f8c3ca

Browse files
author
arch
committed
add settings description
1 parent 32ce9b0 commit 0f8c3ca

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

docs/app/docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ Simple Funscript Editor written in Python with an motion tracking add-on to part
88
- [Build Application from Source](user-guide/build.md)
99
- [Application Config](user-guide/config.md)
1010
- [OFS Integration (Installation)](user-guide/ofs-integration.md)
11-
- [Usage](user-guide/usage.md)
11+
- [Usage and Settings](user-guide/usage.md)
1212
- [Build in UI](user-guide/ui.md)

docs/app/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ Simple Funscript Editor written in Python with an motion tracking add-on to part
88
- [Build Application from Source](user-guide/build.html)
99
- [Application Config](user-guide/config.html)
1010
- [OFS Integration (Installation)](user-guide/ofs-integration.html)
11-
- [Usage](user-guide/usage.html)
11+
- [Usage and Settings](user-guide/usage.html)
1212
- [Build in UI](user-guide/ui.html)

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,15 @@ The supervised tracking expand this function by an user input of an search area.
2626
![Settings Dialog](./images/settings_dialog.png)
2727

2828
All important settings can be set in the settings dialog before the tracking starts.
29+
30+
Description:
31+
32+
- Video Type: Select the type of your video format.
33+
- Tracking Metric: Select the metric for the movement detection.
34+
- Tracking Method: Select the desired tracking method. Available methods depend on the selected `Tracking Metric` setting.
35+
- Processing Speed: Select the processing speed. This option set the skip frames factor. For an higher processing speed we track only every `n % skip_frame == 0` frame and interpolate the skipped frames. Recommend settings is `1 (normal)` for 60 FPS Videos (and above) and `0 (accurate)` for Videos with 30 FPS or less.
36+
- Number of Tracker: Select the number of trackers per target. We use the average of all tracker for the output. Using a higher number of Tracker should increase the accuracy. For most video scenes i recommend to use only `1` tracker because the accuracy increases only slightly but the processing speed is significantly higher.
37+
- Points: Select the algorithm to determine the predicted points from the tracking signal.
38+
- Additional Points: Select an algorithm to add additional points to the output.
39+
- Top Points Offset: Add an given offset to all predicted top points. Recommend is an value between `10` and `25`.
40+
- Bottom Points Offset: Add an given offset to all predicted bottom points. Recommend is an value between `-10` and `-25`.

0 commit comments

Comments
 (0)