LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
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
 
def validate
 

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 doMerge
 
tuple doMatchSources
 
tuple doMeasurement = pexConfig.Field(dtype=bool, default=True, doc="Measure diaSources?")
 
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 astrometer
 
tuple sourceSelector = starSelectorRegistry.makeField("Source selection algorithm", default="diacatalog")
 
tuple subtract
 
tuple detection
 
tuple dipoleMeasurement
 
tuple measurement
 
tuple controlStepSize
 
tuple controlRandomSeed
 
tuple register
 
tuple templateBorderSize
 
tuple templateSipOrder
 
tuple growFootprint
 
tuple diaSourceMatchRadius
 
tuple maxDiaSourcesToMeasure
 

Detailed Description

Config for ImageDifferenceTask

Definition at line 46 of file imageDifference.py.

Member Function Documentation

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

Definition at line 141 of file imageDifference.py.

142  def setDefaults(self):
143  # Set default source selector and configure defaults for that one and some common alternatives
144  self.sourceSelector.name = "diacatalog"
145  self.sourceSelector["secondMoment"].clumpNSigma = 2.0
146  # defaults are OK for catalog and diacatalog
147 
148  # DiaSource Detection
149  self.detection.thresholdPolarity = "both"
150  self.detection.reEstimateBackground = False
151  self.detection.thresholdType = "pixel_stdev"
152 
153  # Add filtered flux measurement, the correct measurement for pre-convolved images.
154  # Enable all measurements, regardless of doPreConvolved, as it makes data harvesting easier.
155  # To change that you must modify algorithms.names in the task's applyOverrides method,
156  # after the user has set doPreConvolved.
157  self.measurement.algorithms.names.add("flux.peakLikelihood")
158  self.dipoleMeasurement.algorithms.names.add("flux.peakLikelihood")
159 
160  # For shuffling the control sample
161  random.seed(self.controlRandomSeed)
def lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.validate (   self)

Definition at line 162 of file imageDifference.py.

163  def validate(self):
164  pexConfig.Config.validate(self)
165  if self.doMeasurement and not self.doDetection:
166  raise ValueError("Cannot run source measurement without source detection.")
167  if self.doMerge and not self.doDetection:
168  raise ValueError("Cannot run source merging without source detection.")

Member Data Documentation

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

Definition at line 90 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 80 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 116 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 111 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 85 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 99 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) for DiaSource to Source association")

Definition at line 135 of file imageDifference.py.

tuple lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.dipoleMeasurement
static
Initial value:
1 = pexConfig.ConfigurableField(
2  target=DipoleMeasurementTask,
3  doc="Final source measurement on low-threshold detections; dipole fitting enabled.",
4  )

Definition at line 103 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. Useful as ipDiffim does background matching.")

Definition at line 49 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 77 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 53 of file imageDifference.py.

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

Definition at line 67 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 70 of file imageDifference.py.

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

Definition at line 72 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 set by growFootprint")

Definition at line 68 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 62 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 57 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 55 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 of the control sample")

Definition at line 59 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 61 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 science image")

Definition at line 51 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 74 of file imageDifference.py.

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

Definition at line 76 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 73 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 132 of file imageDifference.py.

tuple lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.maxDiaSourcesToMeasure
static
Initial value:
1 = pexConfig.Field(dtype=int, default=200,
2  doc="Do not measure more than this many sources with dipoleMeasurement, use measurement")

Definition at line 138 of file imageDifference.py.

tuple lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.measurement
static
Initial value:
1 = pexConfig.ConfigurableField(
2  target=SourceMeasurementTask,
3  doc="Final source measurement on low-threshold detections; dipole fitting NOT enabled",
4  )

Definition at line 107 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 121 of file imageDifference.py.

tuple lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.sourceSelector = starSelectorRegistry.makeField("Source selection algorithm", default="diacatalog")
static

Definition at line 94 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 95 of file imageDifference.py.

tuple lsst.pipe.tasks.imageDifference.ImageDifferenceConfig.templateBorderSize
static
Initial value:
1 = pexConfig.Field(dtype=int, default=10,
2  doc="Number of pixels to grow the requested template image to account for warping")

Definition at line 126 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 (default is too high, overfitting)")

Definition at line 129 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 (else use fit PSF)? "
3  "Ignored if doPreConvolve false.")

Definition at line 64 of file imageDifference.py.


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