CalibStatsTask

CalibStatsTask provides a uniform way to measure image background statistics.

Processing summary

CalibStatsTask runs these operations:

1. Defines an lsst.afw.math.StatisticsControl object from the config.
2. Identifies the correct level to operation on the image.
3. Measures the requested statistics.

Python API summary

from lsst.cp.pipe.cpCombine import CalibStatsTask

classCalibStatsTask(config: Optional[Config] = None, name: Optional[str] = None, parentTask: Optional[Task] = None, log: Optional[Union[logging.Logger, lsst.utils.logging.LsstLogAdapter]] = None)

Measure statistics on the background...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(exposureOrImage)

Measure a particular statistic on an image (of some sort)...

See also

See the CalibStatsTask API reference for complete details.

Retargetable subtasks

No subtasks.

Configuration fields

clip

Default

3.0

Field type

float Field

Clipping threshold for background

mask

Default

['DETECTED', 'BAD', 'NO_DATA']

Field type

str ListField

Mask planes to reject

nIter

Default

3

Field type

int Field

Clipping iterations for background

stat

Default

'MEANCLIP'

Field type

str Field

Statistic name to use to estimate background (from Property)