lsst.ip.diffim g6dcab618d9+f2cad9e54d
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig Class Reference
Inheritance diagram for lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig:
lsst.ip.diffim.subtractImages.AlardLuptonPreconvolveSubtractConfig lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

 makeKernel
 
 doDecorrelation
 
 decorrelate
 
 requiredTemplateFraction
 
 doScaleVariance
 
 scaleVariance
 
 doSubtractBackground
 
 doApplyFinalizedPsf
 
 detectionThreshold
 
 badSourceFlags
 
 badMaskPlanes
 

Detailed Description

Definition at line 112 of file subtractImages.py.

Member Function Documentation

◆ setDefaults()

def lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.setDefaults (   self)

Definition at line 172 of file subtractImages.py.

Member Data Documentation

◆ badMaskPlanes

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.badMaskPlanes
static
Initial value:
= lsst.pex.config.ListField(
dtype=str,
default=("NO_DATA", "BAD", "SAT", "EDGE"),
doc="Mask planes to exclude when selecting sources for PSF matching."
)

Definition at line 166 of file subtractImages.py.

◆ badSourceFlags

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.badSourceFlags
static
Initial value:
= lsst.pex.config.ListField(
dtype=str,
doc="Flags that, if set, the associated source should not "
"be used to determine the PSF matching kernel.",
default=("sky_source", "slot_Centroid_flag",
"slot_ApFlux_flag", "slot_PsfFlux_flag", ),
)

Definition at line 159 of file subtractImages.py.

◆ decorrelate

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.decorrelate
static
Initial value:
= lsst.pex.config.ConfigurableField(
target=DecorrelateALKernelTask,
doc="Task to decorrelate the image difference.",
)

Definition at line 123 of file subtractImages.py.

◆ detectionThreshold

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.detectionThreshold
static
Initial value:
= lsst.pex.config.Field(
dtype=float,
default=10,
doc="Minimum signal to noise ration of detected sources "
"to use for calculating the PSF matching kernel."
)

Definition at line 153 of file subtractImages.py.

◆ doApplyFinalizedPsf

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.doApplyFinalizedPsf
static
Initial value:
= lsst.pex.config.Field(
doc="Replace science Exposure's psf and aperture correction map"
" with those in finalizedPsfApCorrCatalog.",
dtype=bool,
default=False,
)

Definition at line 147 of file subtractImages.py.

◆ doDecorrelation

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.doDecorrelation
static
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=True,
doc="Perform diffim decorrelation to undo pixel correlation due to A&L "
"kernel convolution? If True, also update the diffim PSF."
)

Definition at line 117 of file subtractImages.py.

◆ doScaleVariance

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.doScaleVariance
static
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=True,
doc="Scale variance of the image difference?"
)

Definition at line 133 of file subtractImages.py.

◆ doSubtractBackground

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.doSubtractBackground
static
Initial value:
= lsst.pex.config.Field(
doc="Subtract the background fit when solving the kernel?",
dtype=bool,
default=True,
)

Definition at line 142 of file subtractImages.py.

◆ makeKernel

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.makeKernel
static
Initial value:
= lsst.pex.config.ConfigurableField(
target=MakeKernelTask,
doc="Task to construct a matching kernel for convolution.",
)

Definition at line 113 of file subtractImages.py.

◆ requiredTemplateFraction

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.requiredTemplateFraction
static
Initial value:
= lsst.pex.config.Field(
dtype=float,
default=0.1,
doc="Abort task if template covers less than this fraction of pixels."
" Setting to 0 will always attempt image subtraction."
)

Definition at line 127 of file subtractImages.py.

◆ scaleVariance

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.scaleVariance
static
Initial value:
= lsst.pex.config.ConfigurableField(
target=ScaleVarianceTask,
doc="Subtask to rescale the variance of the template to the statistically expected level."
)

Definition at line 138 of file subtractImages.py.


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