Skip to content

Commit 32ce9b0

Browse files
author
arch
committed
update docs
1 parent c063364 commit 32ce9b0

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed
44.1 KB
Loading

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# Usage
22

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).
3+
If you want to use this application, 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!
44

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**.
5+
First of all I want to mention that this application is not a fully automated solution, it's just an extension that helps you scripting **static camera scenes** much faster.
86

97
## Process
108

@@ -21,4 +19,10 @@ First of all I want to mention that this extension is not a fully automated solu
2119

2220
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.
2321

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.
22+
The supervised tracking expand this function by an user input of an search area. As soon as the predicted tracking box leaves this area, we can trigger an event. This event can currently represent either an abort condition for the tracking or an ignore condition. Therefore 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. When you use the supervised tracking process as abort condition it will increases the quality of the generated funscript actions due to the additional quality check. With the ignore condition we ignore all tracking prediction outside the specified area and use the last valid tracking position inside the specified area until the tracking insert the defined supervised tracking area again. This method is useful to script actions where the actor not always have contact.
23+
24+
## Settings
25+
26+
![Settings Dialog](./images/settings_dialog.png)
27+
28+
All important settings can be set in the settings dialog before the tracking starts.

0 commit comments

Comments
 (0)