SafeClipAssembleCoaddConfig

class lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig

Bases: lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig

Configuration parameters for the SafeClipAssembleCoaddTask.

Attributes Summary

badMaskPlanes Mask planes that, if set, the associated pixel should not be included in the coaddTempExp.
brightObjectMaskName Name of mask bit used for bright objects (str, default 'BRIGHT_OBJECT')
calcErrorFromInputVariance Calculate coadd variance from input variance by stacking statistic.Passed to StatisticsControl.setCalcErrorFromInputVariance() (bool, default True)
clipDetection Detect sources on difference between unclipped and clipped coadd (ConfigurableInstance, default <class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>)
clipIter Number of iterations of outlier rejection; ignored if non-clipping statistic selected.
coaddName Coadd name: typically one of deep or goodSeeing.
coaddPsf Configuration for CoaddPsf (CoaddPsfConfig, default <class 'lsst.meas.algorithms.coaddPsf.coaddPsfContinued.CoaddPsfConfig'>)
doApplyUberCal Apply meas_mosaic ubercal results to input calexps? (bool, default False)
doAttachTransmissionCurve Attach a piecewise TransmissionCurve for the coadd? (requires all input Exposures to have TransmissionCurves).
doInterp Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly.
doMaskBrightObjects Set mask and flag bits for bright objects? (bool, default False)
doNImage Create image of number of contributing exposures for each pixel (bool, default False)
doPsfMatch Match to modelPsf? Deprecated.
doSigmaClip Perform sigma clipped outlier rejection with MEANCLIP statistic? (DEPRECATED) (bool, default False)
doUsePsfMatchedPolygons Use ValidPolygons from shrunk Psf-Matched Calexps? Should be set to True by CompareWarp only.
doWrite Persist coadd? (bool, default True)
inputRecorder Subtask that helps fill CoaddInputs catalogs added to the final Exposure (ConfigurableInstance, default <class 'lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderConfig'>)
interpImage Task to interpolate (and extrapolate) over NaN pixels (ConfigurableInstance, default <class 'lsst.pipe.tasks.interpImage.InterpImageConfig'>)
maskPropagationThresholds Threshold (in fractional weight) of rejection at which we propagate a mask plane to the coadd; that is, we set the mask bit on the coadd if the fraction the rejected frames would have contributed exceeds this value.
matchingKernelSize Size in pixels of matching kernel.
maxClipFootOverlapDouble Maximum fractional overlap of clipped footprints with visit DETECTED when considering two visits (float, default 0.15)
minBigOverlap Minimum number of pixels in footprint to use DETECTED mask from the single visits when labeling clipped footprints (int, default 100)
minClipFootOverlap Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped (float, default 0.6)
minClipFootOverlapDouble Minimum fractional overlap of clipped footprints with visit DETECTED to be clipped when two visits overlap (float, default 0.45)
minClipFootOverlapSingle Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped when only one visit overlaps (float, default 0.5)
modelPsf Model Psf factory (ConfigurableInstance, default <class 'lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory'>)
removeMaskPlanes Mask planes to remove before coadding (List, default ['NOT_DEBLENDED'])
scaleZeroPoint Task to adjust the photometric zero point of the coadd temp exposures (ConfigurableInstance, default <class 'lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointConfig'>)
select Image selection subtask.
sigmaClip Sigma for outlier rejection; ignored if non-clipping statistic selected.
statistic Main stacking statistic for aggregating over the epochs.
subregionSize Width, height of stack subregion size; make small enough that a full stack of images will fit into memory at once.
warpType Warp name: one of ‘direct’ or ‘psfMatched’ (str, default 'direct')

Methods Summary

setDefaults() Set default values for clipDetection.
validate() !Validate the Config; raise an exception if invalid

Attributes Documentation

badMaskPlanes

Mask planes that, if set, the associated pixel should not be included in the coaddTempExp. (List, default ('NO_DATA',))

brightObjectMaskName

Name of mask bit used for bright objects (str, default 'BRIGHT_OBJECT')

calcErrorFromInputVariance

