lsst.ip.diffim g36da64cc00+ea84795170
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
lsst.ip.diffim.makeKernel.MakeKernelTask Class Reference
Inheritance diagram for lsst.ip.diffim.makeKernel.MakeKernelTask:
lsst.ip.diffim.psfMatch.PsfMatchTask

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 run (self, template, science, kernelSources, preconvolved=False)
 
 selectKernelSources (self, template, science, candidateList=None, preconvolved=False)
 
 getSelectSources (self, exposure, sigma=None, doSmooth=True, idFactory=None)
 
 makeCandidateList (self, convolved, reference, kernelSize, candidateList, preconvolved=False)
 
 makeKernelBasisList (self, targetFwhmPix=None, referenceFwhmPix=None, basisDegGauss=None, basisSigmaGauss=None, metadata=None)
 

Public Attributes

 kConfig
 
 background
 
 selectSchema
 
 selectAlgMetadata
 

Static Public Attributes

 ConfigClass = MakeKernelConfig
 

Protected Member Functions

 _buildCellSet (self, convolved, reference, candidateList)
 
 _adaptCellSize (self, candidateList)
 

Static Protected Attributes

str _DefaultName = "makeALKernel"
 

Detailed Description

Construct a kernel for PSF matching two exposures.

Definition at line 89 of file makeKernel.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.ip.diffim.makeKernel.MakeKernelTask.__init__ ( self,
* args,
** kwargs )
Create the psf-matching Task

Parameters
----------
*args
    Arguments to be passed to ``lsst.pipe.base.task.Task.__init__``
**kwargs
    Keyword arguments to be passed to ``lsst.pipe.base.task.Task.__init__``

Notes
-----
The initialization sets the Psf-matching kernel configuration using the value of
self.config.kernel.active.  If the kernel is requested with regularization to moderate
the bias/variance tradeoff, currently only used when a delta function kernel basis
is provided, it creates a regularization matrix stored as member variable
self.hMat.

Reimplemented from lsst.ip.diffim.psfMatch.PsfMatchTask.

Definition at line 96 of file makeKernel.py.

Member Function Documentation

◆ _adaptCellSize()

lsst.ip.diffim.makeKernel.MakeKernelTask._adaptCellSize ( self,
candidateList )
protected
NOT IMPLEMENTED YET.

Parameters
----------
candidateList : `list`
    A list of footprints/maskedImages for kernel candidates;

Returns
-------
sizeCellX, sizeCellY : `int`
    New dimensions to use for the kernel.

Definition at line 431 of file makeKernel.py.

◆ _buildCellSet()

lsst.ip.diffim.makeKernel.MakeKernelTask._buildCellSet ( self,
convolved,
reference,
candidateList )
protected
Build a SpatialCellSet for use with the solve method.

Parameters
----------
convolved : `lsst.afw.image.MaskedImage`
    MaskedImage to PSF-matched to reference.
reference : `lsst.afw.image.MaskedImage`
    Reference MaskedImage.
candidateList : `lsst.afw.table.SourceCatalog`
    Kernel candidate sources with footprints.

Returns
-------
kernelCellSet : `lsst.afw.math.SpatialCellSet`
    A SpatialCellSet for use with self._solve.

Reimplemented from lsst.ip.diffim.psfMatch.PsfMatchTask.

Definition at line 386 of file makeKernel.py.

◆ getSelectSources()

