AssembleCoaddTask¶
Assemble a coadded image from a set of CoaddTempExps.
Python API summary¶
from lsst.pipe.tasks.assembleCoadd import AssembleCoaddTask
-
class
AssembleCoaddTask(*args, **kwargs) Assemble a coadded image from a set of warps (coadded temporary exposures)
...
- attributeconfig
Access configuration fields and retargetable subtasks.
-
method
run(skyInfo, tempExpRefList, imageScalerList, weightList, altMaskList=None, mask=None, supplementaryData=None) Assemble a coadd from input warps
...
-
method
runDataRef(dataRef, selectDataList=None, warpRefList=None) Assemble a coadd from a set of Warps
...
See also
See the AssembleCoaddTask API reference for complete details.
Retargetable subtasks¶
inputMapper¶
Input map creation subtask.
inputRecorder¶
Subtask that helps fill CoaddInputs catalogs added to the final Exposure
interpImage¶
- Default
- Field type
Task to interpolate (and extrapolate) over NaN pixels
modelPsf¶
- Default
lsst.meas.algorithms.gaussianPsfFactory.applyWrapper- Field type
Model Psf factory
scaleZeroPoint¶
- Default
- Field type
Task to adjust the photometric zero point of the coadd temp exposures
select¶
- Default
- Field type
Image selection subtask.
Configuration fields¶
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
calcErrorFromInputVariance¶
Calculate coadd variance from input variance by stacking statistic.Passed to StatisticsControl.setCalcErrorFromInputVariance()
clipIter¶
Number of iterations of outlier rejection; ignored if non-clipping statistic selected.
coaddName¶
Coadd name: typically one of deep or goodSeeing.
coaddPsf¶
- Data type
lsst.meas.algorithms.coaddPsf.coaddPsf.CoaddPsfConfig- Field type
Configuration for CoaddPsf
connections¶
- Data type
lsst.pipe.base.config.Connections- Field type
Configurations describing the connections of the PipelineTask to datatypes
doApplyExternalPhotoCalib¶
Whether to apply external photometric calibration via an lsst.afw.image.PhotoCalib object. Uses the externalPhotoCalibName field to determine which calibration to load.
doApplyExternalSkyWcs¶
Whether to apply external astrometric calibration via an lsst.afw.geom.SkyWcs object. Uses externalSkyWcsName field to determine which calibration to load.
doAttachTransmissionCurve¶
Attach a piecewise TransmissionCurve for the coadd? (requires all input Exposures to have TransmissionCurves).
doInputMap¶
Create a bitwise map of coadd inputs
doInterp¶
Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly.
doMaskBrightObjects¶
Set mask and flag bits for bright objects?
doNImage¶
Create image of number of contributing exposures for each pixel
doOnlineForMean¶
Perform online coaddition when statistic=”MEAN” to save memory?
doPsfMatch¶
Match to modelPsf? Deprecated. Sets makePsfMatched=True, makeDirect=False
doSelectVisits¶
Coadd only visits selected by a SelectVisitsTask
doSigmaClip¶
Perform sigma clipped outlier rejection with MEANCLIP statistic? (DEPRECATED)
doUsePsfMatchedPolygons¶
Use ValidPolygons from shrunk Psf-Matched Calexps? Should be set to True by CompareWarp only.
doWrite¶
Persist coadd?
externalPhotoCalibName¶
- Default
'jointcal'- Field type
strChoiceField(optional)- Choices
'jointcal'Use jointcal_photoCalib
'fgcm'Use fgcm_photoCalib
'fgcm_tract'Use fgcm_tract_photoCalib
NoneField is optional
Type of external PhotoCalib if doApplyExternalPhotoCalib is True. This field is only used for Gen2 middleware.
externalSkyWcsName¶
- Default
'jointcal'- Field type
strChoiceField(optional)- Choices
'jointcal'Use jointcal_wcs
NoneField is optional
Type of external SkyWcs if doApplyExternalSkyWcs is True. This field is only used for Gen2 middleware.
hasFakes¶
Should be set to True if fake sources have been inserted into the input data.
includeCalibVar¶
Add photometric calibration variance to warp variance plane.
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. Must be odd.
removeMaskPlanes¶
Mask planes to remove before coadding
saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default.
saveMetadata¶
Flag to enable/disable metadata saving for a task, enabled by default.
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.
useGlobalExternalPhotoCalib¶
When using doApplyExternalPhotoCalib, use ‘global’ calibrations that are not run per-tract. When False, use per-tract photometric calibration files.
useGlobalExternalSkyWcs¶
When using doApplyExternalSkyWcs, use ‘global’ calibrations that are not run per-tract. When False, use per-tract wcs files.
warpType¶
Warp name: one of ‘direct’ or ‘psfMatched’