Skip to content

DM-51462: Include science mask plane in template coverage check #414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
isullivan merged 1 commit into from
Jun 19, 2025
Merged

DM-51462: Include science mask plane in template coverage check #414

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions python/lsst/ip/diffim/subtractImages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ def run(self, template, science, sources, visitSummary=None):
except (RuntimeError, lsst.pex.exceptions.Exception) as e:
self.log.warning("Failed to match template. Checking coverage")
# Raise NoWorkFound if template fraction is insufficient
checkTemplateIsSufficient(template[science.getBBox()], self.log,
checkTemplateIsSufficient(template[science.getBBox()], science, self.log,
self.config.minTemplateFractionForExpectedSuccess,
exceptionMessage="Template coverage lower than expected to succeed."
f" Failure is tolerable: {e}")
Expand Down Expand Up @@ -835,7 +835,7 @@ def _prepareInputs(self, template, science, visitSummary=None):
if visitSummary is not None:
self._applyExternalCalibrations(science, visitSummary=visitSummary)
templateCoverageFraction = checkTemplateIsSufficient(
template[science.getBBox()], self.log,
template[science.getBBox()], science, self.log,
requiredTemplateFraction=self.config.requiredTemplateFraction,
exceptionMessage="Not attempting subtraction. To force subtraction,"
" set config requiredTemplateFraction=0"
Expand Down Expand Up @@ -1044,7 +1044,7 @@ def run(self, template, science, sources, visitSummary=None):
except (RuntimeError, lsst.pex.exceptions.Exception) as e:
self.log.warning("Failed to match template. Checking coverage")
# Raise NoWorkFound if template fraction is insufficient
checkTemplateIsSufficient(template[science.getBBox()], self.log,
checkTemplateIsSufficient(template[science.getBBox()], science, self.log,
self.config.minTemplateFractionForExpectedSuccess,
exceptionMessage="Template coverage lower than expected to succeed."
f" Failure is tolerable: {e}")
Expand Down Expand Up @@ -1129,7 +1129,7 @@ def runPreconvolve(self, template, science, matchedScience, selectSources, preCo
kernelSources=kernelSources)


def checkTemplateIsSufficient(templateExposure, logger, requiredTemplateFraction=0.,
def checkTemplateIsSufficient(templateExposure, scienceExposure, logger, requiredTemplateFraction=0.,
exceptionMessage=""):
"""Raise NoWorkFound if template coverage < requiredTemplateFraction

Expand Down Expand Up @@ -1159,8 +1159,11 @@ def checkTemplateIsSufficient(templateExposure, logger, requiredTemplateFraction
"""
# Count the number of pixels with the NO_DATA mask bit set
# counting NaN pixels is insufficient because pixels without data are often intepolated over)
pixNoData = np.count_nonzero(templateExposure.mask.array
& templateExposure.mask.getPlaneBitMask('NO_DATA'))
noTemplate = templateExposure.mask.array & templateExposure.mask.getPlaneBitMask('NO_DATA')
# Also need to account for missing data in the science image,
# because template coverage there doesn't help
noScience = scienceExposure.mask.array & scienceExposure.mask.getPlaneBitMask('NO_DATA')
pixNoData = np.count_nonzero(noTemplate | noScience)
pixGood = templateExposure.getBBox().getArea() - pixNoData
templateCoverageFraction = pixGood/templateExposure.getBBox().getArea()
logger.info("template has %d good pixels (%.1f%%)", pixGood, 100*templateCoverageFraction)
Expand Down