PET: Add subset algebra test (#1342)

* add algebra unit test for STIR AcquisitionData subsets for storage scheme memory and file.
* added to changes
* removed commented out code

Author: paskino

CHANGES.md

@@ -3,6 +3,7 @@
 
 * CI
   - made tests return value handling compatible with a future version of pytest.
+  - added algebraic tests for STIR AcquisitionData subsets.
 
 * SIRF/STIR
   - `ScatterEstimation` has extra methods that allow setting masks for the tail-fitting.

src/xSTIR/pSTIR/tests/test_algebra.py

@@ -19,6 +19,8 @@
 
 import os
 import unittest
+import inspect
+import functools
 import sirf.STIR as pet
 from sirf.Utilities import examples_data_path, DataContainerAlgebraTests
 
@@ -47,7 +49,6 @@ def setUp(self):
             template = pet.AcquisitionData(path)
             self.image1 = template.get_uniform_copy(0)
             self.image2 = template.get_uniform_copy(0)
-            # assert False
             self.set_storage_scheme()
 
 
@@ -57,10 +58,6 @@ def tearDown(self):
     def set_storage_scheme(self):
         pet.AcquisitionData.set_storage_scheme('file')
 
-    def test_division_by_datacontainer_zero(self):
-        # skip this test as currently cSIRF doesn't throw
-        pass
-
 
 class TestSTIRAcquisitionDataAlgebraMemory(unittest.TestCase, DataContainerAlgebraTests):
     def setUp(self):
@@ -71,8 +68,53 @@ def setUp(self):
             template = pet.AcquisitionData(path)
             self.image1 = template.get_uniform_copy(0)
             self.image2 = template.get_uniform_copy(0)
-            # assert False
             pet.AcquisitionData.set_storage_scheme('memory')
-    def test_division_by_datacontainer_zero(self):
-        # skip this test as currently cSIRF doesn't throw
-        pass
+
+class TestSTIRAcquisitionDataSubsetAlgebra():
+    def setUp(self):
+        path = os.path.join(
+            examples_data_path('PET'), 'thorax_single_slice', 'template_sinogram.hs')
+        if os.path.exists(path):
+            template = pet.AcquisitionData(path)
+            prompts = template.get_uniform_copy(0)
+            # create a staggered list of views for 2 subsets
+            views = prompts.dimensions()[2]
+            indices = list(range(views))
+            num_batches = 2
+            batches = [indices[i::num_batches] for i in range(num_batches)]
+            
+            self.image1 = prompts.get_subset(batches[0])
+            self.image2 = prompts.get_subset(batches[0])
+            
+            
+class TestSTIRAcquisitionDataSubsetAlgebraMemory(TestSTIRAcquisitionDataSubsetAlgebra, unittest.TestCase, DataContainerAlgebraTests):
+    def setUp(self):
+        pet.AcquisitionData.set_storage_scheme('memory')
+        super().setUp()
+
+
+class TestSTIRAcquisitionDataSubsetAlgebraFile(TestSTIRAcquisitionDataSubsetAlgebra, unittest.TestCase, DataContainerAlgebraTests):
+    def setUp(self):
+        pet.AcquisitionData.set_storage_scheme('file')
+        super().setUp()
+        
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # wrap all test methods that would raise exception as
+        # storage_scheme file does not work
+        a = inspect.getmembers(DataContainerAlgebraTests, predicate=inspect.isfunction)
+        def wrapper(self, func):
+            try:
+                func(self)
+            except Exception as e:
+                print (f"Caught exception in {func.__name__}: {e}")
+                return
+            raise AssertionError(f"Expected exception in {func.__name__} but none was raised.")
+        
+        for m in a:
+            # test_division_by_datacontainer_zero and test_division_by_scalar_zero
+            # do not raise exception, they just assert True. Skip them.
+            if m[0] not in ["test_division_by_datacontainer_zero", "test_division_by_scalar_zero"]:
+                self.__setattr__(m[0], functools.partial(wrapper, self, m[1]))
+
+        self.__setattr__('setUp', functools.partial(wrapper, self, self.setUp))