lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig Class Reference
Inheritance diagram for lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig:
Public Member Functions | |
| setDefaults (self) | |
| validate (self) | |
Detailed Description
Definition at line 210 of file subtractImages.py.
Member Function Documentation
◆ setDefaults()
| lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.setDefaults | ( | self | ) |
Definition at line 351 of file subtractImages.py.
◆ validate()
| lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.validate | ( | self | ) |
Definition at line 382 of file subtractImages.py.
Member Data Documentation
◆ allowKernelSourceDetection
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=False,
doc="Re-run source detection for kernel candidates if an error is"
" encountered while calculating the matching kernel."
)
Definition at line 331 of file subtractImages.py.
◆ badMaskPlanes
|
static |
Initial value:
= lsst.pex.config.ListField(
dtype=str,
default=("NO_DATA", "BAD", "SAT", "EDGE"),
doc="Mask planes to interpolate over."
)
Definition at line 310 of file subtractImages.py.
◆ decorrelate
|
static |
Initial value:
= lsst.pex.config.ConfigurableField(
target=DecorrelateALKernelTask,
doc="Task to decorrelate the image difference.",
)
Definition at line 221 of file subtractImages.py.
◆ detectionThreshold
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=float,
default=10,
doc="Minimum signal to noise ratio of detected sources "
"to use for calculating the PSF matching kernel.",
deprecated="No longer used. Will be removed after v30"
)
Definition at line 275 of file subtractImages.py.
◆ detectionThresholdMax
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=float,
default=500,
doc="Maximum signal to noise ratio of detected sources "
"to use for calculating the PSF matching kernel.",
deprecated="No longer used. Will be removed after v30"
)
Definition at line 282 of file subtractImages.py.
◆ doApplyExternalCalibrations
|
static |
Initial value:
= lsst.pex.config.Field(
doc=(
"Replace science Exposure's calibration objects with those"
" in visitSummary. Ignored if `doApplyFinalizedPsf is True."
),
dtype=bool,
default=False,
)
Definition at line 255 of file subtractImages.py.
◆ 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 215 of file subtractImages.py.
◆ doScaleVariance
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=True,
doc="Scale variance of the science image? Note that the template variance is NOT scaled"
" here. The template variance may be scaled independently in ``GetTemplateTask``."
)
Definition at line 238 of file subtractImages.py.
◆ doSubtractBackground
|
static |
Initial value:
= lsst.pex.config.Field(
doc="Subtract the background fit when solving the kernel? "
"It is generally better to instead subtract the background in detectAndMeasure.",
dtype=bool,
default=False,
deprecated="Subtract the background in detectAndMeasure instead. Will be removed after v31.",
)
Definition at line 248 of file subtractImages.py.
◆ excludeMaskPlanes
|
static |
Initial value:
= lsst.pex.config.ListField(
dtype=str,
default=("NO_DATA", "BAD", "SAT", "EDGE", "FAKE", "HIGH_VARIANCE"),
doc="Template mask planes to exclude when selecting sources for PSF matching.",
)
Definition at line 305 of file subtractImages.py.
◆ fallbackSourceSelector
|
static |
Initial value:
= lsst.pex.config.ConfigurableField(
target=ScienceSourceSelectorTask,
doc="Task to select sources to be used for PSF matching."
"Used only if the kernel calculation fails and"
"`allowKernelSourceDetection` is set. The fallback source detection"
" will not include all of the same plugins as the original source "
" detection, so not all of the same flags can be used.",
)
Definition at line 267 of file subtractImages.py.
◆ image_type
|
static |
Initial value:
= lsst.pex.config.ChoiceField[str](
doc="Image type of the input template, the image outputs of this"
" task (difference and matchedTemplate, or scoreExposure), and the PSF"
" matching kernel.",
allowed={
"legacy": "Read and write lsst.afw.image.ExposureF and"
" lsst.afw.math.Kernel.",
"future": "Read and write lsst.images.DifferenceImage and"
" lsst.images.convolution_kernels.ConvolutionKernel.",
},
optional=False,
default="legacy",
)
Definition at line 337 of file subtractImages.py.
◆ makeKernel
|
static |
Initial value:
= lsst.pex.config.ConfigurableField(
target=MakeKernelTask,
doc="Task to construct a matching kernel for convolution.",
)
Definition at line 211 of file subtractImages.py.
◆ maxKernelSources
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=int,
default=1000,
doc="Maximum number of sources to use for calculating the PSF matching kernel."
"Set to -1 to disable."
)
Definition at line 294 of file subtractImages.py.
◆ minKernelSources
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=int,
default=3,
doc="Minimum number of sources needed for calculating the PSF matching kernel."
)
Definition at line 300 of file subtractImages.py.
◆ minTemplateFractionForExpectedSuccess
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=float,
default=0.2,
doc="Raise NoWorkFound if PSF-matching fails and template covers less than this fraction of pixels."
" If the fraction of pixels covered by the template is less than this value (and greater than"
" requiredTemplateFraction) this task is attempted but failure is anticipated and tolerated."
)
Definition at line 231 of file subtractImages.py.
◆ preserveMaskPlanes
|
static |
Initial value:
= lsst.pex.config.ListField(
dtype=str,
default=("INJECTED", "INJECTED_CORE", "INJECTED_TEMPLATE", "INJECTED_CORE_TEMPLATE"),
doc="Mask planes to preserve without dilation when convolving the image.",
)
Definition at line 326 of file subtractImages.py.
◆ preserveTemplateMask
|
static |
Initial value:
= lsst.pex.config.ListField(
dtype=str,
default=("NO_DATA", "BAD", "HIGH_VARIANCE"),
doc="Mask planes from the template to propagate to the image difference."
)
Definition at line 315 of file subtractImages.py.
◆ renameTemplateMask
|
static |
Initial value:
= lsst.pex.config.ListField(
dtype=str,
default=("SAT", "INJECTED", "INJECTED_CORE",),
doc="Mask planes from the template to propagate to the image difference"
"with '_TEMPLATE' appended to the name."
)
Definition at line 320 of file subtractImages.py.
◆ requiredTemplateFraction
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=float,
default=0.1,
doc="Raise NoWorkFound and do not attempt image subtraction if template covers less than this "
" fraction of pixels. Setting to 0 will always attempt image subtraction."
)
Definition at line 225 of file subtractImages.py.
◆ restrictKernelEdgeSources
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=True,
doc="Exclude sources close to the edge from the kernel calculation?"
)
Definition at line 289 of file subtractImages.py.
◆ 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 244 of file subtractImages.py.
◆ sourceSelector
|
static |
Initial value:
= lsst.pex.config.ConfigurableField(
target=ScienceSourceSelectorTask,
doc="Task to select sources to be used for PSF matching.",
)
Definition at line 263 of file subtractImages.py.
The documentation for this class was generated from the following file:
- python/lsst/ip/diffim/subtractImages.py
Generated on for lsst.ip.diffim by
1.18.0