Merge pull request #317 from carterbox/log-affine

NEW: Add affine transformation to INFO logging output

src/tike/ptycho/position.py

@@ -180,8 +180,8 @@ def fromarray(self, T: np.ndarray) -> AffineTransform:
             scale1=float(scale1),
             shear1=float(shear1),
             angle=float(angle),
-            t0=T[2, 0],
-            t1=T[2, 1],
+            t0=T[2, 0] if T.shape[0] > 2 else 0,
+            t1=T[2, 1] if T.shape[0] > 2 else 0,
         )
 
     def asarray(self, xp=np) -> np.ndarray:

src/tike/ptycho/ptycho.py

@@ -226,6 +226,20 @@ def reconstruct(
             use_mpi,
     ) as context:
         context.iterate(parameters.algorithm_options.num_iter)
+
+    if (
+        logger.getEffectiveLevel() <= logging.INFO
+    ) and context.parameters.position_options:
+        mean_scaling = 0.5 * (
+            context.parameters.position_options.transform.scale0
+            + context.parameters.position_options.transform.scale1
+        )
+        logger.info(
+            f"Global scaling of {mean_scaling:.3e} detected from position correction."
+            " Probably your estimate of photon energy and/or sample to detector "
+            "distance is off by that amount."
+        )
+
     return context.parameters
 
 
@@ -921,6 +935,18 @@ def reconstruct_multigrid(
             context.iterate(resampled_parameters.algorithm_options.num_iter)
 
         if level == 0:
+            if (
+                logger.getEffectiveLevel() <= logging.INFO
+            ) and context.parameters.position_options:
+                mean_scaling = 0.5 * (
+                    context.parameters.position_options.transform.scale0
+                    + context.parameters.position_options.transform.scale1
+                )
+                logger.info(
+                    f"Global scaling of {mean_scaling:.3e} detected from position correction."
+                    " Probably your estimate of photon energy and/or sample to detector "
+                    "distance is off by that amount."
+                )
             return context.parameters
 
         # Upsample result to next grid