MeasureApCorrTask

MeasureApCorrTask measures aperture correction for the flux fields returned by lsst.meas.base.getApCorrNameSet.

Python API summary

from lsst.meas.algorithms.measureApCorr import MeasureApCorrTask

classMeasureApCorrTask(schema, **kwds)

Task to measure aperture correction...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(exposure, catalog)

Measure aperture correction...

See also

See the MeasureApCorrTask API reference for complete details.

Retargetable subtasks

sourceSelector

Default

'flagged'

Field type

Single-selection RegistryField

Choices

'science'

lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask

'references'

lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask

'objectSize'

lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask

'flagged'

lsst.meas.algorithms.flaggedSourceSelector.FlaggedSourceSelectorTask

'astrometry'

lsst.meas.algorithms.astrometrySourceSelector.AstrometrySourceSelectorTask

'matcher'

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask

'diaCatalog'

lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask

Selector that sets the stars that aperture corrections will be measured from.

Configuration fields

allowFailure

Default

[]

Field type

str ListField

Allow these measurement algorithms to fail without an exception

fitConfig

Data type

lsst.afw.math._chebyshevBoundedFieldConfig.ChebyshevBoundedFieldConfig

Field type

ConfigField

Configuration used in fitting the aperture correction fields

minDegreesOfFreedom

Default

1

Field type

int RangeField

Range

[1,inf)

Minimum number of degrees of freedom (# of valid data points - # of parameters); if this is exceeded, the order of the fit is decreased (in both dimensions), and if we can’t decrease it enough, we’ll raise ValueError.

numIter

Default

4

Field type

int Field

Number of iterations for sigma clipping

numSigmaClip

Default

3.0

Field type

float Field

Number of standard devisations to clip at

refFluxName

Default

'slot_CalibFlux'

Field type

str Field

Field name prefix for the flux other measurements should be aperture corrected to match

Debugging

MeasureApCorrTask has a debug dictionary containing two boolean keys:

doPause

bool; Pause to inspect the residuals plot? If False, there will be a 4 second delay to allow for inspection of the plot before closing it and moving on.

display

bool; if True display debug information