Inheritance diagram for lsst.meas.algorithms.measureApCorr.MeasureApCorrTask:

Public Member Functions
	__init__ (self, schema, namesToCorrect=None, **kwargs)

	run (self, exposure, catalog)

Public Attributes
	refFluxNames = _FluxNames(self.config.refFluxName, schema)

dict	toCorrect = {}

Static Public Attributes
	ConfigClass = MeasureApCorrConfig

Static Protected Attributes
str	_DefaultName = "measureApCorr"

Detailed Description

Task 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}_used`` fields.
namesToCorrect : `list` [`str`], optional
    List of names to correct.  If `None` then 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.

Definition at line 186 of file measureApCorr.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.__init__	(		self,
			schema,
			namesToCorrect = None,
		**	kwargs )

Definition at line 212 of file measureApCorr.py.

Member Function Documentation

◆ run()

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.run	(	self,
		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:

    ``apCorrMap``
        aperture 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

Definition at line 225 of file measureApCorr.py.

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.measureApCorr.MeasureApCorrTask._DefaultName = "measureApCorr"

staticprotected

Definition at line 210 of file measureApCorr.py.

◆ ConfigClass

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.ConfigClass = MeasureApCorrConfig

static

Definition at line 209 of file measureApCorr.py.

◆ refFluxNames

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.refFluxNames = _FluxNames(self.config.refFluxName, schema)

Definition at line 214 of file measureApCorr.py.

◆ toCorrect

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.toCorrect = {}

Definition at line 215 of file measureApCorr.py.

The documentation for this class was generated from the following file:

python/lsst/meas/algorithms/measureApCorr.py

Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Attributes