Skip to content

Commit

Permalink
Clean up docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
isullivan committed Mar 11, 2024
1 parent 4821d48 commit bb107ec
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
16 changes: 8 additions & 8 deletions python/lsst/ip/diffim/detectAndMeasure.py
Original file line number Diff line number Diff line change
Expand Up @@ -304,21 +304,21 @@ def processResults(self, science, matchedTemplate, difference, sources, table,
Parameters
----------
sources : `lsst.afw.table.SourceCatalog`
Detected sources on the difference exposure.
positiveFootprints : `lsst.afw.detection.FootprintSet`, optional
Positive polarity footprints.
negativeFootprints : `lsst.afw.detection.FootprintSet`, optional
Negative polarity footprints.
table : `lsst.afw.table.SourceTable`
Table object that will be used to create the SourceCatalog.
science : `lsst.afw.image.ExposureF`
Science exposure that the template was subtracted from.
matchedTemplate : `lsst.afw.image.ExposureF`
Warped and PSF-matched template that was used produce the
difference image.
difference : `lsst.afw.image.ExposureF`
Result of subtracting template from the science image.
sources : `lsst.afw.table.SourceCatalog`
Detected sources on the difference exposure.
table : `lsst.afw.table.SourceTable`
Table object that will be used to create the SourceCatalog.
positiveFootprints : `lsst.afw.detection.FootprintSet`, optional
Positive polarity footprints.
negativeFootprints : `lsst.afw.detection.FootprintSet`, optional
Negative polarity footprints.
Returns
-------
Expand Down
4 changes: 3 additions & 1 deletion python/lsst/ip/diffim/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -1026,10 +1026,12 @@ def detectTestSources(exposure, addMaskPlanes=None):
exposure : `lsst.afw.image.Exposure`
Exposure on which to run detection/measurement
The exposure is modified in place to set the 'DETECTED' mask plane.
addMaskPlanes : `list` of `str`, optional
Additional mask planes to add to the maskedImage of the exposure.
Returns
-------
selectSources :
selectSources
Source catalog containing candidates
"""
if addMaskPlanes is None:
Expand Down

0 comments on commit bb107ec

Please sign in to comment.