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

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

 winter2013WcsShift
 
 winter2013WcsRms
 
 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 = subtractAlgorithmRegistry.makeField("Subtraction Algorithm", default="al")
 
 decorrelate
 
 doSpatiallyVarying
 
 detection
 
 measurement
 
 getTemplate
 
 controlStepSize
 
 controlRandomSeed
 
 register
 
 kernelSourcesFromRef
 
 templateSipOrder
 
 growFootprint
 
 diaSourceMatchRadius
 

Detailed Description

Definition at line 792 of file imageDifference.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 798 of file imageDifference.py.

◆ validate()

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

Definition at line 197 of file imageDifference.py.

Member Data Documentation

◆ astrometer

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.astrometer
staticinherited
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 107 of file imageDifference.py.

◆ coaddName

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

Definition at line 93 of file imageDifference.py.

◆ controlRandomSeed

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.controlRandomSeed
staticinherited
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
staticinherited
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
staticinherited
Initial value:
= pexConfig.Field(
doc="Which image gets convolved (default = template)",
dtype=bool,
default=True
)

Definition at line 98 of file imageDifference.py.

◆ decorrelate

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.decorrelate
staticinherited
Initial value:
= pexConfig.ConfigurableField(
target=DecorrelateALKernelSpatialTask,
doc="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).",
)

Definition at line 116 of file imageDifference.py.

◆ detection

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

Definition at line 128 of file imageDifference.py.

◆ diaSourceMatchRadius

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.diaSourceMatchRadius
staticinherited
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
staticinherited
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 54 of file imageDifference.py.

◆ doAddMetrics

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

Definition at line 90 of file imageDifference.py.

◆ doDebugRegister

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

Definition at line 60 of file imageDifference.py.

◆ doDecorrelation

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doDecorrelation
staticinherited
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 76 of file imageDifference.py.

◆ doDetection

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

Definition at line 75 of file imageDifference.py.

◆ doDipoleFitting

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

Definition at line 85 of file imageDifference.py.

◆ doMatchSources

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

Definition at line 82 of file imageDifference.py.

◆ doMeasurement

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

Definition at line 84 of file imageDifference.py.

◆ doMerge

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

Definition at line 79 of file imageDifference.py.

◆ doPreConvolve

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

Definition at line 70 of file imageDifference.py.

◆ doSelectDcrCatalog

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

Definition at line 64 of file imageDifference.py.

◆ doSelectSources

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

Definition at line 62 of file imageDifference.py.

◆ doSelectVariableCatalog

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

Definition at line 66 of file imageDifference.py.

◆ doSpatiallyVarying

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doSpatiallyVarying
staticinherited
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If using Zogy or A&L decorrelation, perform these on a grid across the "
"image in order to allow for spatial variations"
)

Definition at line 122 of file imageDifference.py.

◆ doSubtract

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

Definition at line 69 of file imageDifference.py.

◆ doUseRegister

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

Definition at line 57 of file imageDifference.py.

◆ doWriteMatchedExp

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

Definition at line 87 of file imageDifference.py.

◆ doWriteSources

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

Definition at line 89 of file imageDifference.py.

◆ doWriteSubtractedExp

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

Definition at line 86 of file imageDifference.py.

◆ getTemplate

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.getTemplate
staticinherited
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
staticinherited
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
staticinherited
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
staticinherited
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
staticinherited
Initial value:
= pexConfig.ConfigurableField(
target=LoadAstrometryNetObjectsTask,
doc="reference object loader",
)

Definition at line 103 of file imageDifference.py.

◆ register

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.register
staticinherited
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
staticinherited
Initial value:
= pexConfig.ConfigurableField(
target=ObjectSizeStarSelectorTask,
doc="Source selection algorithm",
)

Definition at line 111 of file imageDifference.py.

◆ subtract

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.subtract = subtractAlgorithmRegistry.makeField("Subtraction Algorithm", default="al")
staticinherited

Definition at line 115 of file imageDifference.py.

◆ templateSipOrder

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.templateSipOrder
staticinherited
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
staticinherited
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 72 of file imageDifference.py.

◆ winter2013WcsRms

lsst.pipe.tasks.imageDifference.Winter2013ImageDifferenceConfig.winter2013WcsRms
static
Initial value:
= pexConfig.Field(dtype=float, default=0.0,
doc="Perturb stars going into RegisterTask by this amount")

Definition at line 795 of file imageDifference.py.

◆ winter2013WcsShift

lsst.pipe.tasks.imageDifference.Winter2013ImageDifferenceConfig.winter2013WcsShift
static
Initial value:
= pexConfig.Field(dtype=float, default=0.0,
doc="Shift stars going into RegisterTask by this amount")

Definition at line 793 of file imageDifference.py.


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