add OSSPS set_relaxation_gamma (#1204)

* add OSSPS set_relaxation_gamma * added set/get methods for OSSPSReconstructor parameters * updated CHANGES.md [ci skip] --------- Co-authored-by: Evgueni Ovtchinnikov <[email protected]>
SyneRBI · Dec 7, 2023 · 058232b · 058232b
1 parent 031d428
commit 058232b
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 2 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,10 +1,11 @@
 # ChangeLog
 
+## v3.6.0
+
 * PET:
   - added extra members to ScatterEstimation to set behaviour of OSEM used during scatter estimation
   - added test for scatter simulation and estimation
-
-## v3.5.1
+  - added missing `set`/`get` methods for OSSPS `relaxation_parameter`, `relaxation_gamma` and `upper_bound`.
 
 * CMake/building:
   - default `DISABLE_MATLAB` to `ON` as our Matlab support is out-of-date and could

diff --git a/doc/UserGuide.md b/doc/UserGuide.md
@@ -520,6 +520,7 @@ Class for reconstructor objects using Ordered Subsets Separable Paraboloidal Sur
 
     OSSPSReconstructor       Constructor. Creates new OSSPS reconstructor object.
     set_relaxation_parameter Sets relaxation parameter.
+    set_relaxation_gamma Sets relaxation gamma parameter.
 
 ##### FullySampledReconstructor (MR) 
 

diff --git a/src/xSTIR/cSTIR/cstir_p.cpp b/src/xSTIR/cSTIR/cstir_p.cpp
@@ -1158,6 +1158,10 @@ sirf::cSTIR_setOSSPSParameter(DataHandle* hp, const char* name, const DataHandle
 		objectFromHandle<xSTIR_OSSPSReconstruction3DF >(hp);
 	if (sirf::iequals(name, "relaxation_parameter"))
 		recon.relaxation_parameter_value() = dataFromHandle<float>(hv);
+	else if (sirf::iequals(name, "relaxation_gamma"))
+		recon.relaxation_gamma_value() = dataFromHandle<float>(hv);
+	else if (sirf::iequals(name, "upper_bound"))
+		recon.upper_bound_value() = dataFromHandle<double>(hv);
 	else
 		return parameterNotFound(name, __FILE__, __LINE__);
 	return new DataHandle;
@@ -1168,6 +1172,12 @@ sirf::cSTIR_OSSPSParameter(const DataHandle* handle, const char* name)
 {
 	xSTIR_OSSPSReconstruction3DF& recon =
 		objectFromHandle<xSTIR_OSSPSReconstruction3DF>(handle);
+	if (sirf::iequals(name, "relaxation_parameter"))
+		return dataHandle<float>(recon.relaxation_parameter_value());
+	else if (sirf::iequals(name, "relaxation_gamma"))
+		return dataHandle<float>(recon.relaxation_gamma_value());
+	else if (sirf::iequals(name, "upper_bound"))
+		return dataHandle<double>(recon.upper_bound_value());
 	return parameterNotFound(name, __FILE__, __LINE__);
 }
 

diff --git a/src/xSTIR/cSTIR/include/sirf/STIR/stir_x.h b/src/xSTIR/cSTIR/include/sirf/STIR/stir_x.h
@@ -1177,6 +1177,12 @@ The actual algorithm is described in
 		float& relaxation_parameter_value() {
 			return relaxation_parameter;
 		}
+		float& relaxation_gamma_value() {
+			return relaxation_gamma;
+		}
+		double& upper_bound_value() {
+			return upper_bound;
+		}
 	};
 
 	class xSTIR_FBP2DReconstruction : public stir::FBP2DReconstruction {

diff --git a/src/xSTIR/pSTIR/STIR.py b/src/xSTIR/pSTIR/STIR.py
@@ -3435,6 +3435,28 @@ def set_relaxation_parameter(self, value):
         parms.set_float_par(
             self.handle, self.name, 'relaxation_parameter', value)
 
+    def set_relaxation_gamma(self, value):
+        """Sets relaxation gamma parameter."""
+        parms.set_float_par(
+            self.handle, self.name, 'relaxation_gamma', value)
+
+    def set_upper_bound(self, value):
+        """Sets upper bound parameter."""
+        parms.set_double_par(
+            self.handle, self.name, 'upper_bound', value)
+
+    def get_relaxation_parameter(self):
+        """Returns relaxation parameter value."""
+        return parms.float_par(self.handle, self.name, 'relaxation_parameter')
+
+    def get_relaxation_gamma(self):
+        """Returns relaxation gamma value."""
+        return parms.float_par(self.handle, self.name, 'relaxation_gamma')
+
+    def get_upper_bound(self):
+        """Returns upper bound value."""
+        return parms.double_par(self.handle, self.name, 'upper_bound')
+
 
 def make_Poisson_loglikelihood(acq_data, likelihood_type='LinearModelForMean',
                                acq_model=None):

diff --git a/src/xSTIR/pSTIR/STIR_params.py b/src/xSTIR/pSTIR/STIR_params.py
@@ -56,12 +56,19 @@ def set_bool_par(handle, group, par, value):
     set_parameter(handle, group, par, h, inspect.stack()[1])
     pyiutil.deleteDataHandle(h)
 
+
 def set_float_par(handle, group, par, value):
     h = pyiutil.floatDataHandle(float(value))
     set_parameter(handle, group, par, h, inspect.stack()[1])
     pyiutil.deleteDataHandle(h)
 
 
+def set_double_par(handle, group, par, value):
+    h = pyiutil.doubleDataHandle(float(value))
+    set_parameter(handle, group, par, h, inspect.stack()[1])
+    pyiutil.deleteDataHandle(h)
+
+
 def bool_par(handle, group, par):
     h = parameter(handle, group, par)
     check_status(h, inspect.stack()[1])
@@ -144,6 +151,14 @@ def float_pars(handle, group, par, n):
     return value
 
 
+def double_par(handle, group, par):
+    h = parameter(handle, group, par)
+    check_status(h)
+    v = pyiutil.doubleDataFromHandle(h)
+    pyiutil.deleteDataHandle(h)
+    return v
+
+
 def parameter_handle(hs, group, par):
     handle = parameter(hs, group, par)
     check_status(handle, inspect.stack()[1])

diff --git a/src/xSTIR/pSTIR/tests/tests_three.py b/src/xSTIR/pSTIR/tests/tests_three.py
@@ -46,6 +46,12 @@ def test_main(rec=False, verb=False, throw=True):
     recon.set_num_subiterations(2)
     recon.set_objective_function(obj_fun)
     recon.set_input(acq_data)
+    recon.set_relaxation_parameter(2)
+    recon.set_relaxation_gamma(.3)
+    recon.set_upper_bound(4e5)
+    test.check_if_equal_within_tolerance(2, recon.get_relaxation_parameter(), rel_tol=1e-5)
+    test.check_if_equal_within_tolerance(.3, recon.get_relaxation_gamma(), rel_tol=1e-5)
+    test.check_if_equal_within_tolerance(4e5, recon.get_upper_bound(), rel_tol=1e-5)
     if verb:
         print('setting up, please wait...')
     recon.set_up(image_data)