DcrAssembleCoaddTask

Python API summary

from lsst.pipe.tasks.dcrAssembleCoadd import DcrAssembleCoaddTask
classDcrAssembleCoaddTask(*args, **kwargs)

Assemble DCR coadded images from a set of warps...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(skyInfo, tempExpRefList, imageScalerList, weightList, supplementaryData=None)

Assemble the coadd...

methodrunDataRef(dataRef, selectDataList=[])

Assemble a coadd from a set of warps...

See also

See the DcrAssembleCoaddTask API reference for complete details.

Retargetable subtasks

assembleStaticSkyModel

Default
lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask
Field type
ConfigurableField
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
ConfigurableField
Detect outlier sources on difference between each psfMatched warp and static sky model

detectTemplate

Default
lsst.meas.algorithms.detection.SourceDetectionTask
Field type
ConfigurableField
Detect sources on static sky model. Only used if doPreserveContainedBySource is True

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

scaleWarpVariance

Default
lsst.pipe.tasks.scaleVariance.ScaleVarianceTask
Field type
ConfigurableField
Rescale variance on warps

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.

baseGain

Default
1.0
Field type
float Field
Relative weight to give the new solution when updating the model.A value of 1.0 gives equal weight to both solutions.

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.coaddPsfContinued.CoaddPsfConfig
Field type
ConfigField
Configuration for CoaddPsf

convergenceMaskPlanes

Default
['DETECTED']
Field type
str ListField
Mask planes to use to calculate convergence.

convergenceThreshold

Default
0.001
Field type
float Field
Target relative change in convergence between iterations of forward modeling.

dcrNumSubfilters

Default
3
Field type
int Field
Number of sub-filters to forward model chromatic effects to fit the supplied exposures.

doAirmassWeight

Default
True
Field type
bool Field
Weight exposures by airmass? Useful if there are relatively few high-airmass observations.

doApplyUberCal

Default
False
Field type
bool Field
Apply meas_mosaic ubercal 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

doPrefilterArtifacts

Default
True
Field type
bool Field
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

Default
True
Field type
bool Field
Rescue artifacts from clipping that completely lie within a footprint detectedon the PsfMatched Template Coadd. Replicates a behavior of SafeClip.

doPsfMatch

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

doScaleWarpVariance

Default
True
Field type
bool Field
Rescale Warp variance plane using empirical noise?

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?

imageWarpMethod

Default
'lanczos3'
Field type
str Field
Name of the warping kernel to use for shifting the image and variance planes.

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.

maskWarpMethod

Default
'bilinear'
Field type
str Field
Name of the warping kernel to use for shifting the mask plane.

matchingKernelSize

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

maxFractionEpochsHigh

Default
0.03
Field type
float RangeField
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
float RangeField
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

Default
2
Field type
int Field
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.

maxNumIter

Default
8
Field type
int Field
Maximum number of iterations of forward modeling.

minNumIter

Default
3
Field type
int Field
Minimum number of iterations of forward modeling.

modelWeightsWidth

Default
3
Field type
float Field
Width of the region around detected sources to include in the DcrModel.

prefilterArtifactsMaskPlanes

Default
('NO_DATA', 'BAD', 'SAT', 'SUSPECT')
Field type
str ListField
Prefilter artifact candidates that are mostly covered by these bad mask planes.

prefilterArtifactsRatio

Default
0.05
Field type
float Field
Prefilter artifact candidates with less than this fraction overlapping good pixels

regularizationWidth

Default
2
Field type
int Field
Minimum radius of a region to include in regularization, in pixels.

regularizeModelFrequency

Default
2.0
Field type
float Field
Maximum relative change of the model allowed between subfilters.Set to zero to disable.

regularizeModelIterations

Default
2.0
Field type
float Field
Maximum relative change of the model allowed between iterations.Set to zero to disable.

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.

spatialThreshold

Default
0.5
Field type
float RangeField
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.

splitSubfilters

Default
False
Field type
bool Field
Calculate DCR for two evenly-spaced wavelengths in each subfilter.Instead of at the midpoint

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.

useConvergence

Default
True
Field type
bool Field
Use convergence test as a forward modeling end condition?If not set, skips calculating convergence and runs for maxNumIter iterations

useModelWeights

Default
True
Field type
bool Field
Width of the region around detected sources to include in the DcrModel.

useProgressiveGain

Default
True
Field type
bool Field
Use a gain that slowly increases above baseGain to accelerate convergence?

warpType

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