provide an option to the user for the SSSIG threshold

Author: dicengine

src/base/DICe.h

@@ -177,6 +177,8 @@ const char* const max_solver_iterations_robust = "max_solver_iterations_robust";
 /// String parameter name
 const char* const robust_solver_tolerance = "robust_solver_tolerance";
 /// String parameter name
+const char* const sssig_threshold = "sssig_threshold";
+/// String parameter name
 const char* const initial_gamma_threshold = "initial_gamma_threshold";
 /// String parameter name
 const char* const final_gamma_threshold = "final_gamma_threshold";
@@ -996,6 +998,8 @@ const Correlation_Parameter skip_solve_gamma_threshold_param(skip_solve_gamma_th
 /// Correlation parameter and properties
 const Correlation_Parameter initial_gamma_threshold_param(initial_gamma_threshold,SCALAR_PARAM,true,
   "If the gamma evaluation for the initial deformation guess is not below this value, initialization will fail");
+const Correlation_Parameter sssig_threshold_param(sssig_threshold,SCALAR_PARAM,true,
+  "filters out areas of the image with low gradients, if a subset has an SSSIG below this value it gets excluded");
 /// Correlation parameter and properties
 const Correlation_Parameter final_gamma_threshold_param(final_gamma_threshold,SCALAR_PARAM,true,
   "If the gamma evaluation for the final deformation guess is not below this value, the step will fail for this subset");
@@ -1168,7 +1172,7 @@ const Correlation_Parameter filter_failed_cine_pixels_param(filter_failed_cine_p
 // TODO don't forget to update this when adding a new one
 /// The total number of valid correlation parameters
 /// Vector of valid parameter names
-const int_t num_valid_correlation_params = 79;
+const int_t num_valid_correlation_params = 80;
 /// Vector oIf valid parameter names
 const Correlation_Parameter valid_correlation_params[num_valid_correlation_params] = {
   correlation_routine_param,
@@ -1194,6 +1198,7 @@ const Correlation_Parameter valid_correlation_params[num_valid_correlation_param
   skip_all_solves_param,
   skip_solve_gamma_threshold_param,
   initial_gamma_threshold_param,
+  sssig_threshold_param,
   final_gamma_threshold_param,
   path_distance_threshold_param,
   disp_jump_tol_param,

src/core/DICe_Decomp.cpp

@@ -577,12 +577,9 @@ Decomp::populate_global_coordinate_vector(Teuchos::ArrayRCP<scalar_t> & subset_c
           }
         }
       }
-      if(optimization_method==GRADIENT_BASED || optimization_method==GRADIENT_BASED_THEN_SIMPLEX){
-        const scalar_t grad_threshold = 50.0; // threshold determined from example images
-        DICe::create_regular_grid_of_correlation_points(*subset_centroids_on_0,*neighbor_ids_on_0,input_params,image,subset_info,grad_threshold);
-      }
-      else
-        DICe::create_regular_grid_of_correlation_points(*subset_centroids_on_0,*neighbor_ids_on_0,input_params,image,subset_info);
+      const scalar_t default_threshold = optimization_method==GRADIENT_BASED || optimization_method==GRADIENT_BASED_THEN_SIMPLEX ? 50.0: -1.0;
+      const scalar_t grad_threshold = correlation_params->get<double>(DICe::sssig_threshold,default_threshold);
+      DICe::create_regular_grid_of_correlation_points(*subset_centroids_on_0,*neighbor_ids_on_0,input_params,image,subset_info,grad_threshold);
       // check all the subsets and eliminate ones with a gradient ratio too low
       num_global_subsets = subset_centroids_on_0->size()/dim; // divide by three because the stride is x y neighbor_id
       assert(neighbor_ids_on_0->size()==subset_centroids_on_0->size()/2);

src/core/DICe_ParameterUtilities.cpp

@@ -370,6 +370,7 @@ DICE_LIB_DLL_EXPORT void tracking_default_params(Teuchos::ParameterList *  defau
   defaultParams->set(DICe::skip_solve_gamma_threshold,1.0E-10);
   defaultParams->set(DICe::skip_all_solves,false);
   defaultParams->set(DICe::initial_gamma_threshold,-1.0);
+  defaultParams->set(DICe::sssig_threshold,-1.0);
   defaultParams->set(DICe::final_gamma_threshold,-1.0);
   defaultParams->set(DICe::path_distance_threshold,-1.0);
   defaultParams->set(DICe::rotate_ref_image_90,false);
@@ -425,6 +426,7 @@ DICE_LIB_DLL_EXPORT void dice_default_params(Teuchos::ParameterList *  defaultPa
   defaultParams->set(DICe::skip_solve_gamma_threshold,1.0E-10);
   defaultParams->set(DICe::skip_all_solves,false);
   defaultParams->set(DICe::initial_gamma_threshold,-1.0);
+  defaultParams->set(DICe::sssig_threshold,-1.0);
   defaultParams->set(DICe::final_gamma_threshold,-1.0);
   defaultParams->set(DICe::path_distance_threshold,-1.0);
   defaultParams->set(DICe::rotate_ref_image_90,false);

src/core/DICe_Parser.cpp

@@ -1554,7 +1554,6 @@ bool valid_correlation_point(const int_t x_coord,
   std::set<std::pair<int_t,int_t> > & coords,
   std::set<std::pair<int_t,int_t> > & excluded_coords,
   const scalar_t & grad_threshold){
-
   // need to check if the point is interior to the image by at least one subset_size
   if(x_coord<subset_size-1) return false;
   if(x_coord>image->width()-subset_size) return false;