lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig Class Reference

Inheritance diagram for lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig:

Public Member Functions
	setDefaults (self)

Static Public Attributes
	makeKernel
	doDecorrelation
	decorrelate
	requiredTemplateFraction
	minTemplateFractionForExpectedSuccess
	doScaleVariance
	scaleVariance
	doSubtractBackground
	doApplyExternalCalibrations
	detectionThreshold
	detectionThresholdMax
	maxKernelSources
	minKernelSources
	badSourceFlags
	excludeMaskPlanes
	badMaskPlanes
	preserveTemplateMask
	renameTemplateMask
	allowKernelSourceDetection

Detailed Description

Definition at line 127 of file subtractImages.py.

Member Function Documentation

setDefaults()

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.setDefaults

(

self

)

Subclass hook for computing defaults.

Notes
-----
Derived `~lsst.pex.config.Config` classes that must compute defaults
rather than using the `~lsst.pex.config.Field` instances's defaults
should do so here. To correctly use inherited defaults,
implementations of ``setDefaults`` must call their base class's
``setDefaults``.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 239 of file subtractImages.py.

    def setDefaults(self):
        self.makeKernel.kernel.name = "AL"
        self.makeKernel.kernel.active.fitForBackground = self.doSubtractBackground
        self.makeKernel.kernel.active.spatialKernelOrder = 1
        self.makeKernel.kernel.active.spatialBgOrder = 2
 
 

Member Data Documentation

allowKernelSourceDetection

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

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 interpolate over."
    )

Definition at line 216 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",
                 "base_PixelFlags_flag_interpolated",
                 "base_PixelFlags_flag_saturated",
                 "base_PixelFlags_flag_bad",
                 ),
    )

Definition at line 200 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 138 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 ratio of detected sources "
        "to use for calculating the PSF matching kernel."
    )

Definition at line 177 of file subtractImages.py.

detectionThresholdMax

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.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."
    )

Definition at line 183 of file subtractImages.py.

doApplyExternalCalibrations

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.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 169 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 132 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 155 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 164 of file subtractImages.py.

excludeMaskPlanes

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.excludeMaskPlanes

static

Initial value:

=  lsst.pex.config.ListField(
        dtype=str,
        default=("NO_DATA", "BAD", "SAT", "EDGE", "FAKE"),
        doc="Mask planes to exclude when selecting sources for PSF matching."
    )

Definition at line 211 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 128 of file subtractImages.py.

maxKernelSources

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

minKernelSources

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

minTemplateFractionForExpectedSuccess

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

preserveTemplateMask

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.preserveTemplateMask

static

Initial value:

=  lsst.pex.config.ListField(
        dtype=str,
        default=("NO_DATA", "BAD",),
        doc="Mask planes from the template to propagate to the image difference."
    )

Definition at line 221 of file subtractImages.py.

renameTemplateMask

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

requiredTemplateFraction

lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig.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 142 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 160 of file subtractImages.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_diffim/g1470d8bcf6+190ad2ba91/python/lsst/ip/diffim/subtractImages.py