Tweaks to logging

Author: nabobalis

sunkit_image/coalignment/interface.py

@@ -6,6 +6,7 @@
 import astropy
 import astropy.units as u
 
+from sunpy import log
 from sunpy.sun.models import differential_rotation
 from sunpy.util.exceptions import SunpyUserWarning
 
@@ -85,6 +86,7 @@ def _update_fits_wcs_metadata(target_map, reference_map, affine_params):
     new_reference_pixel = affine_params.scale * affine_params.rotation_matrix @ old_reference_pixel + affine_params.translation
     new_reference_coordinate = reference_map.wcs.pixel_to_world(*new_reference_pixel)
     # Create a new map with the updated metadata
+    log.debug(f"Shifting reference coordinate from {target_map.reference_coordinate} to {new_reference_coordinate} by {new_reference_coordinate.Tx - target_map.reference_coordinate.Tx}, {new_reference_coordinate.Ty - target_map.reference_coordinate.Ty}")
     return target_map.shift_reference_coord(
         new_reference_coordinate.Tx - target_map.reference_coordinate.Tx,
         new_reference_coordinate.Ty - target_map.reference_coordinate.Ty,

sunkit_image/coalignment/match_template.py

@@ -1,6 +1,8 @@
 import numpy as np
 from skimage.feature import match_template
 
+from sunpy import log
+
 from sunkit_image.coalignment.interface import AffineParams, register_coalignment_method
 
 __all__ = ["match_template_coalign"]
@@ -114,6 +116,7 @@ def match_template_coalign(target_array, reference_array, **kwargs):
         raise ValueError("The correlation output failed to work out a match.")
     # Find the best match location
     y_shift, x_shift = _find_best_match_location(corr)
+    log.debug(f"Match template shift: x: {x_shift}, y: {y_shift}")
     # Particularly for this method, there is no change in the rotation or scaling,
     # hence the hardcoded values of scale to 1.0 & rotation to identity matrix
     scale = np.array([1.0, 1.0])

sunkit_image/coalignment/phase_cross_correlation.py

@@ -1,6 +1,8 @@
 import numpy as np
 from skimage.registration import phase_cross_correlation
 
+from sunpy import log
+
 from sunkit_image.coalignment.interface import AffineParams, register_coalignment_method
 
 __all__ = ["phase_cross_correlation_coalign"]
@@ -36,8 +38,14 @@ def phase_cross_correlation_coalign(target_array, reference_array, **kwargs):
     """
     if target_array.shape != reference_array.shape:
         raise ValueError("Input and target arrays must be the same shape.")
+    if "upsample_factor" not in kwargs:
+        kwargs["upsample_factor"] = 20
     shift, _, _ = phase_cross_correlation(reference_array, target_array, **kwargs)
-    x_shift, y_shift = shift[1], shift[0]
+    # Shift has axis ordering which is consistent with the axis order of the input arrays, so y, x
+    # These are negative based on the example provided in the scikit-image documentation
+    # https://scikit-image.org/docs/stable/auto_examples/registration/plot_register_translation.html
+    x_shift, y_shift = -shift[1], -shift[0]
+    log.debug(f"Phase cross correlation shift: x: {x_shift}, y: {y_shift}")
     # Particularly for this method, there is no change in the rotation or scaling,
     # hence the hardcoded values of scale to 1.0 & rotation to identity matrix
     scale = np.array([1.0, 1.0])