Skip to content

Commit 8727abc

Browse files
committed
Add missing docstrings
1 parent ad94565 commit 8727abc

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

python/lsst/ip/diffim/subtractImages.py

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -638,10 +638,11 @@ def runConvolveTemplate(self, template, science, psfMatchingKernel, backgroundMo
638638
Template exposure, warped to match the science exposure.
639639
science : `lsst.afw.image.ExposureF`
640640
Science exposure to subtract from the template.
641-
selectSources : `lsst.afw.table.SourceCatalog`
642-
Identified sources on the science exposure. This catalog is used to
643-
select sources in order to perform the AL PSF matching on stamp
644-
images around them.
641+
psfMatchingKernel : `lsst.afw.math.Kernel`
642+
Kernel to be used to PSF-match the science image to the template.
643+
backgroundModel : `lsst.afw.math.Function2D`, optional
644+
Background model that was fit while solving for the PSF-matching
645+
kernel.
645646
646647
Returns
647648
-------
@@ -685,10 +686,11 @@ def runConvolveScience(self, template, science, psfMatchingKernel, backgroundMod
685686
Template exposure, warped to match the science exposure.
686687
science : `lsst.afw.image.ExposureF`
687688
Science exposure to subtract from the template.
688-
selectSources : `lsst.afw.table.SourceCatalog`
689-
Identified sources on the science exposure. This catalog is used to
690-
select sources in order to perform the AL PSF matching on stamp
691-
images around them.
689+
psfMatchingKernel : `lsst.afw.math.Kernel`
690+
Kernel to be used to PSF-match the science image to the template.
691+
backgroundModel : `lsst.afw.math.Function2D`, optional
692+
Background model that was fit while solving for the PSF-matching
693+
kernel.
692694
693695
Returns
694696
-------
@@ -884,6 +886,9 @@ def _convolveExposure(self, exposure, kernel, convolutionControl,
884886
Point spread function (PSF) to set for the convolved exposure.
885887
photoCalib : `lsst.afw.image.PhotoCalib`, optional
886888
Photometric calibration of the convolved exposure.
889+
interpolateBadMaskPlanes : `bool`, optional
890+
If set, interpolate over mask planes specified in
891+
``config.badMaskPlanes`` before convolving the image.
887892
888893
Returns
889894
-------
@@ -1467,6 +1472,9 @@ def run(self, template, science, visitSummary=None, inputPsfMatchingKernel=None)
14671472
Exposure catalog with external calibrations to be applied. Catalog
14681473
uses the detector id for the catalog id, sorted on id for fast
14691474
lookup.
1475+
inputPsfMatchingKernel : `lsst.afw.math.Kernel`, optional
1476+
Pre-existing PSF matching kernel to use for convolution.
1477+
Required, and only used, if ``config.useExistingKernel`` is set.
14701478
14711479
Returns
14721480
-------

0 commit comments

Comments
 (0)