ComputeExposureSummaryStatsTask

Python API summary

from lsst.pipe.tasks.computeExposureSummaryStats import ComputeExposureSummaryStatsTask
classComputeExposureSummaryStatsTask(**kwargs)

Task to compute exposure summary statistics...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(exposure, sources, background)

Measure exposure statistics from the exposure, sources, and background...

See also

See the ComputeExposureSummaryStatsTask API reference for complete details.

Retargetable subtasks

starSelector

Default

lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask

Field type

ConfigurableField

Selection of sources to compute PSF star statistics.

Configuration fields

badMaskPlanes

Default
('NO_DATA', 'SUSPECT')
Field type

str ListField

Mask planes that, if set, the associated pixel should not be included sky noise calculation.

clipIter

Default
2
Field type

int Field

Number of iterations of outlier rejection for sky noise.

fiducialPsfSigma

Default
{'u': 1.0, 'g': 1.0, 'r': 1.0, 'i': 1.0, 'z': 1.0, 'y': 1.0}
Field type

DictField

Key type

str

Value type

float

Fiducial PSF sigma (pixels) assumed when calculating effective exposure time. Keyed by band.

fiducialSkyBackground

Default
{'u': 1.0, 'g': 1.0, 'r': 1.0, 'i': 1.0, 'z': 1.0, 'y': 1.0}
Field type

DictField

Key type

str

Value type

float

Fiducial sky background level (ADU/s) assumed when calculating effective exposure time. Keyed by band.

fiducialZeroPoint

Default
{'u': 25.0, 'g': 25.0, 'r': 25.0, 'i': 25.0, 'z': 25.0, 'y': 25.0}
Field type

DictField

Key type

str

Value type

float

Fiducial zero point assumed when calculating effective exposure time. Keyed by band.

maxEffectiveTransparency

Default
inf
Field type

float Field

Maximum value allowed for effective transparency scale factor (often inf or 1.0).

minPsfApRadiusPix

Default
2.0
Field type

float Field

Minimum radius in pixels of the aperture within which to measure the flux of the PSF model for the psfApFluxDelta metric calculation (the radius is computed as max(minPsfApRadius, 3*psfSigma)).

psfApCorrFieldName

Default
'base_PsfFlux_instFlux'
Field type

str Field

Name of the flux column associated with the aperture correction of the PSF model to use for the psfApCorrSigmaScaledDelta metric calculation.

psfBadMaskPlanes

Default
('BAD', 'CR', 'EDGE', 'INTRP', 'NO_DATA', 'SAT', 'SUSPECT')
Field type

str ListField

Mask planes that, if set, the associated pixel should not be included in the PSF model robutsness metric calculations (namely, maxDistToNearestPsf and psfTraceRadiusDelta).

psfGridSampling

Default
96
Field type

int Field

Sampling rate in pixels in each dimension for PSF model robustness metric caclulations grid (the tradeoff is between adequate sampling versus speed).

psfSampling

Default
8
Field type

int Field

Sampling rate in pixels in each dimension for the maxDistToNearestPsf metric caclulation grid (the tradeoff is between adequate sampling versus speed).

psfShape

Default
'slot_PsfShape'
Field type

str Field

Base name of columns to use for the PSF shape in the PSF statistics computation.

sigmaClip

Default
3.0
Field type

float Field

Sigma for outlier rejection for sky noise.

starSelection

Default
'calib_psf_used'
Field type

str Field

Field to select full list of sources used for PSF modeling.

starShape

Default
'slot_Shape'
Field type

str Field

Base name of columns to use for the source shape in the PSF statistics computation.