lsst.pipe.tasks.imageDifference.ImageDifferenceConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.imageDifference.ImageDifferenceConfig:

Public Member Functions
def	setDefaults (self)
def	validate (self)

Static Public Attributes
	doAddCalexpBackground
	doUseRegister
	doDebugRegister
	doSelectSources
	doSelectDcrCatalog
	doSelectVariableCatalog
	doSubtract
	doPreConvolve
	doScaleTemplateVariance
	useGaussianForPreConvolution
	doDetection
	doDecorrelation
	doMerge
	doMatchSources
	doMeasurement
	doDipoleFitting
	doForcedMeasurement
	doWriteSubtractedExp
	doWriteMatchedExp
	doWriteSources
	doAddMetrics
	coaddName
	convolveTemplate
	refObjLoader
	astrometer
	sourceSelector
	subtract
	decorrelate
	doSpatiallyVarying
	detection
	measurement
	forcedMeasurement
	getTemplate
	scaleVariance
	controlStepSize
	controlRandomSeed
	register
	kernelSourcesFromRef
	templateSipOrder
	growFootprint
	diaSourceMatchRadius

Detailed Description

Config for ImageDifferenceTask

Definition at line 51 of file imageDifference.py.

Member Function Documentation

setDefaults()

def lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.setDefaults

(

self

)

Definition at line 187 of file imageDifference.py.

    def setDefaults(self):
        # defaults are OK for catalog and diacatalog

        self.subtract['al'].kernel.name = "AL"
        self.subtract['al'].kernel.active.fitForBackground = True
        self.subtract['al'].kernel.active.spatialKernelOrder = 1
        self.subtract['al'].kernel.active.spatialBgOrder = 2
        self.doPreConvolve = False
        self.doMatchSources = False
        self.doAddMetrics = False
        self.doUseRegister = False

        # DiaSource Detection
        self.detection.thresholdPolarity = "both"
        self.detection.thresholdValue = 5.5
        self.detection.reEstimateBackground = False
        self.detection.thresholdType = "pixel_stdev"

        # Add filtered flux measurement, the correct measurement for pre-convolved images.
        # Enable all measurements, regardless of doPreConvolve, as it makes data harvesting easier.
        # To change that you must modify algorithms.names in the task's applyOverrides method,
        # after the user has set doPreConvolve.
        self.measurement.algorithms.names.add('base_PeakLikelihoodFlux')
        self.measurement.plugins.names |= ['base_LocalPhotoCalib',
                                           'base_LocalWcs']

        self.forcedMeasurement.plugins = ["base_TransformedCentroid", "base_PsfFlux"]
        self.forcedMeasurement.copyColumns = {
            "id": "objectId", "parent": "parentObjectId", "coord_ra": "coord_ra", "coord_dec": "coord_dec"}
        self.forcedMeasurement.slots.centroid = "base_TransformedCentroid"
        self.forcedMeasurement.slots.shape = None

        # For shuffling the control sample
        random.seed(self.controlRandomSeed)

validate()

def lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.validate

(

self

)

Definition at line 222 of file imageDifference.py.

    def validate(self):
        pexConfig.Config.validate(self)
        if self.doAddMetrics and not self.doSubtract:
            raise ValueError("Subtraction must be enabled for kernel metrics calculation.")
        if not self.doSubtract and not self.doDetection:
            raise ValueError("Either doSubtract or doDetection must be enabled.")
        if self.subtract.name == 'zogy' and self.doAddMetrics:
            raise ValueError("Kernel metrics does not exist in zogy subtraction.")
        if self.doMeasurement and not self.doDetection:
            raise ValueError("Cannot run source measurement without source detection.")
        if self.doMerge and not self.doDetection:
            raise ValueError("Cannot run source merging without source detection.")
        if self.doUseRegister and not self.doSelectSources:
            raise ValueError("doUseRegister=True and doSelectSources=False. "
                             "Cannot run RegisterTask without selecting sources.")
        if self.doPreConvolve and self.doDecorrelation and not self.convolveTemplate:
            raise ValueError("doPreConvolve=True and doDecorrelation=True and "
                             "convolveTemplate=False is not supported.")
        if hasattr(self.getTemplate, "coaddName"):
            if self.getTemplate.coaddName != self.coaddName:
                raise ValueError("Mis-matched coaddName and getTemplate.coaddName in the config.")

