lsst.pipe.tasks  13.0-54-gc325bc5f
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.imageDifference.ImageDifferenceConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.imageDifference.ImageDifferenceConfig:
lsst.pipe.tasks.imageDifference.Winter2013ImageDifferenceConfig

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

 doAddCalexpBackground
 
 doUseRegister
 
 doDebugRegister
 
 doSelectSources
 
 doSelectDcrCatalog
 
 doSelectVariableCatalog
 
 doSubtract = pexConfig.Field(dtype=bool, default=True, doc="Compute subtracted exposure?")
 
 doPreConvolve
 
 useGaussianForPreConvolution
 
 doDetection = pexConfig.Field(dtype=bool, default=True, doc="Detect sources?")
 
 doDecorrelation
 
 doMerge
 
 doMatchSources
 
 doMeasurement = pexConfig.Field(dtype=bool, default=True, doc="Measure diaSources?")
 
 doDipoleFitting = pexConfig.Field(dtype=bool, default=True, doc="Measure dipoles using new algorithm?")
 
 doWriteSubtractedExp = pexConfig.Field(dtype=bool, default=True, doc="Write difference exposure?")
 
 doWriteMatchedExp
 
 doWriteSources = pexConfig.Field(dtype=bool, default=True, doc="Write sources?")
 
 doAddMetrics
 
 coaddName
 
 convolveTemplate
 
 refObjLoader
 
 astrometer
 
 sourceSelector
 
 subtract
 
 decorrelate
 
 detection
 
 measurement
 
 getTemplate
 
 controlStepSize
 
 controlRandomSeed
 
 register
 
 kernelSourcesFromRef
 
 templateSipOrder
 
 growFootprint
 
 diaSourceMatchRadius
 

Detailed Description

Config for ImageDifferenceTask

Definition at line 50 of file imageDifference.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.setDefaults (   self)

Definition at line 170 of file imageDifference.py.

◆ validate()

def lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.validate (   self)

Definition at line 197 of file imageDifference.py.

Member Data Documentation

◆ astrometer

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.astrometer
static
Initial value:
= pexConfig.ConfigurableField(
target=AstrometryTask,
doc="astrometry task; used to match sources to reference objects, but not to fit a WCS",
)

Definition at line 106 of file imageDifference.py.

◆ coaddName

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.coaddName
static
Initial value:
= pexConfig.Field(
doc="coadd name: typically one of deep or goodSeeing",
dtype=str,
default="deep",
)

Definition at line 92 of file imageDifference.py.

◆ controlRandomSeed

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.controlRandomSeed
static
Initial value:
= pexConfig.Field(
doc = "Random seed for shuffing the control sample",
dtype = int,
default = 10
)

Definition at line 145 of file imageDifference.py.

◆ controlStepSize

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.controlStepSize
static
Initial value:
= pexConfig.Field(
doc="What step size (every Nth one) to select a control sample from the kernelSources",
dtype=int,
default=5
)

Definition at line 140 of file imageDifference.py.

◆ convolveTemplate

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.convolveTemplate
static
Initial value:
= pexConfig.Field(
doc="Which image gets convolved (default = template)",
dtype=bool,
default=True
)

Definition at line 97 of file imageDifference.py.

◆ decorrelate

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.decorrelate
static
Initial value:
= pexConfig.ConfigurableField(
target=DecorrelateALKernelTask,
doc=,
)

Definition at line 118 of file imageDifference.py.

◆ detection

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.detection
static
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Low-threshold detection for final measurement",
)

Definition at line 124 of file imageDifference.py.

◆ diaSourceMatchRadius

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.diaSourceMatchRadius
static
Initial value:
= pexConfig.Field(dtype=float, default=0.5,
doc="Match radius (in arcseconds) "
"for DiaSource to Source association")

Definition at line 166 of file imageDifference.py.

◆ doAddCalexpBackground

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doAddCalexpBackground
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Add background to calexp before processing it. "
"Useful as ipDiffim does background matching.")

Definition at line 53 of file imageDifference.py.

◆ doAddMetrics

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doAddMetrics
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Add columns to the source table to hold analysis metrics?")

Definition at line 89 of file imageDifference.py.

◆ doDebugRegister

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDebugRegister
static
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc="Writing debugging data for doUseRegister")

Definition at line 59 of file imageDifference.py.

◆ doDecorrelation

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDecorrelation
static
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc="Perform diffim decorrelation to undo pixel correlation due to A&L "
"kernel convolution? If True, also update the diffim PSF.")

Definition at line 75 of file imageDifference.py.

◆ doDetection

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDetection = pexConfig.Field(dtype=bool, default=True, doc="Detect sources?")
static

Definition at line 74 of file imageDifference.py.

