ComputeExposureSummaryStatsConfig

class lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig(*args, **kw)

Bases: Config

Config for ComputeExposureSummaryTask

Attributes Summary

badMaskPlanes	Mask planes that, if set, the associated pixel should not be included sky noise calculation.
clipIter	Number of iterations of outlier rejection for sky noise.
fiducialExpTime	Fiducial exposure time (seconds).
fiducialMagLim	Fiducial magnitude limit depth at SNR=5.
fiducialPsfSigma	Fiducial PSF sigma (pixels) assumed when calculating effective exposure time.
fiducialReadNoise	Fiducial readnoise (electrons) assumed when calculating effective exposure time.
fiducialSkyBackground	Fiducial sky background level (ADU/s) assumed when calculating effective exposure time.
fiducialZeroPoint	Fiducial zero point assumed when calculating effective exposure time.
magLimSnr	Signal-to-noise ratio for computing the magnitude limit depth.
maxEffectiveTransparency	Maximum value allowed for effective transparency scale factor (often inf or 1.0).
minPsfApRadiusPix	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	Name of the flux column associated with the aperture correction of the PSF model to use for the psfApCorrSigmaScaledDelta metric calculation.
psfBadMaskPlanes	Mask planes that, if set, the associated pixel should not be included in the PSF model robutsness metric calculations (namely, maxDistToNearestPsf and psfTraceRadiusDelta).
psfGridSampling	Sampling rate in pixels in each dimension for PSF model robustness metric caclulations grid (the tradeoff is between adequate sampling versus speed).
psfSampling	Sampling rate in pixels in each dimension for the maxDistToNearestPsf metric caclulation grid (the tradeoff is between adequate sampling versus speed).
psfShape	Base name of columns to use for the PSF shape in the PSF statistics computation.
sigmaClip	Sigma for outlier rejection for sky noise.
starHigherOrderMomentBase	Base name of the columns from which to obtain the higher-order moments.
starSelection	Field to select full list of sources used for PSF modeling.
starSelector	Selection of sources to compute PSF star statistics.
starShape	Base name of columns to use for the source shape in the PSF statistics computation.

Methods Summary

fiducialMagnitudeLimit(band, pixelScale, gain)	Compute the fiducial point-source magnitude limit based on config values.
setDefaults()	Subclass hook for computing defaults.

Attributes Documentation

badMaskPlanes

Mask planes that, if set, the associated pixel should not be included sky noise calculation. (List, default ('NO_DATA', 'SUSPECT'))

clipIter

Number of iterations of outlier rejection for sky noise. (int, default 2)

fiducialExpTime

Fiducial exposure time (seconds). Keyed by band. (Dict, default {'u': 30.0, 'g': 30.0, 'r': 30.0, 'i': 30.0, 'z': 30.0, 'y': 30.0})

fiducialMagLim

Fiducial magnitude limit depth at SNR=5. Keyed by band. (Dict, default {'u': 25.0, 'g': 25.0, 'r': 25.0, 'i': 25.0, 'z': 25.0, 'y': 25.0})

fiducialPsfSigma

Fiducial PSF sigma (pixels) assumed when calculating effective exposure time. Keyed by band. (Dict, default {'u': 1.0, 'g': 1.0, 'r': 1.0, 'i': 1.0, 'z': 1.0, 'y': 1.0})

fiducialReadNoise

Fiducial readnoise (electrons) assumed when calculating effective exposure time. Keyed by band. (Dict, default {'u': 9.0, 'g': 9.0, 'r': 9.0, 'i': 9.0, 'z': 9.0, 'y': 9.0})

fiducialSkyBackground

Fiducial sky background level (ADU/s) assumed when calculating effective exposure time. Keyed by band. (Dict, default {'u': 1.0, 'g': 1.0, 'r': 1.0, 'i': 1.0, 'z': 1.0, 'y': 1.0})

fiducialZeroPoint

Fiducial zero point assumed when calculating effective exposure time. Keyed by band. (Dict, default {'u': 25.0, 'g': 25.0, 'r': 25.0, 'i': 25.0, 'z': 25.0, 'y': 25.0})

magLimSnr

Signal-to-noise ratio for computing the magnitude limit depth. (float, default 5.0)

maxEffectiveTransparency

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

minPsfApRadiusPix

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)). (float, default 2.0)

psfApCorrFieldName

Name of the flux column associated with the aperture correction of the PSF model to use for the psfApCorrSigmaScaledDelta metric calculation. (str, default 'base_PsfFlux_instFlux')

psfBadMaskPlanes

Mask planes that, if set, the associated pixel should not be included in the PSF model robutsness metric calculations (namely, maxDistToNearestPsf and psfTraceRadiusDelta). (List, default ('BAD', 'CR', 'EDGE', 'INTRP', 'NO_DATA', 'SAT', 'SUSPECT'))

psfGridSampling

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

psfSampling

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

psfShape

Base name of columns to use for the PSF shape in the PSF statistics computation. (str, default 'slot_PsfShape')

sigmaClip

Sigma for outlier rejection for sky noise. (float, default 3.0)

starHigherOrderMomentBase

Base name of the columns from which to obtain the higher-order moments. (str, default 'ext_shapeHSM_HigherOrderMomentsSource')

starSelection

Field to select full list of sources used for PSF modeling. (str, default 'calib_psf_used')

starSelector

Selection of sources to compute PSF star statistics. (ConfigurableInstance, default <class 'lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorConfig'>)

starShape

Base name of columns to use for the source shape in the PSF statistics computation. (str, default 'slot_Shape')

Methods Documentation

fiducialMagnitudeLimit(band, pixelScale, gain)

Compute the fiducial point-source magnitude limit based on config values. This follows the conventions laid out in SMTN-002, LSE-40, and DMTN-296.

Parameters

bandstr

The band of interest

pixelScalefloat

The pixel scale [arcsec/pix]

gainfloat

The instrumental gain for the exposure [e-/ADU]. The gain should be 1.0 if the image units are [e-].

Returns

magnitude_limitfloat

The fiducial magnitude limit calculated from fiducial values.

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.