lsst.meas.algorithms
21.0.0-12-g63909ac9+643a1044a5
|
Task to measure aperture correction. More...
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 | |
Task to measure aperture correction.
@section measAlg_MeasureApCorrTask_Contents Contents - @ref measAlg_MeasureApCorrTask_Purpose - @ref measAlg_MeasureApCorrTask_Config - @ref measAlg_MeasureApCorrTask_Debug @section measAlg_MeasureApCorrTask_Purpose Description @copybrief MeasureApCorrTask This task measures aperture correction for the flux fields returned by lsst.meas.base.getApCorrNameSet() The main method is @ref MeasureApCorrTask.run "run". @section measAlg_MeasureApCorrTask_Config Configuration parameters See @ref MeasureApCorrConfig @section measAlg_MeasureApCorrTask_Debug Debug variables The @link lsst.pipe.base.cmdLineTask.CmdLineTask command line task@endlink interface supports a flag `--debug` to import `debug.py` from your `$PYTHONPATH`; see @ref baseDebug for more about `debug.py`. MeasureApCorrTask has a debug dictionary containing a single boolean key: <dl> <dt>display <dd>If True: will show plots as aperture corrections are fitted </dl> For example, put something like: @code{.py} 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 @endcode 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.
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.
def lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.run | ( | self, | |
exposure, | |||
catalog | |||
) |
Measure aperture correction.
@param[in] 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. @param[in] catalog SourceCatalog containing measurements to be used to compute aperturecorrections. @return 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.
|
static |
Definition at line 165 of file measureApCorr.py.
lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.refFluxKeys |
Definition at line 178 of file measureApCorr.py.
lsst.meas.algorithms.measureApCorr.MeasureApCorrTask.toCorrect |
Definition at line 179 of file measureApCorr.py.