CpSkySubtractBackgroundTask

class lsst.cp.pipe.CpSkySubtractBackgroundTask(**kwargs)

Bases: PipelineTask

Subtract per-exposure background from individual detector masked images.

The cpSkyMaskedIsr images constructed by CpSkyImageTask have the scaled background constructed by CpSkyScaleMeasureTask subtracted, and new background models are constructed for the remaining signal.

The output was called icExpBackground in gen2, but the product created here has definition clashes that prevent that from being reused.

Methods Summary

run(inputExp, inputBkg, inputScale)	Subtract per-exposure background from individual detector masked images.
runQuantum(butlerQC, inputRefs, outputRefs)	Ensure that the input and output dimensions are passed along.

Methods Documentation

run(inputExp, inputBkg, inputScale)

Subtract per-exposure background from individual detector masked images.

Parameters

inputExplsst.afw.image.Exposure

The ISR processed, detection masked image.

inputBkg`lsst.pipe.tasks.background.FocalPlaneBackground.

Full focal plane background for this exposure.

inputScalelsst.daf.base.PropertyList

Metadata containing the scale factor.

Returns

resultslsst.pipe.base.Struct

The results struct containing:

outputBkg

Remnant sky background with the full-exposure component removed. (lsst.afw.math.BackgroundList)

runQuantum(butlerQC, inputRefs, outputRefs)

Ensure that the input and output dimensions are passed along.

Parameters

butlerQClsst.daf.butler.QuantumContext

Butler to operate on.

inputRefslsst.pipe.base.InputQuantizedConnection

Input data refs to load.

outputRefslsst.pipe.base.OutputQuantizedConnection

Output data refs to persist.