Little more detail on the miscenter default settings

lsst-ts · Dec 6, 2024 · 07cafbd · 07cafbd
1 parent cd07fbd
commit 07cafbd
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/python/lsst/ts/wep/utils/modelUtils.py b/python/lsst/ts/wep/utils/modelUtils.py
@@ -106,11 +106,15 @@ def forwardModelPair(
     miscenterIntra : tuple, optional
         The amount by which the intrafocal donut is miscentered. A tuple of
         (dx, dy) in pixels. If None, a random value between +/- 2 is used
-        for each. (the default is None)
+        for each. Note the random non-zero offsets are default to avoid
+        pixel aliasing effects when examining ensembles of wavefront
+        estimation errors. (the default is None)
     miscenterExtra : tuple, optional
         The amount by which the extrafocal donut is miscentered. A tuple of
         (dx, dy) in pixels. If None, a random value between +/- 2 is used
-        for each. (the default is None)
+        for each. Note the random non-zero offsets are default to avoid
+        pixel aliasing effects when examining ensembles of wavefront
+        estimation errors. (the default is None)
     blendOffsetsIntra : Iterable or None, optional
         The blend offsets of the intrafocal donut.
         (the default is None)