refactor config

Author: arch

funscript_editor/algorithms/funscriptgenerator.py

@@ -49,7 +49,7 @@ class FunscriptGeneratorParameter:
     # General
     skip_frames: int = max((0, int(HYPERPARAMETER['skip_frames'])))
 
-    # y-Movement
+    # y VR Movement
     shift_bottom_points: int = int(HYPERPARAMETER['shift_bottom_points'])
     shift_top_points: int = int(HYPERPARAMETER['shift_top_points'])
     bottom_points_offset: float = float(HYPERPARAMETER['bottom_points_offset'])
@@ -58,12 +58,12 @@ class FunscriptGeneratorParameter:
     top_threshold: float = float(HYPERPARAMETER['top_threshold'])
 
     # x-Movement
-    shift_left_points: int = int(HYPERPARAMETER['shift_left_points'])
-    shift_right_points: int = int(HYPERPARAMETER['shift_right_points'])
-    left_points_offset: float = float(HYPERPARAMETER['left_points_offset'])
-    right_points_offset: float = float(HYPERPARAMETER['right_points_offset'])
-    left_threshold: float = float(HYPERPARAMETER['left_threshold'])
-    right_threshold: float = float(HYPERPARAMETER['right_threshold'])
+    shift_min_points: int = int(HYPERPARAMETER['shift_min_points'])
+    shift_max_points: int = int(HYPERPARAMETER['shift_max_points'])
+    min_points_offset: float = float(HYPERPARAMETER['min_points_offset'])
+    max_points_offset: float = float(HYPERPARAMETER['max_points_offset'])
+    min_threshold: float = float(HYPERPARAMETER['min_threshold'])
+    max_threshold: float = float(HYPERPARAMETER['max_threshold'])
 
 
 class FunscriptGeneratorThread(QtCore.QThread):
@@ -331,7 +331,7 @@ def calculate_score(self) -> None:
                     # this should never happen
                     self.logger.error('Calculate score not implement for x=%d, y=%d', x, y)
 
-            # invert
+            # invert because math angle is ccw
             self.score['pitch'] = [-1.0*item for item in self.score['pitch']]
 
 
@@ -799,8 +799,8 @@ def apply_shift(self, frame_number: int, metric: str, position: str) -> int:
         Returns:
             int: real frame position
         """
-        shift_max = self.params.shift_top_points if metric == 'y' else self.params.shift_right_points
-        shift_min = self.params.shift_bottom_points if metric == 'y' else self.params.shift_left_points
+        shift_max = self.params.shift_top_points if metric == 'y' else self.params.shift_max_points
+        shift_min = self.params.shift_bottom_points if metric == 'y' else self.params.shift_min_points
 
         if position in ['max'] :
             if frame_number >= -1*shift_max \
@@ -825,8 +825,8 @@ def get_score_with_offset(self, idx_dict: dict, metric: str) -> list:
         Returns:
             list: score with offset
         """
-        offset_max = self.params.top_points_offset if metric == 'y' else self.params.right_points_offset
-        offset_min = self.params.bottom_points_offset if metric == 'y' else self.params.left_points_offset
+        offset_max = self.params.top_points_offset if metric == 'y' else self.params.max_points_offset
+        offset_min = self.params.bottom_points_offset if metric == 'y' else self.params.min_points_offset
 
         score = copy.deepcopy(self.score[metric])
         score_min, score_max = min(score), max(score)
@@ -895,8 +895,8 @@ def create_funscript(self, idx_dict: dict) -> None:
         else:
             output_score = self.get_score_with_offset(idx_dict, self.params.metric)
 
-            threshold_min = self.params.bottom_threshold if self.params.metric == 'y' else self.params.left_threshold
-            threshold_max = self.params.top_threshold if self.params.metric == 'y' else self.params.right_threshold
+            threshold_min = self.params.bottom_threshold if self.params.metric == 'y' else self.params.min_threshold
+            threshold_max = self.params.top_threshold if self.params.metric == 'y' else self.params.max_threshold
 
             for idx in idx_dict['min']:
                 self.funscript.add_action(

funscript_editor/config/hyperparameter.yaml

@@ -24,9 +24,9 @@ local_min_delta_in_percent: 0.25
 min_frames: 100
 
 
-##############
-# y-Movement #
-##############
+##############################
+# VR Movement in y Direction #
+##############################
 
 # Shift predicted top points by given frame number. Positive values delay the position
 # and negative values result in an earlier position.
@@ -53,30 +53,30 @@ top_threshold: 2.5
 bottom_threshold: 2.5
 
 
-##############
-# x-Movement #
-##############
+#################################
+# All other predicted Movements #
+#################################
 
-# Shift predicted left points by given frame number. Positive values delay the position
+# Shift predicted min points by given frame number. Positive values delay the position
 # and negative values result in an earlier position.
-shift_left_points: 0
+shift_min_points: 0
 
-# Shift predicted right points by given frame number. Positive values delay the position
+# Shift predicted max points by given frame number. Positive values delay the position
 # and negative values result in an earlier position.
-shift_right_points: 0
+shift_max_points: 0
 
-# An fix offset to the left points (positive values move the point right and negative values
-# move the point left). The offset respect the user defined upper and lower limit.
-left_points_offset: -7.5
+# An fix offset to the min points (positive values increase position and negative values
+# lower the points). The offset respect the user defined upper and lower limit.
+min_points_offset: -7.5
 
-# An fix offset to the right points (positive values move the point right and negative values
-# move the point left). The offset respect the user defined upper and lower limit.
-right_points_offset: 7.5
+# An fix offset to the max points (positive values increase the position and negative values
+# lower the points). The offset respect the user defined upper and lower limit.
+max_points_offset: 7.5
 
-# Define the left threshold. All left points lower than (min + threshold) will be set to
+# Define the min threshold. All min points lower than (min + threshold) will be set to
 # the specified min value. Set 0.0 to disable this function.
-left_threshold: 2.5
+min_threshold: 2.5
 
-# Define the right threshold. All right points greater than (max - threshold) will be set to
+# Define the max threshold. All right points greater than (max - threshold) will be set to
 # the specified max value. Set 0.0 to disable this function.
-right_threshold: 2.5
+max_threshold: 2.5

funscript_editor/ui/settings_dialog.py

@@ -43,7 +43,7 @@ def __setup_ui_bindings(self):
 
     def __setup_combo_boxes(self):
         self.ui.videoTypeComboBox.addItems([PROJECTION[key]['name'] for key in PROJECTION.keys()])
-        self.ui.trackingMetricComboBox.addItems(['y', 'x', 'euclideanDistance'])
+        self.ui.trackingMetricComboBox.addItems(['y', 'x', 'euclideanDistance', 'pitch'])
         self.ui.trackingMethodComboBox.addItems(['Woman', 'Woman + Men'])
 
     def __set_tracking_metric(self, value):