Merge pull request #25 from BrainLesion/outsource_functionals

new: functional

ereg/__init__.py

@@ -1,3 +1,4 @@
 # TODO do we need this?
+from .functional import registration_function
 from .registration import RegistrationClass
 from .utils.io import read_image_and_cast_to_32bit_float

ereg/functional.py

@@ -0,0 +1,50 @@
+import os
+from typing import Union
+
+import SimpleITK as sitk
+
+from ereg import RegistrationClass
+
+
+def registration_function(
+    target_image: Union[str, sitk.Image],
+    moving_image: Union[str, sitk.Image],
+    output_image: str,
+    config_file: str,
+    transform_file: str = None,
+    log_file: str = None,
+    **kwargs,
+) -> float:
+    """
+    This is a functional wrapper for the registration class.
+
+    Args:
+        target_image (Union[str, sitk.Image]): The target image.
+        moving_image (Union[str, sitk.Image]): The moving image.
+        output_image (str): The output image.
+        config_file (str): The config file for the registration.
+        transform_file (str, optional): The transform file. Defaults to None.
+
+    Returns:
+        float: The structural similarity index.
+    """
+    if isinstance(config_file, str):
+        assert os.path.isfile(config_file), "Config file does not exist."
+    elif isinstance(config_file, dict):
+        pass
+    else:
+        raise ValueError("Config file must be a string or dictionary.")
+
+    registration_obj = RegistrationClass(config_file)
+    registration_obj.register(
+        target_image=target_image,
+        moving_image=moving_image,
+        output_image=output_image,
+        transform_file=transform_file,
+        log_file=log_file,
+        **kwargs,
+    )
+    return registration_obj.ssim_score
+
+
+# TODO we also need a transformation/resample function

ereg/registration.py

@@ -858,44 +858,3 @@ def _register_image_and_get_transform(
         # tmp.SetCenter(output_transform.GetCenter())
         # output_transform = tmp
         return registration_transform_sitk
-
-
-def registration_function(
-    target_image: Union[str, sitk.Image],
-    moving_image: Union[str, sitk.Image],
-    output_image: str,
-    config_file: str,
-    transform_file: str = None,
-    log_file: str = None,
-    **kwargs,
-) -> float:
-    """
-    This is a functional wrapper for the registration class.
-
-    Args:
-        target_image (Union[str, sitk.Image]): The target image.
-        moving_image (Union[str, sitk.Image]): The moving image.
-        output_image (str): The output image.
-        config_file (str): The config file for the registration.
-        transform_file (str, optional): The transform file. Defaults to None.
-
-    Returns:
-        float: The structural similarity index.
-    """
-    if isinstance(config_file, str):
-        assert os.path.isfile(config_file), "Config file does not exist."
-    elif isinstance(config_file, dict):
-        pass
-    else:
-        raise ValueError("Config file must be a string or dictionary.")
-
-    registration_obj = RegistrationClass(config_file)
-    registration_obj.register(
-        target_image=target_image,
-        moving_image=moving_image,
-        output_image=output_image,
-        transform_file=transform_file,
-        log_file=log_file,
-        **kwargs,
-    )
-    return registration_obj.ssim_score