lsst.ip.diffim.subtractImages.SimplifiedSubtractConfig Class Reference
Inheritance diagram for lsst.ip.diffim.subtractImages.SimplifiedSubtractConfig:
Public Member Functions | |
| setDefaults (self) | |
Detailed Description
Definition at line 1512 of file subtractImages.py.
Member Function Documentation
◆ setDefaults()
|
inherited |
Definition at line 300 of file subtractImages.py.
Member Data Documentation
◆ allowKernelSourceDetection
|
staticinherited |
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 293 of file subtractImages.py.
◆ badMaskPlanes
|
staticinherited |
Initial value:
= lsst.pex.config.ListField(
dtype=str,
default=("NO_DATA", "BAD", "SAT", "EDGE"),
doc="Mask planes to interpolate over."
)
Definition at line 277 of file subtractImages.py.
◆ decorrelate
|
staticinherited |
Initial value:
= lsst.pex.config.ConfigurableField(
target=DecorrelateALKernelTask,
doc="Task to decorrelate the image difference.",
)
Definition at line 190 of file subtractImages.py.
◆ detectionThreshold
|
staticinherited |
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 242 of file subtractImages.py.
◆ detectionThresholdMax
|
staticinherited |
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 249 of file subtractImages.py.
◆ difference
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Result of subtracting convolved template from science image.",
dimensions=("instrument", "visit", "detector"),
storageClass="ExposureF",
name="{fakesType}{coaddName}Diff_differenceTempExp",
)
Definition at line 108 of file subtractImages.py.
◆ doApplyExternalCalibrations
|
staticinherited |
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 222 of file subtractImages.py.
◆ doDecorrelation
|
staticinherited |
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 184 of file subtractImages.py.
◆ doScaleVariance
|
staticinherited |
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=True,
doc="Scale variance of the image difference?"
)
Definition at line 207 of file subtractImages.py.
◆ doSubtractBackground
|
staticinherited |
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,
)
Definition at line 216 of file subtractImages.py.
◆ excludeMaskPlanes
|
staticinherited |
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 272 of file subtractImages.py.
◆ fallbackSourceSelector
|
staticinherited |
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 234 of file subtractImages.py.
◆ inputPsfMatchingKernel
|
staticinherited |
Initial value:
= connectionTypes.Input(
doc="Kernel used to PSF match the science and template images.",
dimensions=("instrument", "visit", "detector"),
storageClass="MatchingKernel",
name="{fakesType}{coaddName}Diff_psfMatchKernel",
)
Definition at line 162 of file subtractImages.py.
◆ kernelSources
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Final selection of sources used for psf matching.",
dimensions=("instrument", "visit", "detector"),
storageClass="SourceCatalog",
name="{fakesType}{coaddName}Diff_psfMatchSources"
)
Definition at line 126 of file subtractImages.py.
◆ makeKernel
|
staticinherited |
Initial value:
= lsst.pex.config.ConfigurableField(
target=MakeKernelTask,
doc="Task to construct a matching kernel for convolution.",
)
Definition at line 180 of file subtractImages.py.
◆ matchedTemplate
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Warped and PSF-matched template used to create `subtractedExposure`.",
dimensions=("instrument", "visit", "detector"),
storageClass="ExposureF",
name="{fakesType}{coaddName}Diff_matchedExp",
)
Definition at line 114 of file subtractImages.py.
◆ maxKernelSources
|
staticinherited |
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 261 of file subtractImages.py.
◆ minKernelSources
|
staticinherited |
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 267 of file subtractImages.py.
◆ minTemplateFractionForExpectedSuccess
|
staticinherited |
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 200 of file subtractImages.py.
◆ mode
|
static |
Initial value:
= lsst.pex.config.ChoiceField(
dtype=str,
default="convolveTemplate",
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 1514 of file subtractImages.py.
◆ preserveTemplateMask
|
staticinherited |
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 282 of file subtractImages.py.
◆ psfMatchingKernel
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Kernel used to PSF match the science and template images.",
dimensions=("instrument", "visit", "detector"),
storageClass="MatchingKernel",
name="{fakesType}{coaddName}Diff_psfMatchKernel",
)
Definition at line 120 of file subtractImages.py.
◆ renameTemplateMask
|
staticinherited |
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 287 of file subtractImages.py.
◆ requiredTemplateFraction
|
staticinherited |
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 194 of file subtractImages.py.
◆ restrictKernelEdgeSources
|
staticinherited |
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=True,
doc="Exclude sources close to the edge from the kernel calculation?"
)
Definition at line 256 of file subtractImages.py.
◆ scaleVariance
|
staticinherited |
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 212 of file subtractImages.py.
◆ science
|
staticinherited |
Initial value:
= connectionTypes.Input(
doc="Input science exposure to subtract from.",
dimensions=("instrument", "visit", "detector"),
storageClass="ExposureF",
name="{fakesType}calexp"
)
Definition at line 77 of file subtractImages.py.
◆ sources
|
staticinherited |
Initial value:
= connectionTypes.Input(
doc="Sources measured on the science exposure; "
"used to select sources for making the matching kernel.",
dimensions=("instrument", "visit", "detector"),
storageClass="SourceCatalog",
name="{fakesType}src"
)
Definition at line 83 of file subtractImages.py.
◆ sourceSelector
|
staticinherited |
Initial value:
= lsst.pex.config.ConfigurableField(
target=ScienceSourceSelectorTask,
doc="Task to select sources to be used for PSF matching.",
)
Definition at line 230 of file subtractImages.py.
◆ template
|
staticinherited |
Initial value:
= connectionTypes.Input(
doc="Input warped template to subtract.",
dimensions=("instrument", "visit", "detector"),
storageClass="ExposureF",
name="{fakesType}{coaddName}Diff_templateExp"
)
Definition at line 71 of file subtractImages.py.
◆ useExistingKernel
|
static |
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=True,
doc="Use a pre-existing PSF matching kernel?"
"If False, source detection and measurement will be run."
)
Definition at line 1522 of file subtractImages.py.
◆ visitSummary
|
staticinherited |
Initial value:
= connectionTypes.Input(
doc=("Per-visit catalog with final calibration objects. "
"These catalogs use the detector id for the catalog id, "
"sorted on id for fast lookup."),
dimensions=("instrument", "visit"),
storageClass="ExposureCatalog",
name="finalVisitSummary",
)
Definition at line 90 of file subtractImages.py.
The documentation for this class was generated from the following file:
- python/lsst/ip/diffim/subtractImages.py
Generated on Thu May 7 2026 08:35:39 for lsst.ip.diffim by
1.13.2