CompareWarpAssembleCoaddTask¶
Python API summary¶
from lsst.pipe.tasks.assembleCoadd import CompareWarpAssembleCoaddTask
-
class
CompareWarpAssembleCoaddTask Assemble a compareWarp coadded image from a set of warps by masking artifacts detected by comparing PSF-matched warps
...
-
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 CompareWarpAssembleCoaddTask API reference for complete details.
Retargetable subtasks¶
assembleStaticSkyModel¶
- Default
- Field type
Task to assemble an artifact-free, PSF-matched Coadd to serve as a naive/first-iteration model of the static sky.
detect¶
- Default
lsst.meas.algorithms.detection.SourceDetectionTask- Field type
Detect outlier sources on difference between each psfMatched warp and static sky model
detectTemplate¶
- Default
lsst.meas.algorithms.detection.SourceDetectionTask- Field type
Detect sources on static sky model. Only used if doPreserveContainedBySource is True
inputRecorder¶
Subtask that helps fill CoaddInputs catalogs added to the final Exposure
scaleZeroPoint¶
- Default
- Field type
Task to adjust the photometric zero point of the coadd temp exposures
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
Configuration for CoaddPsf
connections¶
- Data type
lsst.pipe.base.config.Connections- Field type
Configurations describing the connections of the PipelineTask to datatypes
doApplyUberCal¶
Apply jointcal WCS and PhotoCalib results to input calexps?
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
doPrefilterArtifacts¶
Ignore artifact candidates that are mostly covered by the bad pixel mask, because they will be excluded anyway. This prevents them from contributing to the outlier epoch count image and potentially being labeled as persistant.’Mostly’ is defined by the config ‘prefilterArtifactsRatio’.
doPreserveContainedBySource¶
Rescue artifacts from clipping that completely lie within a footprint detectedon the PsfMatched Template Coadd. Replicates a behavior of SafeClip.
doPsfMatch¶
Match to modelPsf? Deprecated. Sets makePsfMatched=True, makeDirect=False
doScaleWarpVariance¶
Rescale Warp variance plane using empirical noise?
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.
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.
maxFractionEpochsHigh¶
- Default
0.03- Field type
- Range
[0.0,1.0)
Fraction of local number of epochs (N) to use as effective maxNumEpochs for high N. Effective maxNumEpochs = min(maxFractionEpochsLow * N, maxNumEpochs + maxFractionEpochsHigh * N)
maxFractionEpochsLow¶
- Default
0.4- Field type
- Range
[0.0,1.0)
Fraction of local number of epochs (N) to use as effective maxNumEpochs for low N. Effective maxNumEpochs = min(maxFractionEpochsLow * N, maxNumEpochs + maxFractionEpochsHigh * N)
maxNumEpochs¶
Charactistic maximum local number of epochs/visits in which an artifact candidate can appear and still be masked. The effective maxNumEpochs is a broken linear function of local number of epochs (N): min(maxFractionEpochsLow*N, maxNumEpochs + maxFractionEpochsHigh*N). For each footprint detected on the image difference between the psfMatched warp and static sky model, if a significant fraction of pixels (defined by spatialThreshold) are residuals in more than the computed effective maxNumEpochs, the artifact candidate is deemed persistant rather than transient and not masked.
prefilterArtifactsMaskPlanes¶
Prefilter artifact candidates that are mostly covered by these bad mask planes.
prefilterArtifactsRatio¶
Prefilter artifact candidates with less than this fraction overlapping good pixels
removeMaskPlanes¶
Mask planes to remove before coadding
sigmaClip¶
Sigma for outlier rejection; ignored if non-clipping statistic selected.
spatialThreshold¶
- Default
0.5- Field type
- Range
[0.0,1.0]
Unitless fraction of pixels defining how much of the outlier region has to meet the temporal criteria. If 0, clip all. If 1, clip none.
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.
useMeasMosaic¶
Use meas_mosaic’s applyMosaicResultsExposure() to do the photometric calibration/wcs update (deprecated).