lsst.ip.diffim gaa63f70f4e+5b0333f1f2
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig Class Reference
Inheritance diagram for lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig:
lsst.ip.diffim.subtractImages.AlardLuptonSubtractConnections lsst.ip.diffim.subtractImages.SubtractInputConnections lsst.ip.diffim.subtractImages.SubtractImageOutputConnections

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

 mode
 
 makeKernel
 
 doDecorrelation
 
 decorrelate
 
 requiredTemplateFraction
 
 doScaleVariance
 
 scaleVariance
 
 doSubtractBackground
 
 forceCompatibility
 

Detailed Description

Definition at line 85 of file subtractImages.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 139 of file subtractImages.py.

◆ validate()

def lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig.validate (   self)

Definition at line 145 of file subtractImages.py.

Member Data Documentation

◆ decorrelate

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

Definition at line 105 of file subtractImages.py.

◆ doDecorrelation

lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig.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 99 of file subtractImages.py.

◆ doScaleVariance

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

Definition at line 115 of file subtractImages.py.

◆ doSubtractBackground

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

Definition at line 124 of file subtractImages.py.

◆ forceCompatibility

lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig.forceCompatibility
static
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=False,
doc="Set up and run diffim using settings that ensure the results"
"are compatible with the old version in pipe_tasks.",
deprecated="This option is only for backwards compatibility purposes"
" and will be removed after v24.",
)

Definition at line 130 of file subtractImages.py.

◆ makeKernel

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

Definition at line 95 of file subtractImages.py.

◆ mode

lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig.mode
static
Initial value:
= lsst.pex.config.ChoiceField(
dtype=str,
default="auto",
allowed={"auto": "Choose which image to convolve at runtime.",
"convolveScience": "Only convolve the science image.",
"convolveTemplate": "Only convolve the template image."},
doc="Choose which image to convolve at runtime, or require that a specific image is convolved."
)

Definition at line 87 of file subtractImages.py.

◆ requiredTemplateFraction

lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig.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 109 of file subtractImages.py.

◆ scaleVariance

lsst.ip.diffim.subtractImages.AlardLuptonSubtractConfig.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 120 of file subtractImages.py.


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