update docs, add desc for multiaxis

Author: arch

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

@@ -13,6 +13,6 @@ Config Files:
 - `logging_windows.yaml`: the logging configuration for windows
 - `settings.yaml`: application settings
 - `ui.yaml`: user interface settings
-- `projection.yaml`: the FFmpeg filter parameter for different video types
+- `projection.yaml`: the FFmpeg filter parameter for different video types. You can change the keys for the zooming, rotation, ... for each video projection configuration.
 
 All available config parameter are described with an comment inside the config file.

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

@@ -2,9 +2,9 @@
 
 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!
 
-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.
+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. The page describes the MTFG as part of the OFS extension.
 
-## Process
+## Process Overview
 
 1. Select the Region of Interest in the Video where the action happens.
 2. Select an features for the Woman and Men in the video, which should be tracked.
@@ -15,9 +15,22 @@ First of all I want to mention that this application is not a fully automated so
 7. Finally set the desired post processing parameter.
 8. The Lua Extension automatically import the result to OpenFunscripter.
 
+## Settings
+
+All relevant settings can be set in the settings dialog before the tracking starts. Below a short description or each settings option:
+
+- Video Type: Select the type of your video format.
+- Tracking Metric: Select the metric for the movement detection.
+- Tracking Method: Select the desired tracking method. Available methods depend on the selected `Tracking Metric` setting.
+- 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.
+- 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.
+- Output:
+  - `normalized raw tracking data`: Output the raw tracking data to OFS. This option is for experts that want to post process the tracking data with own lua scripts inside OFS.
+  - `post processing data`: Enable an additional window to adjust, simplify, filter and tune the raw tracking after the tracking has finished.
+
 ## Options
 
-## Unsupervised vs. Supervised Tracking
+### Unsupervised vs. Supervised Tracking
 
 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.
 
@@ -26,14 +39,8 @@ The supervised tracking expand this function by an user input of an search area.
 In short: The Supervised options track a feature inside a specified area. It asks for pair of parameters: first the small area containing the feature to track, then a larger bounding area that must contain the feature area at every moment. If you use more than 1 tracker then it goes `(feature1, bounding area1)`, `(feature2, bounding area2)` etc.
 You can then specify blocking/non blocking: the first means that when the feature "escape" the bounding box the process stop, the second option keeps going and if the feature gets back into that bounding box it continues tracking the movement.
 
-## Settings
-
-All important settings can be set in the settings dialog before the tracking starts.
+### Multiaxis Tracking
 
-Description:
+Multiaxis funscripts are basically one funscript for each axis of movement or rotation. Available axis depends on the used device. The MTFG support the output of `heave (suck) = y`, `sway = x` and `roll`. When you enable the multiaxis support in the OFS MTFG Extension Widget you can assign the tracking metric to the desired funscript via drop down menu. Use the option `ignore` if you don't need the corresponding movement/rotation for your funscripts. The widget show all opened funscripts from OFS. To add a new funscript axis in OFS you can use `Project : Add ... : Shortcust` menu from the OFS app bar. E.g. set `roll = *.roll`, `x = *.sway` and `y = *.suck`. With this settings you probably want to select the Tracking Metric `x + y + roll` in the MTFG settings dialog because the Extension can only import available tracking data. The setting in the OFS widget window is only the binding for the MTFG output. So the extension only import available data from MTFG. When you chose e.g. only the Tracking Metric `y (up-down)` you get only the resulting movement for `y` in OFS no matter what you set for the binding in OFS widget.
 
-- Video Type: Select the type of your video format.
-- Tracking Metric: Select the metric for the movement detection.
-- Tracking Method: Select the desired tracking method. Available methods depend on the selected `Tracking Metric` setting.
-- 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.
-- 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.
+In Multiaxis tracking the Tracking Metric `distance` is not available because this metric already combines the `x` and `y` movement to an euclidean distance in 2D space.