lsst.pipe.tasks  13.0-51-g46e0a8d
 All Classes Namespaces Files Functions Variables Groups Pages
Public Member Functions | Public Attributes | 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
 
def validate
 

Public Attributes

 doPreConvolve
 
 doMatchSources
 
 doAddMetrics
 
 doUseRegister
 

Static Public Attributes

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

Detailed Description

Config for ImageDifferenceTask

Definition at line 50 of file imageDifference.py.

Member Function Documentation

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

Definition at line 170 of file imageDifference.py.

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

Definition at line 197 of file imageDifference.py.

Member Data Documentation

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

Definition at line 106 of file imageDifference.py.

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

Definition at line 92 of file imageDifference.py.

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

Definition at line 145 of file imageDifference.py.

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

Definition at line 140 of file imageDifference.py.

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

Definition at line 97 of file imageDifference.py.

tuple lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.decorrelate
static
Initial value:
1 = pexConfig.ConfigurableField(
2  target=DecorrelateALKernelTask,
3  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 thedefault of 5.5).""",
4  )

Definition at line 118 of file imageDifference.py.

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

Definition at line 124 of file imageDifference.py.

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

Definition at line 166 of file imageDifference.py.

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

Definition at line 53 of file imageDifference.py.

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

Definition at line 89 of file imageDifference.py.

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doAddMetrics

Definition at line 179 of file imageDifference.py.

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

Definition at line 59 of file imageDifference.py.

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

Definition at line 75 of file imageDifference.py.

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

Definition at line 74 of file imageDifference.py.

tuple 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.

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

Definition at line 81 of file imageDifference.py.

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doMatchSources

Definition at line 178 of file imageDifference.py.

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

Definition at line 83 of file imageDifference.py.

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

Definition at line 78 of file imageDifference.py.

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

Definition at line 69 of file imageDifference.py.

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doPreConvolve

Definition at line 177 of file imageDifference.py.

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

Definition at line 63 of file imageDifference.py.

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

Definition at line 61 of file imageDifference.py.

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

Definition at line 65 of file imageDifference.py.

tuple 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.

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

Definition at line 56 of file imageDifference.py.

lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.doUseRegister

Definition at line 180 of file imageDifference.py.

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

Definition at line 86 of file imageDifference.py.

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

Definition at line 88 of file imageDifference.py.

tuple 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.

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

Definition at line 136 of file imageDifference.py.

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

Definition at line 163 of file imageDifference.py.

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

Definition at line 154 of file imageDifference.py.

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

Definition at line 132 of file imageDifference.py.

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

Definition at line 102 of file imageDifference.py.

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

Definition at line 150 of file imageDifference.py.

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

Definition at line 110 of file imageDifference.py.

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

Definition at line 114 of file imageDifference.py.

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

Definition at line 159 of file imageDifference.py.

tuple lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.useGaussianForPreConvolution
static
Initial value:
1 = pexConfig.Field(dtype=bool, default=True,
2  doc="Use a simple gaussian PSF model for pre-convolution "
3  "(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: