Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow initial = None in SIRT #1906

Merged
merged 7 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions Wrappers/Python/cil/optimisation/algorithms/SIRT.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class SIRT(Algorithm):
----------

initial : DataContainer, default = None
Starting point of the algorithm, default value = Zero DataContainer
Starting point of the algorithm, default value = DataContainer in the domain of the operator allocated with zeros.
operator : LinearOperator
The operator A.
data : DataContainer
Expand Down Expand Up @@ -91,7 +91,7 @@ class SIRT(Algorithm):
"""


def __init__(self, initial, operator, data, lower=None, upper=None, constraint=None, **kwargs):
def __init__(self, initial=None, operator=None, data=None, lower=None, upper=None, constraint=None, **kwargs):

super(SIRT, self).__init__(**kwargs)

Expand All @@ -100,6 +100,14 @@ def __init__(self, initial, operator, data, lower=None, upper=None, constraint=N
def set_up(self, initial, operator, data, lower=None, upper=None, constraint=None):
"""Initialisation of the algorithm"""
log.info("%s setting up", self.__class__.__name__)

if operator is None:
raise ValueError('You must pass an `operator` to the SIRT algorithm')
if data is None:
raise ValueError('You must pass `data` to the SIRT algorithm')
paskino marked this conversation as resolved.
Show resolved Hide resolved
if initial is None:
initial = operator.domain_geometry().allocate(0)

self.x = initial.copy()
self.tmp_x = self.x * 0.0
self.operator = operator
Expand Down
44 changes: 44 additions & 0 deletions Wrappers/Python/test/test_algorithms.py
Original file line number Diff line number Diff line change
Expand Up @@ -979,6 +979,50 @@ def setUp(self):

def tearDown(self):
pass

def test_set_up(self):

initial = self.A2.domain_geometry().allocate(0)
sirt = SIRT(initial=initial, operator=self.A2, data=self.b2, lower=0, upper=1)

# Test if set_up correctly configures the object
self.assertTrue(sirt.configured)
self.assertIsNotNone(sirt.x)
self.assertIsNotNone(sirt.r)
self.assertIsNotNone(sirt.constraint)
self.assertEqual(sirt.constraint.lower, 0)
self.assertEqual(sirt.constraint.upper, 1)


constraint = IndicatorBox(lower=0, upper=1)
sirt = SIRT(initial=None, operator=self.A2, data=self.b2, constraint=constraint)

# Test if set_up correctly configures the object with constraint
self.assertTrue(sirt.configured)
self.assertEqual(sirt.constraint, constraint)


with self.assertRaises(ValueError) as context:
sirt = SIRT(initial=None, operator=None, data=self.b2)
self.assertEqual(str(context.exception), 'You must pass an `operator` to the SIRT algorithm')
paskino marked this conversation as resolved.
Show resolved Hide resolved


with self.assertRaises(ValueError) as context:
sirt = SIRT(initial=None, operator=self.A2, data=None)
self.assertEqual(str(context.exception), 'You must pass `data` to the SIRT algorithm')
paskino marked this conversation as resolved.
Show resolved Hide resolved


sirt = SIRT(initial=None, operator=self.A2, data=self.b2)
self.assertTrue(sirt.configured)
self.assertIsInstance(sirt.x, ImageData)
self.assertTrue((sirt.x.as_array() == 0).all())


initial = self.A2.domain_geometry().allocate(1)
sirt = SIRT(initial=initial, operator=self.A2, data=self.b2)
self.assertTrue(sirt.configured)
self.assertIsInstance(sirt.x, ImageData)
self.assertTrue((sirt.x.as_array() == 1).all())

def test_update(self):
# sirt run 5 iterations
Expand Down
Loading