AssembleCoaddTask¶

Assemble a coadded image from a set of CoaddTempExps.

Python API summary¶

from lsst.pipe.tasks.assembleCoadd import AssembleCoaddTask

classAssembleCoaddTask(*args, **kwargs): Assemble a coadded image from a set of warps (coadded temporary exposures)...

attributeconfig: Access configuration fields and retargetable subtasks.

methodrun(skyInfo, tempExpRefList, imageScalerList, weightList, altMaskList=None, mask=None, supplementaryData=None): Assemble a coadd from input warps...

methodrunDataRef(dataRef, selectDataList=None, warpRefList=None): Assemble a coadd from a set of Warps...

Retargetable subtasks¶

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.

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.

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

connections¶

Data type: lsst.pipe.base.config.Connections
Field type: ConfigField

Configurations describing the connections of the PipelineTask to datatypes

doApplyExternalPhotoCalib¶

Default: False
Field type: bool Field

Whether to apply external photometric calibration via an lsst.afw.image.PhotoCalib object. Uses the externalPhotoCalibName field to determine which calibration to load.

doApplyExternalSkyWcs¶

Default: False
Field type: bool Field

Whether to apply external astrometric calibration via an lsst.afw.geom.SkyWcs object. Uses externalSkyWcsName field to determine which calibration to load.

doApplyUberCal¶

Default: False
Field type: bool Field

Apply ubercalibrated WCS and PhotoCalib results to input calexps? This field is no longer used, and has been deprecated by DM-21308. It will be removed after v20. Use doApplyExternalPhotoCalib and doApplyExternalSkyWcs instead.

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?

externalPhotoCalibName¶

Default

'jointcal'

Field type

str ChoiceField (optional)

Choices

'jointcal': Use jointcal_photoCalib
'fgcm': Use fgcm_photoCalib
'fgcm_tract': Use fgcm_tract_photoCalib
None: Field is optional

Type of external PhotoCalib if doApplyExternalPhotoCalib is True.

externalSkyWcsName¶

Default

'jointcal'

Field type

str ChoiceField (optional)

Choices

'jointcal': Use jointcal_wcs
None: Field is optional

Type of external SkyWcs if doApplyExternalSkyWcs is True.

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.

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.

removeMaskPlanes¶

Default: ['NOT_DEBLENDED']
Field type: str ListField

Mask planes to remove before coadding

saveMetadata¶

Default: True
Field type: bool Field

Flag to enable/disable metadata saving for a task, enabled by default.

sigmaClip¶

Default: 3.0
Field type: float Field

Sigma for outlier rejection; ignored if non-clipping statistic selected.

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.

warpType¶

Default: 'direct'
Field type: str Field

Warp name: one of ‘direct’ or ‘psfMatched’

Navigation