lsst.ip.diffim.makeKernel.MakeKernelTask.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`, optional
    PSF sigma, in pixels, used for smoothing the image for detection.
    If `None`, the PSF width will be used.
doSmooth : `bool`
    Whether or not to smooth the Exposure with Psf before detection
idFactory : `lsst.afw.table.IdFactory`
    Factory for the generation of Source ids

Returns
-------
selectSources :
    source catalog containing candidates for the Psf-matching

Definition at line 214 of file makeKernel.py.

◆ makeCandidateList()

lsst.ip.diffim.makeKernel.MakeKernelTask.makeCandidateList ( self,
convolved,
reference,
kernelSize,
candidateList,
preconvolved = False )
Make a list of acceptable KernelCandidates.

Generate a list of candidate sources for Psf-matching, remove sources
with bad pixel masks set or that extend off the image.

Parameters
----------
convolved : `lsst.afw.image.Exposure`
    Exposure that will be convolved. This is typically the template
    image, and may have a large bbox than the reference exposure.
reference : `lsst.afw.image.Exposure`
    Exposure that will be matched-to. This is typically the science
    image.
kernelSize : `float`
    Dimensions of the Psf-matching Kernel, used to set detection
    footprints.
candidateList : `lsst.afw.table.SourceCatalog`
    List of Sources to examine for kernel candidacy.
preconvolved : `bool`, optional
    Was the science exposure already convolved with its PSF?

Returns
-------
candidates : `lsst.afw.table.SourceCatalog`
    Candidates with footprints extended to a ``kernelSize`` box.

Raises
------
RuntimeError
    If ``candidateList`` is empty after sub-selection.

Definition at line 275 of file makeKernel.py.

◆ makeKernelBasisList()

lsst.ip.diffim.makeKernel.MakeKernelTask.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 343 of file makeKernel.py.

◆ run()

lsst.ip.diffim.makeKernel.MakeKernelTask.run ( self,
template,
science,
kernelSources,
preconvolved = False )
Solve for the kernel and background model that best match two
Exposures evaluated at the given source locations.

Parameters
----------
template : `lsst.afw.image.Exposure`
    Exposure that will be convolved.
science : `lsst.afw.image.Exposure`
    The exposure that will be matched.
kernelSources : `lsst.afw.table.SourceCatalog`
    Kernel candidate sources with appropriately sized footprints.
    Typically the output of `MakeKernelTask.selectKernelSources`.
preconvolved : `bool`, optional
    Was the science image convolved with its own PSF?

Returns
-------
results : `lsst.pipe.base.Struct`

    ``psfMatchingKernel`` : `lsst.afw.math.LinearCombinationKernel`
        Spatially varying Psf-matching kernel.
    ``backgroundModel``  : `lsst.afw.math.Function2D`
        Spatially varying background-matching function.

Definition at line 108 of file makeKernel.py.

◆ selectKernelSources()

lsst.ip.diffim.makeKernel.MakeKernelTask.selectKernelSources ( self,
template,
science,
candidateList = None,
preconvolved = False )
Select sources from a list of candidates, and extract footprints.

Parameters
----------
template : `lsst.afw.image.Exposure`
    Exposure that will be convolved.
science : `lsst.afw.image.Exposure`
    The exposure that will be matched.
candidateList : `lsst.afw.table.SourceCatalog`
    Sources to check as possible kernel candidates.
preconvolved : `bool`, optional
    Was the science image convolved with its own PSF?

Returns
-------
kernelSources : `lsst.afw.table.SourceCatalog`
    Kernel candidates with appropriate sized footprints.

Definition at line 166 of file makeKernel.py.

Member Data Documentation

◆ _DefaultName

str lsst.ip.diffim.makeKernel.MakeKernelTask._DefaultName = "makeALKernel"
staticprotected

Definition at line 94 of file makeKernel.py.

◆ background

lsst.ip.diffim.makeKernel.MakeKernelTask.background

Definition at line 101 of file makeKernel.py.

◆ ConfigClass

lsst.ip.diffim.makeKernel.MakeKernelTask.ConfigClass = MakeKernelConfig
static

Definition at line 93 of file makeKernel.py.

◆ kConfig

lsst.ip.diffim.makeKernel.MakeKernelTask.kConfig

Definition at line 98 of file makeKernel.py.

◆ selectAlgMetadata

lsst.ip.diffim.makeKernel.MakeKernelTask.selectAlgMetadata

Definition at line 104 of file makeKernel.py.

◆ selectSchema

lsst.ip.diffim.makeKernel.MakeKernelTask.selectSchema

Definition at line 103 of file makeKernel.py.


The documentation for this class was generated from the following file: