CpSkySubtractBackgroundTask

CpSkySubtractBackgroundTask subtracts the scaled full-focal plane model created by CpSkyScaleMeasureTask from the per-detector images created by CpSkyImageTask.

Processing summary

CpSkySubtractBackgroundTask runs these operations:

1. Subtract the scaled focal-plane model from the per-detector image.

2. Remeasure the residual background.

Python API summary

from lsst.cp.pipe.cpSkyTask import CpSkySubtractBackgroundTask

classCpSkySubtractBackgroundTask(**kwargs)

Subtract per-exposure background from individual detector masked images...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(inputExp, inputBkg, inputScale)

Subtract per-exposure background from individual detector masked images...

See also

See the CpSkySubtractBackgroundTask API reference for complete details.

Retargetable subtasks

sky

Default

lsst.pipe.tasks.background.SkyMeasurementTask

Field type

ConfigurableField

Sky measurement

Configuration fields

connections

Data type

lsst.pipe.base.config.CpSkySubtractBackgroundConfigConnections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

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. Deprecated: This field is deprecated and will be removed after v26.