add offset function

Author: arch

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

@@ -24,6 +24,8 @@ Config Files:
 - `min_frames` (int): Specify the minimum required frames for the tracking. Wee need this parameter to ensure there is at leas two strokes in the tracking result.
 - `shift_top_points` (int): Shift predicted top points by given frame number. Positive values delay the position and negative values result in an earlier position.
 - `shift_bottom_points` (int): Shift predicted bottom points by given frame number. Positive values delay the position and negative values result in an earlier position.
+- `top_points_offset` (float): An fix offset to the top points (positive values move the point up and negative values move the point down). The offset respect the user defined upper and lower limit.
+- `bottom_points_offset` (float): An fix offset to the bottom points (positive values move the point up and negative values move the point down). The offset respect the user defined upper and lower limit.
 - `top_threshold` (float): Define the top threshold. All top points greater than `(max - threshold)` will be set to the specified max value. Set 0.0 to disable this function.
 - `bottom_threshold` (float): Define the bottom threshold. All bottom points lower than `(min + threshold)` will be set to the specified min value. Set 0.0 to disable this function.
 

funscript_editor/algorithms/funscriptgenerator.py

@@ -2,6 +2,7 @@
 
 import cv2
 import json
+import copy
 import time
 import logging
 
@@ -37,6 +38,8 @@ class FunscriptGeneratorParameter:
     use_zoom: bool = SETTINGS['use_zoom']
     shift_bottom_points :int = int(HYPERPARAMETER['shift_bottom_points'])
     shift_top_points :int = int(HYPERPARAMETER['shift_top_points'])
+    top_points_offset :float = float(HYPERPARAMETER['top_points_offset'])
+    bottom_points_offset :float = float(HYPERPARAMETER['bottom_points_offset'])
     use_equirectangular :bool = SETTINGS['use_equirectangular']
     equirectangular_scaling :float = max((0.2, float(SETTINGS['equirectangular_scaling'])))
     zoom_factor :float = max((1.0, float(SETTINGS['zoom_factor'])))
@@ -710,6 +713,28 @@ def apply_shift(self, frame_number, position: str) -> int:
 
         return self.params.start_frame + frame_number
 
+    def get_score_with_offset(self, idx_dict) -> list:
+        """ Apply the offsets form config file
+
+        Args:
+            idx_dict (dict): the idx dictionary with {'min':[], 'max':[]} idx lists
+
+        Returns:
+            list: score with offset
+        """
+        if self.params.direction == 'x':
+            return self.score_x
+
+        score = copy.deepcopy(self.score_y)
+        score_min, score_max = min(score), max(score)
+        for idx in idx_dict['min']:
+            score[idx] = max(( score_min, min((score_max, score[idx] + self.params.bottom_points_offset)) ))
+
+        for idx in idx_dict['max']:
+            score[idx] = max(( score_min, min((score_max, score[idx] + self.params.top_points_offset)) ))
+
+        return score
+
 
     def run(self) -> None:
         """ The Funscript Generator Thread Function """
@@ -739,7 +764,7 @@ def run(self) -> None:
             if self.params.direction != 'x':
                 self.plot_y_score('debug_002.png', idx_list)
 
-        output_score = self.score_y if self.params.direction != 'x' else self.score_x
+        output_score = self.get_score_with_offset(idx_dict)
         for idx in idx_dict['min']:
             self.funscript.add_action(
                     min(output_score) \

funscript_editor/config/hyperparameter.yaml

@@ -21,10 +21,18 @@ shift_top_points: 0
 # and negative values result in an earlier position.
 shift_bottom_points: 0
 
+# An fix offset to the top points (positive values move the point up and negative values
+# move the point down). The offset respect the user defined upper and lower limit.
+top_points_offset: 5.0
+
+# An fix offset to the bottom points (positive values move the point up and negative values
+# move the point down). The offset respect the user defined upper and lower limit.
+bottom_points_offset: -15.0
+
 # Define the top threshold. All top points greater than (max - threshold) will be set to
 # the specified max value. Set 0.0 to disable this function.
 top_threshold: 5.0
 
 # Define the bottom threshold. All bottom points lower than (min + threshold) will be set to
 # the specified min value. Set 0.0 to disable this function.
-bottom_threshold: 10.0
+bottom_threshold: 5.0