Documentation clarification.

lsst · Apr 16, 2020 · 657f918 · 657f918
1 parent 3e815f9
commit 657f918
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 11 deletions.
diff --git a/pipelines/VisualizeVisit.yaml b/pipelines/VisualizeVisit.yaml
@@ -4,3 +4,5 @@ tasks:
     class: lsst.pipe.tasks.visualizeVisit.VisualizeBinExpTask
   mosaic:
     class: lsst.pipe.tasks.visualizeVisit.VisualizeMosaicExpTask
+contracts:
+  - binning.binning == mosaic.binning
diff --git a/python/lsst/pipe/tasks/visualizeVisit.py b/python/lsst/pipe/tasks/visualizeVisit.py
@@ -62,7 +62,7 @@ class VisualizeBinExpConfig(pipeBase.PipelineTaskConfig,
     binning = pexConfig.Field(
         dtype=int,
         default=8,
-        doc="Binning factor to apply to each input exposure.",
+        doc="Binning factor to apply to each input exposure's image data.",
     )
     detectorKeyword = pexConfig.Field(
         dtype=str,
@@ -98,7 +98,7 @@ def run(self, inputExp, camera):
             Results struct with attribute:
 
             ``outputExp``
-                Binned version of input image. (`lsst.afw.image.Exposure`)
+                Binned version of input image (`lsst.afw.image.Exposure`).
         """
         if inputExp.getDetector() is None:
             detectorId = inputExp.getMetadata().get(self.config.detectorKeyword)
@@ -150,21 +150,18 @@ class VisualizeMosaicExpConfig(pipeBase.PipelineTaskConfig,
     binning = pexConfig.Field(
         dtype=int,
         default=8,
-        doc="Binning factor to apply to input exposures before mosaicking.",
+        doc="Binning factor previously applied to input exposures.",
     )
 
 
 class VisualizeMosaicExpTask(pipeBase.PipelineTask,
                              pipeBase.CmdLineTask):
     """Task to mosaic binned products.
 
-    Additional binning of the mosaic can also be performed by setting
-    the binning value greater than 1.  The tradeoff between binning in
-    this task and in VisualizeBinningExpTask is that binning there
-    allows the work to be parallelized.  However, binning entirely at
-    that level would result in a focal plane image that has inter-chip
-    gaps that are either too wide or too narrow to provide an accurate
-    visualization.
+    The config.binning parameter must match that used in the
+    VisualizeBinExpTask.  Otherwise there will be a mismatch between
+    the input image size and the expected size of that image in the
+    full focal plane frame.
     """
     ConfigClass = VisualizeMosaicExpConfig
     _DefaultName = 'VisualizeMosaicExp'
@@ -208,7 +205,7 @@ def run(self, inputExps, camera):
             Results struct with attribute:
 
             ``outputExp``
-                Binned version of input image. (`lsst.afw.image.Exposure`)
+                Binned version of input image (`lsst.afw.image.Exposure`).
         """
         expDict = {exp.getDetector().getId(): exp for exp in inputExps}
         image = self.makeCameraImage(expDict, camera, self.config.binning)