CompareWarpAssembleCoaddTask¶

Python API summary¶

from lsst.pipe.tasks.assembleCoadd import CompareWarpAssembleCoaddTask

classCompareWarpAssembleCoaddTask(*args, **kwargs): Assemble a compareWarp coadded image from a set of warps by masking artifacts detected by comparing PSF-matched warps...

attributeconfig: Access configuration fields and retargetable subtasks.

methodrun(skyInfo, tempExpRefList, imageScalerList, weightList, supplementaryData): Assemble a coadd from input warps...

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

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

maskStreaks¶

Default: lsst.pipe.tasks.maskStreaks.MaskStreaksTask
Field type: ConfigurableField

Detect streaks on difference between each psfMatched warp and static sky model. Only used if doFilterMorphological is True. Adds a mask plane to an exposure, with the mask plane name set bystreakMaskName

modelPsf¶

Default: lsst.meas.algorithms.gaussianPsfFactory.applyWrapper
Field type: ConfigurableField

Model Psf factory

scaleWarpVariance¶

Default: lsst.meas.algorithms.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.PsfWcsSelectImagesTask
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.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¶

Default: False
Field type: bool Field

Whether to apply external photometric calibration via an lsst.afw.image.PhotoCalib object. Uses the externalPhotoCalibName field to determine which calibration to load.

doApplyExternalSkyWcs¶

Default: False
Field type: bool Field

Whether to apply external astrometric calibration via an lsst.afw.geom.SkyWcs object. Uses externalSkyWcsName field to determine which calibration to load.

doAttachTransmissionCurve¶

Default: False
Field type: bool Field

Attach a piecewise TransmissionCurve for the coadd? (requires all input Exposures to have TransmissionCurves).

doFilterMorphological¶

Default: False
Field type: bool Field

Filter artifact candidates based on morphological criteria, i.g. those that appear to be streaks.

doInputMap¶

Default: False
Field type: bool Field

Create a bitwise map of coadd inputs

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

doOnlineForMean¶

Default: False
Field type: bool Field

Perform online coaddition when statistic=”MEAN” to save memory?

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?

doSelectVisits¶

Default: False
Field type: bool Field

Coadd only visits selected by a SelectVisitsTask

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?

externalPhotoCalibName¶

Default

'jointcal'

Field type

str ChoiceField (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. Deprecated: This configuration is no longer used, and will be removed after v25.0

externalSkyWcsName¶

Default

'jointcal'

Field type

str ChoiceField (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. Deprecated: This configuration is no longer used, and will be removed after v25.0

growStreakFp¶

Default: 5
Field type: float Field

Grow streak footprints by this number multiplied by the PSF width

hasFakes¶

Default: False
Field type: bool Field

Should be set to True if fake sources have been inserted into the input data.

includeCalibVar¶

Default: False
Field type: bool Field

Add photometric calibration variance to warp variance plane.

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.

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.

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

removeMaskPlanes¶

Default: ['NOT_DEBLENDED']
Field type: str ListField

Mask planes to remove before coadding

saveLogOutput¶

Default: True
Field type: bool Field

Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata¶

Default: True
Field type: bool Field

Flag to enable/disable metadata saving for a task, enabled by default.

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.

statistic¶

Default: 'MEANCLIP'
Field type: str Field

Main stacking statistic for aggregating over the epochs.

streakMaskName¶

Default: 'STREAK'
Field type: str Field

Name of mask bit used for streaks

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.

useGlobalExternalPhotoCalib¶

Default: True
Field type: bool Field

When using doApplyExternalPhotoCalib, use ‘global’ calibrations that are not run per-tract. When False, use per-tract photometric calibration files.

useGlobalExternalSkyWcs¶

Default: True
Field type: bool Field

When using doApplyExternalSkyWcs, use ‘global’ calibrations that are not run per-tract. When False, use per-tract wcs files.

warpType¶

Default: 'direct'
Field type: str Field

Warp name: one of ‘direct’ or ‘psfMatched’

Navigation