FIX: type of compare_images pattern kwarg can be 2 dimensional

Author: PaulHax

itkwidgets/viewer.py

@@ -275,7 +275,7 @@ def set_image_volume_sample_distance(self, distance: float):
     def set_image_volume_scattering_blend(self, scattering_blend: float):
         self.queue_request('setImageVolumeScatteringBlend', scattering_blend)
 
-    def compare_images(self, fixed_image: Union[str, Image], moving_image: Union[str, Image], method: str = None, image_mix: float = None, checkerboard: bool = None, pattern: Tuple[int, int, int] = None, swap_image_order: bool = None):
+    def compare_images(self, fixed_image: Union[str, Image], moving_image: Union[str, Image], method: str = None, image_mix: float = None, checkerboard: bool = None, pattern: Union[Tuple[int, int], Tuple[int, int, int]] = None, swap_image_order: bool = None):
         # image args may be image name or image object
         fixed_name = 'Fixed'
         if isinstance(fixed_image, str): 
@@ -478,7 +478,7 @@ def view(data=None, **kwargs):
 
     return viewer
 
-def compare_images(fixed_image: Union[str, Image], moving_image: Union[str, Image], method: str = None, image_mix: float = None, checkerboard: bool = None, pattern: Tuple[int, int, int] = None, swap_image_order: bool = None):
+def compare_images(fixed_image: Union[str, Image], moving_image: Union[str, Image], method: str = None, image_mix: float = None, checkerboard: bool = None, pattern: Union[Tuple[int, int], Tuple[int, int, int]] = None, swap_image_order: bool = None):
     """Fuse 2 images with a checkerboard filter or as a 2 component image.  
 
     The moving image is re-sampled to the fixed image space. Set a keyword argument to None to use defaults based on method.
@@ -492,11 +492,10 @@ def compare_images(fixed_image: Union[str, Image], moving_image: Union[str, Imag
         Image is re-sampled to the fixed_image. For 'blend and 'cyan-magenta' methods, the moving image is on the second component.
 
     method: string, default: None, possible values: 'cyan-magenta', 'blend', 'checkerboard', 'disabled'
-        checkerboard method picks pixels from the fixed and moving image to create a
-        checkerboard pattern. The checkerboard as method turns on the checkerboard flag. 
-        cyan-magenta method puts the fixed image on component 0, moving image on component 1
-        and changes the color map for fixed image to cyan, moving image to magenta.
-        Blend method puts the fixed image on component 0, moving image on component 1. 
+        The checkerboard method picks pixels from the fixed and moving image to create a
+        checkerboard pattern. Setting the method to checkerboard turns on the checkerboard flag. 
+        The blend and cyan-magenta method puts the fixed image on component 0, moving image on component 1.
+        The cyan-magenta method also changes the color map for fixed image to cyan, moving image to magenta.
 
     image_mix: float, default: None
         Changes the percent contribution the fixed vs moving image makes to the
@@ -509,14 +508,14 @@ def compare_images(fixed_image: Union[str, Image], moving_image: Union[str, Imag
         The rendered image has 2 components, each component reverses which image is sampled for each
         checkerboard box.
 
-    pattern: Tuple[int, int, int], default: None
+    pattern: Union[Tuple[int, int], Tuple[int, int, int]], default: None
         The number of checkerboard boxes for each dimension.
 
     swap_image_order: bool, default: None
         Reverses which image is sampled for each checkerboard box.  This simply toggles
         image_mix between 0 and 1.
     """
     viewer = view()
-    viewer.compare_images(fixed_image, moving_image, method, image_mix, checkerboard, pattern, swap_image_order)
+    viewer.compare_images(fixed_image=fixed_image, moving_image=moving_image, method=method, image_mix=image_mix, checkerboard=checkerboard, pattern=pattern, swap_image_order=swap_image_order)
     return viewer