Merge pull request #192 from tbirdso/exhaustive-optimizer

ENH: Add ExhaustiveOptimizerv4 Python example

Author: thewtex

.github/workflows/build-test.yml

@@ -157,7 +157,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install ninja
-          python -m pip install itk==5.2rc1
+          python -m pip install itk==5.2rc02
 
       - name: Get specific version of CMake, Ninja
         uses: lukka/get-cmake@v3.18.3

src/Numerics/Optimizers/CMakeLists.txt

@@ -1,5 +1,3 @@
 add_example(AmoebaOptimizer)
 add_example(LevenbergMarquardtOptimization)
-
-#TODO: Example needs valid input
-#add_example(ExhaustiveOptimizer)
+add_example(ExhaustiveOptimizer)

src/Numerics/Optimizers/ExhaustiveOptimizer/CMakeLists.txt

@@ -14,13 +14,25 @@ install(TARGETS ExhaustiveOptimizer
   COMPONENT Runtime
   )
 
-install(FILES Code.cxx CMakeLists.txt
+install(FILES Code.cxx Code.py CMakeLists.txt
   DESTINATION share/ITKExamples/Code/Numerics/Optimizers/ExhaustiveOptimizer/
   COMPONENT Code
   )
 
 
 enable_testing()
-add_test(NAME ExhaustiveOptimizerTest
-  COMMAND ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ExhaustiveOptimizer)
 
+set(fixed_image ${CMAKE_CURRENT_BINARY_DIR}/orange.jpg)
+set(moving_image ${CMAKE_CURRENT_BINARY_DIR}/apple.jpg)
+
+add_test(NAME ExhaustiveOptimizerTest
+  COMMAND ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ExhaustiveOptimizer
+	${fixed_image}
+	${moving_image})
+	
+if(ITK_WRAP_PYTHON)
+	add_test(NAME ExhaustiveOptimizerTestPython
+	 COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/Code.py
+	  ${fixed_image}
+	  ${moving_image})
+endif()

src/Numerics/Optimizers/ExhaustiveOptimizer/Code.py

@@ -0,0 +1,102 @@
+#!/usr/bin/env python
+#=========================================================================
+#
+#  Copyright NumFOCUS
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0.txt
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+#
+
+# Python example demonstrating itk.ExhaustiveOptimizer usage
+import sys
+from math import pi
+
+import itk
+
+EXIT_SUCCESS = 0
+EXIT_FAILURE = 1
+
+def main(argv):
+    if len(argv) < 3:
+        raise Exception(f'Usage: {argv[0]} fixed_image moving_image')
+    
+    fixed_image = itk.imread(argv[1], itk.F)
+    moving_image = itk.imread(argv[2],itk.F)
+    
+    dimension = fixed_image.GetImageDimension()
+    FixedImageType = type(fixed_image)
+    MovingImageType = type(moving_image)
+
+    if dimension == 2:
+        transform = itk.Euler2DTransform[itk.D].New()
+    else:
+        raise Exception(f'Unsupported dimension: {dimension}')
+    
+    TransformInitializerType = \
+        itk.CenteredTransformInitializer[itk.MatrixOffsetTransformBase[itk.D,
+                                                                       dimension,
+                                                                       dimension],
+                                         FixedImageType, MovingImageType]
+    initializer = TransformInitializerType.New(Transform=transform,
+        FixedImage=fixed_image,
+        MovingImage=moving_image,)
+    initializer.InitializeTransform()
+    
+    metric = itk.MeanSquaresImageToImageMetricv4[FixedImageType, MovingImageType].New()
+    
+    optimizer = itk.ExhaustiveOptimizerv4[itk.D].New()
+    def print_iteration():
+        print(f'Iteration:'
+              f'{optimizer.GetCurrentIteration()}\t'
+              f'{list(optimizer.GetCurrentIndex())} \t'
+              f'{optimizer.GetCurrentValue():10.4f}\t'
+              f'{list(optimizer.GetCurrentPosition())}\t')
+    
+    optimizer.AddObserver(itk.IterationEvent(), print_iteration)
+
+    angles = 12
+    optimizer.SetNumberOfSteps([int(angles / 2),0,0])
+
+    # Initialize scales and set back to optimizer
+    scales = optimizer.GetScales()
+    scales.SetSize(3)
+    scales.SetElement(0, 2.0 * pi / angles)
+    scales.SetElement(1, 1.0)
+    scales.SetElement(2, 1.0)
+    optimizer.SetScales(scales)
+    
+    RegistrationType = itk.ImageRegistrationMethodv4[FixedImageType,MovingImageType]
+    registration = RegistrationType.New(Metric=metric,
+        Optimizer=optimizer,
+        FixedImage=fixed_image,
+        MovingImage=moving_image,
+        InitialTransform=transform,
+        NumberOfLevels=1)
+
+    try:
+        registration.Update()
+
+        print(f'MinimumMetricValue: {optimizer.GetMinimumMetricValue():.4f}\t'
+              f'MaximumMetricValue: {optimizer.GetMaximumMetricValue():.4f}\n'
+              f'MinimumMetricValuePosition: {list(optimizer.GetMinimumMetricValuePosition())}\t'
+              f'MaximumMetricValuePosition: {list(optimizer.GetMaximumMetricValuePosition())}\n'
+              f'StopConditionDescription: {optimizer.GetStopConditionDescription()}\t')
+
+    except Exception as e:
+        print(f'Exception caught: {e}')
+        return EXIT_FAILURE
+
+    return EXIT_SUCCESS
+
+if __name__ == "__main__":
+    main(sys.argv)

src/Numerics/Optimizers/ExhaustiveOptimizer/Documentation.rst

@@ -27,6 +27,13 @@ C++
 .. literalinclude:: Code.cxx
    :lines: 18-
 
+Python
+...
+
+.. literalinclude:: Code.py
+	:lines: 20-
+
+
 Classes demonstrated
 --------------------
 

src/Numerics/Optimizers/ExhaustiveOptimizer/OutputBaseline.jpg.sha512

@@ -0,0 +1 @@
+8dd0115569bc6dec91e5164ddb44366dbed265d130a5ad6cb68c9c2e7d8339920871f20f3df2865501890b0b8237c0292dd66a6ec6d450ed25bd17257a745985

src/Numerics/Optimizers/ExhaustiveOptimizer/apple.jpg.sha512

@@ -0,0 +1 @@
+d3dca735afb71e29461854bc471e8c3b8c03b5ba6abf68e9fb8467bf7c42f16d915015cbad21e8b78aa66b4b8ab7675a2a6f64e6d710e66832e730c6d4d0c1d8

src/Numerics/Optimizers/ExhaustiveOptimizer/orange.jpg.sha512

@@ -0,0 +1 @@
+67ead1cd2c867ff6d2c58b014ea9d0af3d83f2b08d0762740f4104fe7518528cd5b6313ed228a8c896f48b77c61bd5c19fddec5112d3ff0916dab8b4ec4955a4