Calculate coadd variance from input variance by stacking statistic.Passed to StatisticsControl.setCalcErrorFromInputVariance() (bool, default True)

clipDetection

Detect sources on difference between unclipped and clipped coadd (ConfigurableInstance, default <class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>)

clipIter

Number of iterations of outlier rejection; ignored if non-clipping statistic selected. (int, default 2)

coaddName

Coadd name: typically one of deep or goodSeeing. (str, default 'deep')

coaddPsf

Configuration for CoaddPsf (CoaddPsfConfig, default <class 'lsst.meas.algorithms.coaddPsf.coaddPsfContinued.CoaddPsfConfig'>)

doApplyUberCal

Apply meas_mosaic ubercal results to input calexps? (bool, default False)

doAttachTransmissionCurve

Attach a piecewise TransmissionCurve for the coadd? (requires all input Exposures to have TransmissionCurves). (bool, default False)

doInterp

Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly. (bool, default True)

doMaskBrightObjects

Set mask and flag bits for bright objects? (bool, default False)

doNImage

Create image of number of contributing exposures for each pixel (bool, default False)

doPsfMatch

Match to modelPsf? Deprecated. Sets makePsfMatched=True, makeDirect=False (bool, default False)

doSigmaClip

Perform sigma clipped outlier rejection with MEANCLIP statistic? (DEPRECATED) (bool, default False)

doUsePsfMatchedPolygons

Use ValidPolygons from shrunk Psf-Matched Calexps? Should be set to True by CompareWarp only. (bool, default False)

doWrite

Persist coadd? (bool, default True)

inputRecorder

Subtask that helps fill CoaddInputs catalogs added to the final Exposure (ConfigurableInstance, default <class 'lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderConfig'>)

interpImage

Task to interpolate (and extrapolate) over NaN pixels (ConfigurableInstance, default <class 'lsst.pipe.tasks.interpImage.InterpImageConfig'>)

maskPropagationThresholds

Threshold (in fractional weight) of rejection at which we propagate a mask plane to the coadd; that is, we set the mask bit on the coadd if the fraction the rejected frames would have contributed exceeds this value. (Dict, default {'SAT': 0.1})

matchingKernelSize

Size in pixels of matching kernel. Must be odd. (int, default 21)

maxClipFootOverlapDouble

Maximum fractional overlap of clipped footprints with visit DETECTED when considering two visits (float, default 0.15)

minBigOverlap

Minimum number of pixels in footprint to use DETECTED mask from the single visits when labeling clipped footprints (int, default 100)

minClipFootOverlap

Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped (float, default 0.6)

minClipFootOverlapDouble

Minimum fractional overlap of clipped footprints with visit DETECTED to be clipped when two visits overlap (float, default 0.45)

minClipFootOverlapSingle

Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped when only one visit overlaps (float, default 0.5)

modelPsf

Model Psf factory (ConfigurableInstance, default <class 'lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory'>)

removeMaskPlanes

Mask planes to remove before coadding (List, default ['NOT_DEBLENDED'])

scaleZeroPoint

Task to adjust the photometric zero point of the coadd temp exposures (ConfigurableInstance, default <class 'lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointConfig'>)

select

Image selection subtask. (ConfigurableInstance, default <class 'lsst.pex.config.config.Config'>)

sigmaClip

Sigma for outlier rejection; ignored if non-clipping statistic selected. (float, default 3.0)

statistic

Main stacking statistic for aggregating over the epochs. (str, default 'MEANCLIP')

subregionSize

Width, height of stack subregion size; make small enough that a full stack of images will fit into memory at once. (List, default (2000, 2000))

warpType

Warp name: one of ‘direct’ or ‘psfMatched’ (str, default 'direct')

Methods Documentation

setDefaults()

Set default values for clipDetection.

Notes

The numeric values for these configuration parameters were empirically determined, future work may further refine them.

validate()

!Validate the Config; raise an exception if invalid

The base class implementation performs type checks on all fields by calling Field.validate().

Complex single-field validation can be defined by deriving new Field types. As syntactic sugar, some derived Field types are defined in this module which handle recursing into sub-configs (ConfigField, ConfigChoiceField)

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete