ImageDifferenceTask¶
Python API summary¶
from lsst.pipe.tasks.imageDifference import ImageDifferenceTask
-
class
ImageDifferenceTask Subtract an image from a template and measure the result
...
-
attribute
config Access configuration fields and retargetable subtasks.
-
method
runDataRef Subtract an image from a template coadd and measure the result
...
See also
See the ImageDifferenceTask API reference for complete details.
Retargetable subtasks¶
astrometer¶
- Default
lsst.meas.astrom.astrometry.AstrometryTask- Field type
ConfigurableField
astrometry task; used to match sources to reference objects, but not to fit a WCS
decorrelate¶
- Default
lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelSpatialTask- Field type
ConfigurableField
Decorrelate effects of A&L kernel convolution on image difference, only if doSubtract is True. If this option is enabled, then detection.thresholdValue should be set to 5.0 (rather than the default of 5.5).
detection¶
- Default
lsst.meas.algorithms.detection.SourceDetectionTask- Field type
ConfigurableField
Low-threshold detection for final measurement
forcedMeasurement¶
- Default
lsst.meas.base.forcedMeasurement.ForcedMeasurementTask- Field type
ConfigurableField
Subtask to force photometer PVI at diaSource location.
getTemplate¶
- Default
lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask- Field type
ConfigurableField
Subtask to retrieve template exposure and sources
measurement¶
- Default
lsst.ip.diffim.dipoleFitTask.DipoleFitTask- Field type
ConfigurableField
Enable updated dipole fitting method
refObjLoader¶
- Default
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask- Field type
ConfigurableField
reference object loader
register¶
- Default
lsst.pipe.tasks.registerImage.RegisterTask- Field type
ConfigurableField
Task to enable image-to-image image registration (warping)
sourceSelector¶
- Default
lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask- Field type
ConfigurableField
Source selection algorithm
subtract¶
- Default
'al'- Field type
- Single-selection
RegistryField - Choices
'al'lsst.ip.diffim.imagePsfMatch.ImagePsfMatchTask'zogy'lsst.ip.diffim.zogy.ZogyImagePsfMatchTask
Subtraction Algorithm
Configuration fields¶
coaddName¶
coadd name: typically one of deep, goodSeeing, or dcr
controlStepSize¶
What step size (every Nth one) to select a control sample from the kernelSources
convolveTemplate¶
Which image gets convolved (default = template)
diaSourceMatchRadius¶
Match radius (in arcseconds) for DiaSource to Source association
doAddCalexpBackground¶
Add background to calexp before processing it. Useful as ipDiffim does background matching.
doAddMetrics¶
Add columns to the source table to hold analysis metrics?
doDecorrelation¶
Perform diffim decorrelation to undo pixel correlation due to A&L kernel convolution? If True, also update the diffim PSF.
doForcedMeasurement¶
Force photometer diaSource locations on PVI?
doMatchSources¶
Match diaSources with input calexp sources and ref catalog sources
doMerge¶
Merge positive and negative diaSources with grow radius set by growFootprint
doPreConvolve¶
Convolve science image by its PSF before PSF-matching?
doSelectDcrCatalog¶
Select stars of extreme color as part of the control sample
doSelectVariableCatalog¶
Select stars that are variable to be part of the control sample
doSpatiallyVarying¶
If using Zogy or A&L decorrelation, perform these on a grid across the image in order to allow for spatial variations
doUseRegister¶
Use image-to-image registration to align template with science image
doWriteMatchedExp¶
Write warped and PSF-matched template coadd exposure?
growFootprint¶
Grow positive and negative footprints by this amount before merging
kernelSourcesFromRef¶
Select sources to measure kernel from reference catalog if True, template if false
templateSipOrder¶
Sip Order for fitting the Template Wcs (default is too high, overfitting)