lsst.ip.diffim gfaa7bcd731+f5cb109e8e
|
Public Member Functions | |
def | __init__ (self, *args, **kwargs) |
def | matchExposures (self, templateExposure, scienceExposure, templateFwhmPix=None, scienceFwhmPix=None, candidateList=None, doWarping=True, convolveTemplate=True) |
def | matchMaskedImages (self, templateMaskedImage, scienceMaskedImage, candidateList, templateFwhmPix=None, scienceFwhmPix=None) |
def | subtractExposures (self, templateExposure, scienceExposure, templateFwhmPix=None, scienceFwhmPix=None, candidateList=None, doWarping=True, convolveTemplate=True) |
def | subtractMaskedImages (self, templateMaskedImage, scienceMaskedImage, candidateList, templateFwhmPix=None, scienceFwhmPix=None) |
def | getSelectSources (self, exposure, sigma=None, doSmooth=True, idFactory=None) |
def | makeCandidateList (self, templateExposure, scienceExposure, kernelSize, candidateList=None) |
def | makeKernelBasisList (self, targetFwhmPix=None, referenceFwhmPix=None, basisDegGauss=None, basisSigmaGauss=None, metadata=None) |
Public Attributes | |
kConfig | |
background | |
selectSchema | |
selectAlgMetadata | |
Static Public Attributes | |
ConfigClass = ImagePsfMatchConfig | |
Psf-match two MaskedImages or Exposures using the sources in the images. Parameters ---------- args : Arguments to be passed to lsst.ip.diffim.PsfMatchTask.__init__ kwargs : Keyword arguments to be passed to lsst.ip.diffim.PsfMatchTask.__init__
Definition at line 82 of file imagePsfMatch.py.
def lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.__init__ | ( | self, | |
* | args, | ||
** | kwargs | ||
) |
Create the ImagePsfMatchTask.
Reimplemented from lsst.ip.diffim.psfMatch.PsfMatchTask.
Reimplemented in lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.
Definition at line 96 of file imagePsfMatch.py.
def lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.getSelectSources | ( | self, | |
exposure, | |||
sigma = None , |
|||
doSmooth = True , |
|||
idFactory = None |
|||
) |
Get sources to use for Psf-matching. This method runs detection and measurement on an exposure. The returned set of sources will be used as candidates for Psf-matching. Parameters ---------- exposure : `lsst.afw.image.Exposure` Exposure on which to run detection/measurement sigma : `float` Detection threshold doSmooth : `bool` Whether or not to smooth the Exposure with Psf before detection idFactory : Factory for the generation of Source ids Returns ------- selectSources : source catalog containing candidates for the Psf-matching
Definition at line 531 of file imagePsfMatch.py.
def lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.makeCandidateList | ( | self, | |
templateExposure, | |||
scienceExposure, | |||
kernelSize, | |||
candidateList = None |
|||
) |
Make a list of acceptable KernelCandidates. Accept or generate a list of candidate sources for Psf-matching, and examine the Mask planes in both of the images for indications of bad pixels Parameters ---------- templateExposure : `lsst.afw.image.Exposure` Exposure that will be convolved scienceExposure : `lsst.afw.image.Exposure` Exposure that will be matched-to kernelSize : `float` Dimensions of the Psf-matching Kernel, used to grow detection footprints candidateList : `list`, optional List of Sources to examine. Elements must be of type afw.table.Source or a type that wraps a Source and has a getSource() method, such as meas.algorithms.PsfCandidateF. Returns ------- candidateList : `list` of `dict` A list of dicts having a "source" and "footprint" field for the Sources deemed to be appropriate for Psf matching
Definition at line 589 of file imagePsfMatch.py.
def lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.makeKernelBasisList | ( | self, | |
targetFwhmPix = None , |
|||
referenceFwhmPix = None , |
|||
basisDegGauss = None , |
|||
basisSigmaGauss = None , |
|||
metadata = None |
|||
) |
Wrapper to set log messages for `lsst.ip.diffim.makeKernelBasisList`. Parameters ---------- targetFwhmPix : `float`, optional Passed on to `lsst.ip.diffim.generateAlardLuptonBasisList`. Not used for delta function basis sets. referenceFwhmPix : `float`, optional Passed on to `lsst.ip.diffim.generateAlardLuptonBasisList`. Not used for delta function basis sets. basisDegGauss : `list` of `int`, optional Passed on to `lsst.ip.diffim.generateAlardLuptonBasisList`. Not used for delta function basis sets. basisSigmaGauss : `list` of `int`, optional Passed on to `lsst.ip.diffim.generateAlardLuptonBasisList`. Not used for delta function basis sets. metadata : `lsst.daf.base.PropertySet`, optional Passed on to `lsst.ip.diffim.generateAlardLuptonBasisList`. Not used for delta function basis sets. Returns ------- basisList: `list` of `lsst.afw.math.kernel.FixedKernel` List of basis kernels.
Definition at line 645 of file imagePsfMatch.py.
def lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.matchExposures | ( | self, | |
templateExposure, | |||
scienceExposure, | |||
templateFwhmPix = None , |
|||
scienceFwhmPix = None , |
|||
candidateList = None , |
|||
doWarping = True , |
|||
convolveTemplate = True |
|||
) |
Warp and PSF-match an exposure to the reference. Do the following, in order: - Warp templateExposure to match scienceExposure, if doWarping True and their WCSs do not already match - Determine a PSF matching kernel and differential background model that matches templateExposure to scienceExposure - Convolve templateExposure by PSF matching kernel Parameters ---------- templateExposure : `lsst.afw.image.Exposure` Exposure to warp and PSF-match to the reference masked image scienceExposure : `lsst.afw.image.Exposure` Exposure whose WCS and PSF are to be matched to 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` Whether to 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 ------- results : `lsst.pipe.base.Struct` An `lsst.pipe.base.Struct` containing these fields: - ``matchedImage`` : the PSF-matched exposure = Warped ``templateExposure`` convolved by psfMatchingKernel. This has: - the same parent bbox, Wcs and PhotoCalib as scienceExposure - the same filter as templateExposure - no Psf (because the PSF-matching process does not compute one) - ``psfMatchingKernel`` : the PSF matching kernel - ``backgroundModel`` : differential background model - ``kernelCellSet`` : SpatialCellSet used to solve for the PSF matching kernel Raises ------ RuntimeError Raised if doWarping is False and ``templateExposure`` and ``scienceExposure`` WCSs do not match
Definition at line 112 of file imagePsfMatch.py.
def lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.matchMaskedImages | ( | self, | |
templateMaskedImage, | |||
scienceMaskedImage, | |||
candidateList, | |||
templateFwhmPix = None , |
|||
scienceFwhmPix = None |
|||
) |
PSF-match a MaskedImage (templateMaskedImage) to a reference MaskedImage (scienceMaskedImage). Do the following, in order: - Determine a PSF matching kernel and differential background model that matches templateMaskedImage to scienceMaskedImage - Convolve templateMaskedImage by the PSF matching kernel Parameters ---------- templateMaskedImage : `lsst.afw.image.MaskedImage` masked image to PSF-match to the reference masked image; must be warped to match the reference masked image scienceMaskedImage : `lsst.afw.image.MaskedImage` maskedImage whose PSF is to be matched to 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 ------- result : `callable` An `lsst.pipe.base.Struct` containing these fields: - psfMatchedMaskedImage: the PSF-matched masked image = ``templateMaskedImage`` convolved with psfMatchingKernel. This has the same xy0, dimensions and wcs as ``scienceMaskedImage``. - psfMatchingKernel: the PSF matching kernel - backgroundModel: differential background model - kernelCellSet: SpatialCellSet used to solve for the PSF matching kernel Raises ------ RuntimeError Raised if input images have different dimensions
Definition at line 230 of file imagePsfMatch.py.
def lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.subtractExposures | ( | self, | |
templateExposure, | |||
scienceExposure, | |||
templateFwhmPix = None , |
|||
scienceFwhmPix = None , |
|||
candidateList = None , |
|||
doWarping = True , |
|||
convolveTemplate = True |
|||
) |
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 in lsst.ip.diffim.zogy.ZogyImagePsfMatchTask, and lsst.ip.diffim.snapPsfMatch.SnapPsfMatchTask.
Definition at line 343 of file imagePsfMatch.py.
def lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.subtractMaskedImages | ( | self, | |
templateMaskedImage, | |||
scienceMaskedImage, | |||
candidateList, | |||
templateFwhmPix = None , |
|||
scienceFwhmPix = None |
|||
) |
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 in lsst.ip.diffim.zogy.ZogyImagePsfMatchTask.
Definition at line 461 of file imagePsfMatch.py.
lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.background |
Definition at line 104 of file imagePsfMatch.py.
|
static |
Definition at line 94 of file imagePsfMatch.py.
lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.kConfig |
Definition at line 100 of file imagePsfMatch.py.
lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.selectAlgMetadata |
Definition at line 107 of file imagePsfMatch.py.
lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask.selectSchema |
Definition at line 106 of file imagePsfMatch.py.