SafeClipAssembleCoaddTask¶
Python API summary¶
from lsst.pipe.tasks.assembleCoadd import SafeClipAssembleCoaddTask
-
class
SafeClipAssembleCoaddTask Assemble a coadded image from a set of coadded temporary exposures, being careful to clip & flag areas with potential artifacts
...
-
attribute
config Access configuration fields and retargetable subtasks.
-
method
run Assemble a coadd from input warps
...
-
method
runDataRef 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
inputMapper¶
- Default
lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask- Field type
ConfigurableField
Input map creation subtask.
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¶
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.
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¶
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).
doInterp¶
Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly.
doNImage¶
Create image of number of contributing exposures for each pixel
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.
externalPhotoCalibName¶
- Default
'jointcal'- Field type
strChoiceField(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. This field is only used for Gen2 middleware.externalSkyWcsName¶
- Default
'jointcal'- Field type
strChoiceField(optional)- Choices
'jointcal'- Use jointcal_wcs
None- Field 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.
maxClipFootOverlapDouble¶
Maximum fractional overlap of clipped footprints with visit DETECTED when considering two visits
minBigOverlap¶
Minimum number of pixels in footprint to use DETECTED mask from the single visits when labeling clipped footprints
minClipFootOverlap¶
Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped
minClipFootOverlapDouble¶
Minimum fractional overlap of clipped footprints with visit DETECTED to be clipped when two visits overlap
minClipFootOverlapSingle¶
Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped when only one visit overlaps
removeMaskPlanes¶
Mask planes to remove before coadding
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.