Skip to content

Commit 8c3fea8

Browse files
author
arch
committed
update docs
1 parent 328dced commit 8c3fea8

File tree

3 files changed

+28
-2
lines changed

3 files changed

+28
-2
lines changed

docs/app/docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ A Python program that use Computer Vision to predict the funscript actions. Most
99
- [Algorithms](user-guide/algorithms.md)
1010
- [Build Application from Source](user-guide/build.md)
1111
- [Application Config](user-guide/config.md)
12-
- [OFS Integration](user-guide/ofs-integration.md)
12+
- [OFS Integration (Installation)](user-guide/ofs-integration.md)
13+
- [Usage](user-guide/usage.md)
1314
- [Build in UI](user-guide/ui.md)

docs/app/docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ A Python program that use Computer Vision to predict the funscript actions for s
77
- [Algorithms](user-guide/algorithms.html)
88
- [Build Application from Source](user-guide/build.html)
99
- [Application Config](user-guide/config.html)
10-
- [OFS Integration](user-guide/ofs-integration.html)
10+
- [OFS Integration (Installation)](user-guide/ofs-integration.html)
11+
- [Usage](user-guide/usage.html)
1112
- [Build in UI](user-guide/ui.html)

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Usage
2+
3+
I recommend to setup the application as an [OpenFunscripter Extension](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs/user-guide/ofs-integration.md).
4+
5+
If you want to use this extension for OFS I assume that you already know the basic scripting procedures. If this is not the case, please learn first the basic functions how to create a funscript in OFS!
6+
7+
First of all I want to mention that this extension is not a fully automated solution, it's just an extension that helps you scripting **static camera scenes**.
8+
9+
## Process
10+
11+
1. Select the Region of Interest in the Video where the action happens.
12+
2. Select an features for the Woman and Men in the video, which should be tracked.
13+
3. The application try to track the selected feature in the following video frames.
14+
4. When the user stop the Tracking or the application can not find the selected feature in the next video frame the application calculate the difference between the predicted tracking boxes for each frame.
15+
5. The user set the minimum and maximum position for the tracked video sequence.
16+
6. The Application determine all local min and max points of the movement of the tracker and insert them in OpenFunscripter.
17+
18+
## Options
19+
20+
## Unsupervised vs. Supervised Tracking
21+
22+
The Unsupervised Tracking simply track the selected feature in the video until the feature is not visible anymore or the user stop the tracking process.
23+
24+
The supervised tracking expand this function by an user input of an search area. As soon as the predicted tracking box leaves this area the tracking stops. You have to define the region where you expect the selected features in the future video frames for each tracked feature when you select the supervised tracking option. The supervised tracking process increases the quality of the generated funscript actions due to the additional abort condition.

0 commit comments

Comments
 (0)