MeasureApCorrTask#
- class lsst.meas.algorithms.MeasureApCorrTask(schema, namesToCorrect=None, **kwargs)#
Bases:
TaskTask to measure aperture correction.
For every name to correct, a new field apcorr_{name}_used will be added, and will be logged in self.toCorrect.
Parameters#
- schema
lsst.afw.table.Schema Schema for the input table; will be modified in place to add
apcorr_{name}_usedfields.- namesToCorrect
list[str], optional List of names to correct. If
Nonethen the set of registered fields in lsst.meas.base.getApCorrNameSet() will be used.- **kwargs
dict Additional kwargs to pass to lsst.pipe.base.Task.__init__()
Raises#
MeasureApCorrError if any of the names to correct fails and is not in the config.allowFailure list.
Methods Summary
run(exposure, catalog)Measure aperture correction
Methods Documentation
- run(exposure, catalog)#
Measure aperture correction
Parameters#
- exposure
lsst.afw.image.Exposure Exposure aperture corrections are being measured on. The bounding box is retrieved from it, and it is passed to the sourceSelector. The output aperture correction map is not added to the exposure; this is left to the caller.
- catalog
lsst.afw.table.SourceCatalog SourceCatalog containing measurements to be used to compute aperture corrections.
Returns#
- Struct
lsst.pipe.base.Struct Contains the following:
apCorrMapaperture correction map (
lsst.afw.image.ApCorrMap) that contains two entries for each flux field: - flux field (e.g. base_PsfFlux_instFlux): 2d model - flux sigma field (e.g. base_PsfFlux_instFluxErr): 2d model of error
- exposure
- schema