SafeClipAssembleCoaddTask

Python API summary

from lsst.pipe.tasks.assembleCoadd import SafeClipAssembleCoaddTask
classSafeClipAssembleCoaddTask(*args, **kwargs)

Assemble a coadded image from a set of coadded temporary exposures, being careful to clip & flag areas with potential artifacts...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(skyInfo, tempExpRefList, imageScalerList, weightList, *args, **kwargs)

Assemble the coadd for a region...

methodrunDataRef(dataRef, selectDataList=None, warpRefList=None)

Assemble a coadd from a set of Warps...

See also

See the SafeClipAssembleCoaddTask API reference for complete details.

Retargetable subtasks

clipDetection

Default
lsst.meas.algorithms.detection.SourceDetectionTask
Field type
ConfigurableField
Detect sources on difference between unclipped and clipped coadd

inputRecorder

Default
lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask
Field type
ConfigurableField
Subtask that helps fill CoaddInputs catalogs added to the final Exposure

interpImage

Default
lsst.pipe.tasks.interpImage.InterpImageTask
Field type
ConfigurableField
Task to interpolate (and extrapolate) over NaN pixels

modelPsf

Default
lsst.meas.algorithms.gaussianPsfFactory.applyWrapper
Field type
ConfigurableField
Model Psf factory

scaleZeroPoint

Default
lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointTask
Field type
ConfigurableField
Task to adjust the photometric zero point of the coadd temp exposures

select

Default
lsst.pipe.tasks.selectImages.WcsSelectImagesTask
Field type
ConfigurableField
Image selection subtask.

Configuration fields

badMaskPlanes

Default
('NO_DATA',)
Field type
str ListField
Mask planes that, if set, the associated pixel should not be included in the coaddTempExp.

brightObjectMask

Data type
lsst.pipe.base.config.InputDatasetConfig
Field type
ConfigField
Input Bright Object Mask mask produced with external catalogs to be applied to the mask plane BRIGHT_OBJECT.

brightObjectMaskName

Default
'BRIGHT_OBJECT'
Field type
str Field
Name of mask bit used for bright objects

calcErrorFromInputVariance

Default
True
Field type
bool Field
Calculate coadd variance from input variance by stacking statistic.Passed to StatisticsControl.setCalcErrorFromInputVariance()

clipIter

Default
2
Field type
int Field
Number of iterations of outlier rejection; ignored if non-clipping statistic selected.

coaddExposure

Data type
lsst.pipe.base.config.OutputDatasetConfig
Field type
ConfigField
Output coadded exposure, produced by stacking input warps

coaddName

Default
'deep'
Field type
str Field
Coadd name: typically one of deep or goodSeeing.

coaddPsf

Data type
lsst.meas.algorithms.coaddPsf.coaddPsf.CoaddPsfConfig
Field type
ConfigField
Configuration for CoaddPsf

doApplyUberCal

Default
False
Field type
bool Field
Apply jointcal WCS and PhotoCalib results to input calexps?

doAttachTransmissionCurve

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

doInterp

Default
True
Field type
bool Field
Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly.

doMaskBrightObjects

Default
False
Field type
bool Field
Set mask and flag bits for bright objects?

doNImage

Default
False
Field type
bool Field
Create image of number of contributing exposures for each pixel

doPsfMatch

Default
False
Field type
bool Field
Match to modelPsf? Deprecated. Sets makePsfMatched=True, makeDirect=False

doSigmaClip

Default
False
Field type
bool Field
Perform sigma clipped outlier rejection with MEANCLIP statistic? (DEPRECATED)

doUsePsfMatchedPolygons

Default
False
Field type
bool Field
Use ValidPolygons from shrunk Psf-Matched Calexps? Should be set to True by CompareWarp only.

doWrite

Default
True
Field type
bool Field
Persist coadd?

hasFakes

Default
False
Field type
bool Field
Should be set to True if fake sources have been inserted into the input data.

includeCalibVar

Default
False
Field type
bool Field
Add photometric calibration variance to warp variance plane.

inputWarps

Data type
lsst.pipe.base.config.InputDatasetConfig
Field type
ConfigField
Input list of warps to be assemebled i.e. stacked.WarpType (e.g. direct, psfMatched) is controlled by we warpType config parameter

maskPropagationThresholds

Default
{'SAT': 0.1}
Field type
DictField
Key type
str
Value type
float
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

Default
21
Field type
int Field
Size in pixels of matching kernel. Must be odd.

maxClipFootOverlapDouble

Default
0.15
Field type
float Field
Maximum fractional overlap of clipped footprints with visit DETECTED when considering two visits

minBigOverlap

Default
100
Field type
int Field
Minimum number of pixels in footprint to use DETECTED mask from the single visits when labeling clipped footprints

minClipFootOverlap

Default
0.6
Field type
float Field
Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped

minClipFootOverlapDouble

Default
0.45
Field type
float Field
Minimum fractional overlap of clipped footprints with visit DETECTED to be clipped when two visits overlap

minClipFootOverlapSingle

Default
0.5
Field type
float Field
Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped when only one visit overlaps

nImage

Data type
lsst.pipe.base.config.OutputDatasetConfig
Field type
ConfigField
Output image of number of input images per pixel

quantum

Data type
lsst.pipe.base.config.QuantumConfig
Field type
ConfigField
configuration for PipelineTask quantum

removeMaskPlanes

Default
['NOT_DEBLENDED']
Field type
str ListField
Mask planes to remove before coadding

sigmaClip

Default
3.0
Field type
float Field
Sigma for outlier rejection; ignored if non-clipping statistic selected.

skyMap

Data type
lsst.pipe.base.config.InputDatasetConfig
Field type
ConfigField
Input definition of geometry/bbox and projection/wcs for coadded exposures

statistic

Default
'MEANCLIP'
Field type
str Field
Main stacking statistic for aggregating over the epochs.

subregionSize

Default
(2000, 2000)
Field type
int ListField
Required length
2
Width, height of stack subregion size; make small enough that a full stack of images will fit into memory at once.

useMeasMosaic

Default
False
Field type
bool Field
Use meas_mosaic’s applyMosaicResultsExposure() to do the photometric calibration/wcs update (deprecated).

warpType

Default
'direct'
Field type
str Field
Warp name: one of ‘direct’ or ‘psfMatched’