Pass 'removeUnusedMarkers/Attributes' flags to mmSolver command.

This feature will allow fully control the "remove unused objects"
feature, which is enabled when users want to calculate the
"Evaluate Object Relationships". For most tasks, this is not
needed to be enabled.

Issue #222

Author: david-cattermole

python/mmSolver/_api/solverbasic.py

@@ -303,6 +303,7 @@ def compile(self, col, mkr_list, attr_list, withtest=False):
         lineup_iter_num = self.get_lineup_iteration_num()
         use_euler_filter = self._use_euler_filter
         eval_object_relationships = self.get_eval_object_relationships()
+        remove_unused_objects = eval_object_relationships
         eval_complex_graphs = self.get_eval_complex_graphs()
         precomputed_data = self.get_precomputed_data()
 
@@ -334,6 +335,8 @@ def compile(self, col, mkr_list, attr_list, withtest=False):
             sol.set_auto_diff_type(const.AUTO_DIFF_TYPE_FORWARD)
             sol.set_use_smoothness(False)
             sol.set_use_stiffness(False)
+            sol.set_remove_unused_markers(remove_unused_objects)
+            sol.set_remove_unused_attributes(remove_unused_objects)
             sol.set_precomputed_data(precomputed_data)
             for action, vaction in sol.compile(col, mkr_list, attr_list,
                                                withtest=withtest):
@@ -357,6 +360,8 @@ def compile(self, col, mkr_list, attr_list, withtest=False):
                 sol.set_use_smoothness(not is_first_frame)
                 sol.set_use_stiffness(not is_first_frame)
                 sol.set_time_eval_mode(time_eval_mode)
+                sol.set_remove_unused_markers(remove_unused_objects)
+                sol.set_remove_unused_attributes(remove_unused_objects)
                 sol.set_precomputed_data(precomputed_data)
 
                 generator = api_compile.compile_solver_with_cache(

python/mmSolver/_api/solverstandard.py

@@ -46,6 +46,7 @@
     'lens_distortion',
 ]
 
+
 def _gen_two_frame_fwd(int_list):
     """
     Given a list of integers, create list of Frame pairs, moving
@@ -170,6 +171,7 @@ def _compile_multi_root_frames(col,
                                attr_list,
                                batch_frame_list,
                                root_iter_num,
+                               remove_unused_objects,
                                precomputed_data,
                                withtest,
                                verbose):
@@ -192,6 +194,11 @@ def _compile_multi_root_frames(col,
         Number of iterations to use, when solving root frames.
     :type root_iter_num: int
 
+    :param remove_unused_objects:
+        Should objects that are detected as 'unused' be removed from
+        the solver?
+    :type remove_unused_objects: bool
+
     :param withtest:
         Compile the test/validation Action, as well as the solve Action?
     :type withtest: bool
@@ -233,6 +240,8 @@ def _compile_multi_root_frames(col,
         sol.set_auto_diff_type(const.AUTO_DIFF_TYPE_FORWARD)
         sol.set_use_smoothness(False)
         sol.set_use_stiffness(False)
+        sol.set_remove_unused_markers(remove_unused_objects)
+        sol.set_remove_unused_attributes(remove_unused_objects)
         sol.set_precomputed_data(precomputed_data)
 
         cache = api_compile.create_compile_solver_cache()
@@ -317,6 +326,7 @@ def _compile_multi_inbetween_frames(col,
                                     global_solve,
                                     eval_complex_graphs,
                                     anim_iter_num,
+                                    remove_unused_objects,
                                     precomputed_data,
                                     withtest,
                                     verbose):
@@ -350,6 +360,11 @@ def _compile_multi_inbetween_frames(col,
         Number of iterations for solving animated attributes.
     :type anim_iter_num: int
 
+    :param remove_unused_objects:
+        Should objects that are detected as 'unused' be removed from
+        the solver?
+    :type remove_unused_objects: bool
+
     :param withtest:
         Should validation tests be generated?
     :type withtest: bool
@@ -373,6 +388,8 @@ def _compile_multi_inbetween_frames(col,
         sol.set_auto_diff_type(const.AUTO_DIFF_TYPE_FORWARD)
         sol.set_use_smoothness(False)
         sol.set_use_stiffness(False)
+        sol.set_remove_unused_markers(remove_unused_objects)
+        sol.set_remove_unused_attributes(remove_unused_objects)
         sol.set_precomputed_data(precomputed_data)
 
         cache = api_compile.create_compile_solver_cache()
@@ -397,6 +414,8 @@ def _compile_multi_inbetween_frames(col,
             sol.set_auto_diff_type(const.AUTO_DIFF_TYPE_FORWARD)
             sol.set_use_smoothness(not is_first_frame)
             sol.set_use_stiffness(not is_first_frame)
+            sol.set_remove_unused_markers(remove_unused_objects)
+            sol.set_remove_unused_attributes(remove_unused_objects)
             sol.set_time_eval_mode(time_eval_mode)
             sol.set_precomputed_data(precomputed_data)
 
@@ -422,6 +441,7 @@ def _compile_multi_frame(col,
                          root_frame_strategy,
                          triangulate_bundles,
                          use_euler_filter,
+                         remove_unused_objects,
                          precomputed_data,
                          withtest,
                          verbose):
@@ -492,6 +512,11 @@ def _compile_multi_frame(col,
         will remove "Euler Flipping".
     :type use_euler_filter: bool
 
+    :param remove_unused_objects:
+        Should objects that are detected as 'unused' be removed from
+        the solver?
+    :type remove_unused_objects: bool
+
     :param withtest:
         Should validation tests be generated?
     :type withtest: bool
@@ -559,6 +584,8 @@ def _compile_multi_frame(col,
             sol.set_auto_diff_type(const.AUTO_DIFF_TYPE_FORWARD)
             sol.set_use_smoothness(False)
             sol.set_use_stiffness(False)
+            sol.set_remove_unused_markers(remove_unused_objects)
+            sol.set_remove_unused_attributes(remove_unused_objects)
             sol.set_precomputed_data(precomputed_data)
 
             cache = api_compile.create_compile_solver_cache()
@@ -596,6 +623,8 @@ def _compile_multi_frame(col,
         sol.set_auto_diff_type(const.AUTO_DIFF_TYPE_FORWARD)
         sol.set_use_smoothness(False)
         sol.set_use_stiffness(False)
+        sol.set_remove_unused_markers(remove_unused_objects)
+        sol.set_remove_unused_attributes(remove_unused_objects)
         sol.set_precomputed_data(precomputed_data)
 
         cache = api_compile.create_compile_solver_cache()
@@ -641,6 +670,7 @@ def _compile_multi_frame(col,
             batch_frame_list,
             root_iter_num,
             precomputed_data,
+            remove_unused_objects,
             withtest,
             verbose
         )
@@ -680,6 +710,7 @@ def _compile_multi_frame(col,
         global_solve,
         eval_complex_graphs,
         anim_iter_num,
+        remove_unused_objects,
         precomputed_data,
         withtest,
         verbose,
@@ -697,6 +728,7 @@ def _compile_single_frame(col,
                           lineup_iter_num,
                           auto_attr_blocks,
                           precomputed_data,
+                          remove_unused_objects,
                           withtest,
                           verbose):
     """
