Task to perform Zogy PSF matching and image subtraction.
This class inherits from ImagePsfMatchTask to contain the _warper
subtask and related methods.
Definition at line 1269 of file zogy.py.
def lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.run |
( |
|
self, |
|
|
|
scienceExposure, |
|
|
|
templateExposure, |
|
|
|
doWarping = True |
|
) |
| |
Register, PSF-match, and subtract two Exposures, ``scienceExposure - templateExposure``
using the ZOGY algorithm.
Parameters
----------
templateExposure : `lsst.afw.image.Exposure`
exposure to be warped to scienceExposure.
scienceExposure : `lsst.afw.image.Exposure`
reference Exposure.
doWarping : `bool`
what to do if templateExposure's and scienceExposure's WCSs do not match:
- if True then warp templateExposure to match scienceExposure
- if False then raise an Exception
Notes
-----
Do the following, in order:
- Warp templateExposure to match scienceExposure, if their WCSs do not already match
- Compute subtracted exposure ZOGY image subtraction algorithm on the two exposures
This is the new entry point of the task as of DM-25115.
Returns
-------
results : `lsst.pipe.base.Struct` containing these fields:
- subtractedExposure: `lsst.afw.image.Exposure`
The subtraction result.
- warpedExposure: `lsst.afw.image.Exposure` or `None`
templateExposure after warping to match scienceExposure
Definition at line 1281 of file zogy.py.
def lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.subtractExposures |
( |
|
self, |
|
|
|
templateExposure, |
|
|
|
scienceExposure, |
|
|
* |
templateFwhmPix |
|
) |
| |
Register, Psf-match and subtract two Exposures.
Do the following, in order:
- Warp templateExposure to match scienceExposure, if their WCSs do not already match
- Determine a PSF matching kernel and differential background model
that matches templateExposure to scienceExposure
- PSF-match templateExposure to scienceExposure
- Compute subtracted exposure (see return values for equation).
Parameters
----------
templateExposure : `lsst.afw.image.ExposureF`
Exposure to PSF-match to scienceExposure
scienceExposure : `lsst.afw.image.ExposureF`
Reference Exposure
templateFwhmPix : `float`
FWHM (in pixels) of the Psf in the template image (image to convolve)
scienceFwhmPix : `float`
FWHM (in pixels) of the Psf in the science image
candidateList : `list`, optional
A list of footprints/maskedImages for kernel candidates;
if `None` then source detection is run.
- Currently supported: list of Footprints or measAlg.PsfCandidateF
doWarping : `bool`
What to do if ``templateExposure``` and ``scienceExposure`` WCSs do
not match:
- if `True` then warp ``templateExposure`` to match ``scienceExposure``
- if `False` then raise an Exception
convolveTemplate : `bool`
Convolve the template image or the science image
- if `True`, ``templateExposure`` is warped if doWarping,
``templateExposure`` is convolved
- if `False`, ``templateExposure`` is warped if doWarping,
``scienceExposure is`` convolved
Returns
-------
result : `lsst.pipe.base.Struct`
An `lsst.pipe.base.Struct` containing these fields:
- ``subtractedExposure`` : subtracted Exposure
scienceExposure - (matchedImage + backgroundModel)
- ``matchedImage`` : ``templateExposure`` after warping to match
``templateExposure`` (if doWarping true),
and convolving with psfMatchingKernel
- ``psfMatchingKernel`` : PSF matching kernel
- ``backgroundModel`` : differential background model
- ``kernelCellSet`` : SpatialCellSet used to determine PSF matching kernel
Reimplemented from lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.
Definition at line 1331 of file zogy.py.
def lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.subtractMaskedImages |
( |
|
self, |
|
|
|
templateMaskedImage, |
|
|
|
scienceMaskedImage, |
|
|
* |
candidateList |
|
) |
| |
Psf-match and subtract two MaskedImages.
Do the following, in order:
- PSF-match templateMaskedImage to scienceMaskedImage
- Determine the differential background
- Return the difference: scienceMaskedImage
((warped templateMaskedImage convolved with psfMatchingKernel) + backgroundModel)
Parameters
----------
templateMaskedImage : `lsst.afw.image.MaskedImage`
MaskedImage to PSF-match to ``scienceMaskedImage``
scienceMaskedImage : `lsst.afw.image.MaskedImage`
Reference MaskedImage
templateFwhmPix : `float`
FWHM (in pixels) of the Psf in the template image (image to convolve)
scienceFwhmPix : `float`
FWHM (in pixels) of the Psf in the science image
candidateList : `list`, optional
A list of footprints/maskedImages for kernel candidates;
if `None` then source detection is run.
- Currently supported: list of Footprints or measAlg.PsfCandidateF
Returns
-------
results : `lsst.pipe.base.Struct`
An `lsst.pipe.base.Struct` containing these fields:
- ``subtractedMaskedImage`` : ``scienceMaskedImage`` - (matchedImage + backgroundModel)
- ``matchedImage`` : templateMaskedImage convolved with psfMatchingKernel
- `psfMatchingKernel`` : PSF matching kernel
- ``backgroundModel`` : differential background model
- ``kernelCellSet`` : SpatialCellSet used to determine PSF matching kernel
Reimplemented from lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.
Definition at line 1334 of file zogy.py.