Flake8 and comment consistency fixes

Author: laurenam

python/lsst/pipe/tasks/characterizeImage.py

@@ -220,8 +220,9 @@ class CharacterizeImageConfig(pipeBase.PipelineTaskConfig,
         target=ApplyApCorrTask,
         doc="Subtask to apply aperture corrections"
     )
-    # If doApCorr is False, and the exposure does not have apcorrections already applied, the
-    # active plugins in catalogCalculation almost certainly should not contain the characterization plugin
+    # If doApCorr is False, and the exposure does not have apcorrections
+    # already applied, the active plugins in catalogCalculation almost
+    # certainly should not contain the characterization plugin.
     catalogCalculation = pexConfig.ConfigurableField(
         target=CatalogCalculationTask,
         doc="Subtask to run catalogCalculation plugins on catalog"
@@ -287,27 +288,28 @@ class CharacterizeImageConfig(pipeBase.PipelineTaskConfig,
     def setDefaults(self):
         super().setDefaults()
         # Just detect bright stars.
-        # The thresholdValue sets the minimum flux in a pixel to be included in the
-        # footprint, while peaks are only detected when they are above
+        # The thresholdValue sets the minimum flux in a pixel to be included
+        # in the footprint, while peaks are only detected when they are above
         # thresholdValue * includeThresholdMultiplier. The low thresholdValue
         # ensures that the footprints are large enough for the noise replacer
         # to mask out faint undetected neighbors that are not to be measured.
         self.detection.thresholdValue = 5.0
         self.detection.includeThresholdMultiplier = 10.0
         # do not deblend, as it makes a mess
         self.doDeblend = False
-        # measure and apply aperture correction; note: measuring and applying aperture
-        # correction are disabled until the final measurement, after PSF is measured
+        # Measure and apply aperture correction; note: measuring and applying
+        # aperture correction are disabled until the final measurement, after
+        # PSF is measured.
         self.doApCorr = True
-        # During characterization, we don't have full source measurement information,
-        # so must do the aperture correction with only psf stars, combined with the
-        # default signal-to-noise cuts in MeasureApCorrTask.
+        # During characterization, we don't have full source measurement
+        # information, so must do the aperture correction with only psf stars,
+        # combined with the default signal-to-noise cuts in MeasureApCorrTask.
         selector = self.measureApCorr.sourceSelector["science"]
         selector.doUnresolved = False
         selector.flags.good = ["calib_psf_used"]
         selector.flags.bad = []
 
-        # minimal set of measurements needed to determine PSF
+        # Minimal set of measurements needed to determine PSF.
         self.measurement.plugins.names = [
             "base_PixelFlags",
             "base_SdssCentroid",
@@ -324,7 +326,7 @@ def validate(self):
         if self.doApCorr and not self.measurePsf:
             raise RuntimeError("Must measure PSF to measure aperture correction, "
                                "because flags determined by PSF measurement are used to identify "
-                               "sources used to measure aperture correction")
+                               "sources used to measure aperture correction.")
 
 
 class CharacterizeImageTask(pipeBase.PipelineTask):
@@ -351,21 +353,25 @@ class CharacterizeImageTask(pipeBase.PipelineTask):
     CharacterizeImageTask has a debug dictionary with the following keys:
 
     frame
-        int: if specified, the frame of first debug image displayed (defaults to 1)
+        int: if specified, the frame of first debug image displayed (defaults
+        to 1).
     repair_iter
-        bool; if True display image after each repair in the measure PSF loop
+        bool; if True display image after each repair in the measure PSF loop.
     background_iter
-        bool; if True display image after each background subtraction in the measure PSF loop
+        bool; if True display image after each background subtraction in the
+        measure PSF loop.
     measure_iter
-        bool; if True display image and sources at the end of each iteration of the measure PSF loop
-        See `~lsst.meas.astrom.displayAstrometry` for the meaning of the various symbols.
+        bool; if True display image and sources at the end of each iteration
+        of the measure PSF loop. See `~lsst.meas.astrom.displayAstrometry` for
+        the meaning of the various symbols.
     psf
         bool; if True display image and sources after PSF is measured;
-        this will be identical to the final image displayed by measure_iter if measure_iter is true
+        this will be identical to the final image displayed by measure_iter if
+        measure_iter is true.
     repair
-        bool; if True display image and sources after final repair
+        bool; if True display image and sources after final repair.
     measure
-        bool; if True display image and sources after final measurement
+        bool; if True display image and sources after final measurement.
     """
 
     ConfigClass = CharacterizeImageConfig
@@ -413,8 +419,10 @@ def run(self, exposure, background=None, idGenerator=None):
         """Characterize a science image.
 
         Peforms the following operations:
-        - Iterate the following config.psfIterations times, or once if config.doMeasurePsf false:
-            - detect and measure sources and estimate PSF (see detectMeasureAndEstimatePsf for details)
+        - Iterate the following config.psfIterations times, or once if
+          config.doMeasurePsf false:
+            - detect and measure sources and estimate PSF (see
+              detectMeasureAndEstimatePsf for details)
         - interpolate over cosmic rays
         - perform final measurement
 
@@ -439,7 +447,8 @@ def run(self, exposure, background=None, idGenerator=None):
             ``background``
                Model of subtracted background (`lsst.afw.math.BackgroundList`).
             ``psfCellSet``
-               Spatial cells of PSF candidates (`lsst.afw.math.SpatialCellSet`).
+               Spatial cells of PSF candidates
+               (`lsst.afw.math.SpatialCellSet`).
             ``characterized``
                Another reference to ``exposure`` for compatibility.
             ``backgroundModel``
@@ -519,17 +528,17 @@ def run(self, exposure, background=None, idGenerator=None):
 
         self.display("psf", exposure=dmeRes.exposure, sourceCat=dmeRes.sourceCat)
 
-        # perform final repair with final PSF
+        # Perform final repair with final PSF.
         self.repair.run(exposure=dmeRes.exposure)
         self.display("repair", exposure=dmeRes.exposure, sourceCat=dmeRes.sourceCat)
 
-        # mask streaks
+        # Mask streaks.
         # TODO: Remove in DM-44658, streak masking to happen only in ip_diffim
         if self.config.doMaskStreaks:
             _ = self.maskStreaks.run(dmeRes.exposure)
 
-        # perform final measurement with final PSF, including measuring and applying aperture correction,
-        # if wanted
+        # Perform final measurement with final PSF, including measuring and
+        # applying aperture correction, if wanted.
         self.measurement.run(measCat=dmeRes.sourceCat, exposure=dmeRes.exposure,
                              exposureId=idGenerator.catalog_id)
 
@@ -557,7 +566,8 @@ def run(self, exposure, background=None, idGenerator=None):
                 # downstream.
                 dmeRes.exposure.info.setApCorrMap(None)
             else:
-                # Need to merge the aperture correction map from the normalization.
+                # Need to merge the aperture correction map from the
+                # normalization.
                 if normApCorrMap:
                     for key in normApCorrMap:
                         apCorrMap[key] = normApCorrMap[key]
@@ -585,12 +595,13 @@ def detectMeasureAndEstimatePsf(self, exposure, idGenerator, background):
         Performs the following operations:
 
         - if config.doMeasurePsf or not exposure.hasPsf():
-
-            - install a simple PSF model (replacing the existing one, if need be)
+            - install a simple PSF model (replacing the existing one, if
+               need be)
 
         - interpolate over cosmic rays with keepCRs=True
         - estimate background and subtract it from the exposure
-        - detect, deblend and measure sources, and subtract a refined background model;
+        - detect, deblend and measure sources, and subtract a refined
+           background model;
         - if config.doMeasurePsf:
             - measure PSF
 
@@ -615,19 +626,21 @@ def detectMeasureAndEstimatePsf(self, exposure, idGenerator, background):
             ``background``
                Model of subtracted background (`lsst.afw.math.BackgroundList`).
             ``psfCellSet``
-               Spatial cells of PSF candidates (`lsst.afw.math.SpatialCellSet`).
+               Spatial cells of PSF candidates
+               (`lsst.afw.math.SpatialCellSet`).
 
         Raises
         ------
         LengthError
             Raised if there are too many CR pixels.
         """
-        # install a simple PSF model, if needed or wanted
+        # Install a simple PSF model, if needed or wanted.
         if not exposure.hasPsf() or (self.config.doMeasurePsf and self.config.useSimplePsf):
             self.log.info("PSF estimation initialized with 'simple' PSF")
             self.installSimplePsf.run(exposure=exposure)
 
-        # run repair, but do not interpolate over cosmic rays (do that elsewhere, with the final PSF model)
+        # Run repair, but do not interpolate over cosmic rays (do that
+        # elsewhere, with the final PSF model).
         if self.config.requireCrForPsf:
             self.repair.run(exposure=exposure, keepCRs=True)
         else:
@@ -654,7 +667,7 @@ def detectMeasureAndEstimatePsf(self, exposure, idGenerator, background):
 
         if self.config.doDeblend:
             self.deblend.run(exposure=exposure, sources=sourceCat)
-            # We need the output catalog to be contiguous for further processing.
+            # The output catalog needs to be contiguous for further processing.
             if not sourceCat.isContiguous():
                 sourceCat = sourceCat.copy(deep=True)