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=[])

Assemble a coadd from a set of Warps...

See also

See the AssembleCoaddTask API reference for complete details.

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.coaddPsfContinued.CoaddPsfConfig

Field type

ConfigField

Configuration for CoaddPsf

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

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?

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

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’