◆ doDipoleFitting

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDipoleFitting = pexConfig.Field(dtype=bool, default=True, doc="Measure dipoles using new algorithm?")
static

Definition at line 84 of file imageDifference.py.

◆ doMatchSources

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doMatchSources
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Match diaSources with input calexp sources and ref catalog sources")

Definition at line 81 of file imageDifference.py.

◆ doMeasurement

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doMeasurement = pexConfig.Field(dtype=bool, default=True, doc="Measure diaSources?")
static

Definition at line 83 of file imageDifference.py.

◆ doMerge

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doMerge
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Merge positive and negative diaSources with grow radius "
"set by growFootprint")

Definition at line 78 of file imageDifference.py.

◆ doPreConvolve

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doPreConvolve
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Convolve science image by its PSF before PSF-matching?")

Definition at line 69 of file imageDifference.py.

◆ doSelectDcrCatalog

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSelectDcrCatalog
static
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc="Select stars of extreme color as part of the control sample")

Definition at line 63 of file imageDifference.py.

◆ doSelectSources

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSelectSources
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Select stars to use for kernel fitting")

Definition at line 61 of file imageDifference.py.

◆ doSelectVariableCatalog

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSelectVariableCatalog
static
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc="Select stars that are variable to be part "
"of the control sample")

Definition at line 65 of file imageDifference.py.

◆ doSubtract

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSubtract = pexConfig.Field(dtype=bool, default=True, doc="Compute subtracted exposure?")
static

Definition at line 68 of file imageDifference.py.

◆ doUseRegister

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doUseRegister
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Use image-to-image registration to align template with "
"science image")

Definition at line 56 of file imageDifference.py.

◆ doWriteMatchedExp

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doWriteMatchedExp
static
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc="Write warped and PSF-matched template coadd exposure?")

Definition at line 86 of file imageDifference.py.

◆ doWriteSources

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doWriteSources = pexConfig.Field(dtype=bool, default=True, doc="Write sources?")
static

Definition at line 88 of file imageDifference.py.

◆ doWriteSubtractedExp

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doWriteSubtractedExp = pexConfig.Field(dtype=bool, default=True, doc="Write difference exposure?")
static

Definition at line 85 of file imageDifference.py.

◆ getTemplate

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.getTemplate
static
Initial value:
= pexConfig.ConfigurableField(
target=GetCoaddAsTemplateTask,
doc="Subtask to retrieve template exposure and sources",
)

Definition at line 136 of file imageDifference.py.

◆ growFootprint

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.growFootprint
static
Initial value:
= pexConfig.Field(dtype=int, default=2,
doc="Grow positive and negative footprints by this amount before merging")

Definition at line 163 of file imageDifference.py.

◆ kernelSourcesFromRef

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.kernelSourcesFromRef
static
Initial value:
= pexConfig.Field(
doc="Select sources to measure kernel from reference catalog if True, template if false",
dtype=bool,
default=False
)

Definition at line 154 of file imageDifference.py.

◆ measurement

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.measurement
static
Initial value:
= pexConfig.ConfigurableField(
target=DipoleFitTask,
doc="Enable updated dipole fitting method.",
)

Definition at line 132 of file imageDifference.py.

◆ refObjLoader

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.refObjLoader
static
Initial value:
= pexConfig.ConfigurableField(
target=LoadAstrometryNetObjectsTask,
doc="reference object loader",
)

Definition at line 102 of file imageDifference.py.

◆ register

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.register
static
Initial value:
= pexConfig.ConfigurableField(
target=RegisterTask,
doc="Task to enable image-to-image image registration (warping)",
)

Definition at line 150 of file imageDifference.py.

◆ sourceSelector

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.sourceSelector
static
Initial value:
= pexConfig.ConfigurableField(
target=ObjectSizeStarSelectorTask,
doc="Source selection algorithm",
)

Definition at line 110 of file imageDifference.py.

◆ subtract

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.subtract
static
Initial value:
= pexConfig.ConfigurableField(
target=ImagePsfMatchTask,
doc="Warp and PSF match template to exposure, then subtract",
)

Definition at line 114 of file imageDifference.py.

◆ templateSipOrder

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.templateSipOrder
static
Initial value:
= pexConfig.Field(dtype=int, default=2,
doc="Sip Order for fitting the Template Wcs "
"(default is too high, overfitting)")

Definition at line 159 of file imageDifference.py.

◆ useGaussianForPreConvolution

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.useGaussianForPreConvolution
static
Initial value:
= pexConfig.Field(dtype=bool, default=True,
doc="Use a simple gaussian PSF model for pre-convolution "
"(else use fit PSF)? Ignored if doPreConvolve false.")

Definition at line 71 of file imageDifference.py.


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