Member Data Documentation

astrometer

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.astrometer

static

Definition at line 113 of file imageDifference.py.

coaddName

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.coaddName

static

Definition at line 99 of file imageDifference.py.

controlRandomSeed

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.controlRandomSeed

static

Definition at line 160 of file imageDifference.py.

controlStepSize

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.controlStepSize

static

Definition at line 155 of file imageDifference.py.

convolveTemplate

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.convolveTemplate

static

Definition at line 104 of file imageDifference.py.

decorrelate

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.decorrelate

static

Definition at line 122 of file imageDifference.py.

detection

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.detection

static

Definition at line 134 of file imageDifference.py.

diaSourceMatchRadius

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.diaSourceMatchRadius

static

Definition at line 182 of file imageDifference.py.

doAddCalexpBackground

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doAddCalexpBackground

static

Definition at line 54 of file imageDifference.py.

doAddMetrics

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doAddMetrics

static

Definition at line 96 of file imageDifference.py.

doDebugRegister

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDebugRegister

static

Definition at line 60 of file imageDifference.py.

doDecorrelation

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDecorrelation

static

Definition at line 78 of file imageDifference.py.

doDetection

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDetection

static

Definition at line 77 of file imageDifference.py.

doDipoleFitting

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDipoleFitting

static

Definition at line 87 of file imageDifference.py.

doForcedMeasurement

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doForcedMeasurement

static

Definition at line 88 of file imageDifference.py.

doMatchSources

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doMatchSources

static

Definition at line 84 of file imageDifference.py.

doMeasurement

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doMeasurement

static

Definition at line 86 of file imageDifference.py.

doMerge

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doMerge

static

Definition at line 81 of file imageDifference.py.

doPreConvolve

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doPreConvolve

static

Definition at line 70 of file imageDifference.py.

doScaleTemplateVariance

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doScaleTemplateVariance

static

Definition at line 72 of file imageDifference.py.

doSelectDcrCatalog

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSelectDcrCatalog

static

Definition at line 64 of file imageDifference.py.

doSelectSources

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSelectSources

static

Definition at line 62 of file imageDifference.py.

doSelectVariableCatalog

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSelectVariableCatalog

static

Definition at line 66 of file imageDifference.py.

doSpatiallyVarying

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSpatiallyVarying

static

Definition at line 128 of file imageDifference.py.

doSubtract

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSubtract

static

Definition at line 69 of file imageDifference.py.

doUseRegister

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doUseRegister

static

Definition at line 57 of file imageDifference.py.

doWriteMatchedExp

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doWriteMatchedExp

static

Definition at line 93 of file imageDifference.py.

doWriteSources

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doWriteSources

static

Definition at line 95 of file imageDifference.py.

doWriteSubtractedExp

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doWriteSubtractedExp

static

Definition at line 92 of file imageDifference.py.

forcedMeasurement

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.forcedMeasurement

static

Definition at line 142 of file imageDifference.py.

getTemplate

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.getTemplate

static

Definition at line 146 of file imageDifference.py.

growFootprint

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.growFootprint

static

Definition at line 178 of file imageDifference.py.

kernelSourcesFromRef

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.kernelSourcesFromRef

static

Definition at line 169 of file imageDifference.py.

measurement

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.measurement

static

Definition at line 138 of file imageDifference.py.

refObjLoader

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.refObjLoader

static

Definition at line 109 of file imageDifference.py.

register

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.register

static

Definition at line 165 of file imageDifference.py.

scaleVariance

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.scaleVariance

static

Definition at line 150 of file imageDifference.py.

sourceSelector

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.sourceSelector

static

Definition at line 117 of file imageDifference.py.

subtract

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.subtract

static

Definition at line 121 of file imageDifference.py.

templateSipOrder

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.templateSipOrder

static

Definition at line 174 of file imageDifference.py.

useGaussianForPreConvolution

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.useGaussianForPreConvolution

static

Definition at line 74 of file imageDifference.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pipe_tasks/19.0.0-33-ge0e6817e/python/lsst/pipe/tasks/imageDifference.py