lsst.meas.algorithms  19.0.0-20-g5a5a17ab+8
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.measureApCorr.MeasureApCorrTask Class Reference

Task to measure aperture correction. More...

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

Public Member Functions

def __init__ (self, schema, **kwds)
 Construct a MeasureApCorrTask. More...
 
def run (self, exposure, catalog)
 Measure aperture correction. More...
 

Public Attributes

 refFluxKeys
 
 toCorrect
 

Static Public Attributes

 ConfigClass = MeasureApCorrConfig
 

Detailed Description

Task to measure aperture correction.

Contents

Description

Task to measure aperture correction.

This task measures aperture correction for the flux fields returned by lsst.meas.base.getApCorrNameSet()

The main method is run.

Configuration parameters

See MeasureApCorrConfig

Debug variables

The command line task interface supports a flag --debug to import debug.py from your $PYTHONPATH; see Using lsstDebug to control debugging output for more about debug.py.

MeasureApCorrTask has a debug dictionary containing a single boolean key:

display
If True: will show plots as aperture corrections are fitted

For example, put something like:

import lsstDebug
def DebugInfo(name):
di = lsstDebug.getInfo(name) # N.b. lsstDebug.Info(name) would call us recursively
if name == "lsst.meas.algorithms.measureApCorr":
di.display = dict(
unsubtracted = 1,
subtracted = 2,
background = 3,
)
return di
lsstDebug.Info = DebugInfo

into your debug.py file and run your command-line task with the --debug flag (or import debug).

Definition at line 114 of file measureApCorr.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.__init__ (   self,
  schema,
**  kwds 
)

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

Member Function Documentation

◆ run()

def lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.run (   self,
  exposure,
  catalog 
)

Measure aperture correction.

Parameters
[in]exposureExposure 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.
[in]catalogSourceCatalog containing measurements to be used to compute aperturecorrections.
Returns
an lsst.pipe.base.Struct containing:
  • apCorrMap: an 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 188 of file measureApCorr.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 165 of file measureApCorr.py.

◆ refFluxKeys

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.refFluxKeys

Definition at line 178 of file measureApCorr.py.

◆ toCorrect

lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.toCorrect

Definition at line 179 of file measureApCorr.py.


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