@@ -727,6 +759,11 @@ def _compile_single_frame(col,
         pass
     :type lineup_iter_num: int
 
+    :param remove_unused_objects:
+        Should objects that are detected as 'unused' be removed from
+        the solver?
+    :type remove_unused_objects: bool
+
     :param withtest:
         Should validation tests be generated?
     :type withtest: bool
@@ -754,6 +791,8 @@ def _compile_single_frame(col,
             sol.set_auto_diff_type(const.AUTO_DIFF_TYPE_FORWARD)
             sol.set_use_smoothness(False)
             sol.set_use_stiffness(False)
+            sol.set_remove_unused_markers(remove_unused_objects)
+            sol.set_remove_unused_attributes(remove_unused_objects)
             sol.set_precomputed_data(precomputed_data)
 
             cache = api_compile.create_compile_solver_cache()
@@ -771,6 +810,8 @@ def _compile_single_frame(col,
     sol.set_auto_diff_type(const.AUTO_DIFF_TYPE_FORWARD)
     sol.set_use_smoothness(False)
     sol.set_use_stiffness(False)
+    sol.set_remove_unused_markers(remove_unused_objects)
+    sol.set_remove_unused_attributes(remove_unused_objects)
     sol.set_precomputed_data(precomputed_data)
 
     cache = api_compile.create_compile_solver_cache()
@@ -1278,6 +1319,7 @@ def compile(self, col, mkr_list, attr_list, withtest=False):
         only_root_frames = self.get_only_root_frames()
         global_solve = self.get_global_solve()
         eval_object_relationships = self.get_eval_object_relationships()
+        remove_unused_objects = eval_object_relationships
         eval_complex_graphs = self.get_eval_complex_graphs()
         block_iter_num = self.get_block_iteration_num()
         root_iter_num = self.get_root_iteration_num()
@@ -1294,8 +1336,9 @@ def compile(self, col, mkr_list, attr_list, withtest=False):
         verbose = True
         precomputed_data = self.get_precomputed_data()
 
+        LOG.warn('eval_object_relationships=%r', eval_object_relationships)
+
         # Pre-calculate the 'affects' relationship.
-        # LOG.warn('eval_object_relationships: %r', eval_object_relationships)
         if eval_object_relationships is True:
             generator = solverutils.compile_solver_affects(
                 col,
@@ -1322,6 +1365,7 @@ def compile(self, col, mkr_list, attr_list, withtest=False):
                 block_iter_num,
                 lineup_iter_num,
                 auto_attr_blocks,
+                remove_unused_objects,
                 precomputed_data,
                 withtest,
                 verbose,
@@ -1345,6 +1389,7 @@ def compile(self, col, mkr_list, attr_list, withtest=False):
                 root_frame_strategy,
                 triangulate_bundles,
                 use_euler_filter,
+                remove_unused_objects,
                 precomputed_data,
                 withtest,
                 verbose,

python/mmSolver/_api/solverstep.py

@@ -287,6 +287,22 @@ def set_use_stiffness(self, value):
 
     ############################################################################
 
+    def get_remove_unused_markers(self):
+        return self._data.get('remove_unused_markers')
+
+    def set_remove_unused_markers(self, value):
+        assert isinstance(value, (bool, int))
+        self._data['remove_unused_markers'] = bool(value)
+
+    def get_remove_unused_attributes(self):
+        return self._data.get('remove_unused_attributes')
+
+    def set_remove_unused_attributes(self, value):
+        assert isinstance(value, (bool, int))
+        self._data['remove_unused_attributes'] = bool(value)
+
+    ############################################################################
+
     def get_attributes_use_animated(self):
         return self._attributes_use.get('animated')
 
@@ -546,6 +562,9 @@ def compile(self, col, mkr_list, attr_list, withtest=False):
         kwargs['robustLossScale'] = 1.0
         kwargs['timeEvalMode'] = self.get_time_eval_mode()
 
+        kwargs['removeUnusedMarkers'] = self.get_remove_unused_markers()
+        kwargs['removeUnusedAttributes'] = self.get_remove_unused_attributes()
+
         # TODO: Add 'robustLossType' flag.
         # TODO: Add 'robustLossScale' flag.
         # TODO: Add 'autoParamScaling' flag.

python/mmSolver/_api/solverutils.py

@@ -34,6 +34,12 @@
 def compile_solver_affects(col, mkr_list, attr_list,
                            precomputed_data,
                            withtest):
+    # Reset the used hints to 'unknown' before setting 'used' or
+    # 'unused' flags.
+    generator = compile_reset_used_hints(col, mkr_list, attr_list)
+    for action, vaction in generator:
+        yield action, vaction
+
     sol = solveraffects.SolverAffects()
     sol.set_precomputed_data(precomputed_data)