lsst.meas.algorithms g41a93ceb71+a3dc6b54d0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.measureApCorr.MeasureApCorrTask Class Reference
Inheritance diagram for lsst.meas.algorithms.measureApCorr.MeasureApCorrTask:

Public Member Functions

def __init__ (self, schema, **kwargs)
 
def run (self, exposure, catalog)
 

Public Attributes

 refFluxNames
 
 toCorrect
 

Static Public Attributes

 ConfigClass = MeasureApCorrConfig
 

Detailed Description

Task to measure aperture correction.

Definition at line 145 of file measureApCorr.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.__init__ (   self,
  schema,
**  kwargs 
)
Construct a MeasureApCorrTask

For every name in lsst.meas.base.getApCorrNameSet():
- If the corresponding flux fields exist in the schema:
    - Add a new field apcorr_{name}_used
    - Add an entry to the self.toCorrect dict
- Otherwise silently skip the name

Definition at line 151 of file measureApCorr.py.

Member Function Documentation

◆ run()

def 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 171 of file measureApCorr.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 148 of file measureApCorr.py.

◆ refFluxNames

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.refFluxNames

Definition at line 161 of file measureApCorr.py.

◆ toCorrect

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.toCorrect

Definition at line 162 of file measureApCorr.py.


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