lsst.pipe.tasks
13.0-66-gfbf2f2ce+5
|
Calibrate an exposure: measure sources and perform astrometric and photometric calibration. More...
Public Member Functions | |
def | __init__ (self, butler=None, astromRefObjLoader=None, photoRefObjLoader=None, icSourceSchema=None, kwargs) |
Construct a CalibrateTask. More... | |
def | run (self, dataRef, exposure=None, background=None, icSourceCat=None, doUnpersist=True) |
Calibrate an exposure, optionally unpersisting inputs and persisting outputs. More... | |
def | calibrate (self, exposure, exposureIdInfo=None, background=None, icSourceCat=None) |
Calibrate an exposure (science image or coadd) More... | |
def | writeOutputs (self, dataRef, exposure, background, sourceCat, astromMatches, matchMeta) |
def | getSchemaCatalogs (self) |
def | setMetadata (self, exposure, photoRes=None) |
Set task and exposure metadata. More... | |
def | copyIcSourceFields (self, icSourceCat, sourceCat) |
Match sources in icSourceCat and sourceCat and copy the specified fields. More... | |
Public Attributes | |
schemaMapper | |
calibSourceKey | |
schema | |
algMetadata | |
pixelMargin | |
Static Public Attributes | |
ConfigClass = CalibrateConfig | |
RunnerClass = pipeBase.ButlerInitializedTaskRunner | |
Calibrate an exposure: measure sources and perform astrometric and photometric calibration.
Given an exposure with a good PSF model and aperture correction map (e.g. as provided by Task Documentation), perform the following operations:
Construct a CalibrateTask.
[in] | butler | The butler is passed to the refObjLoader constructor in case it is needed. Ignored if the refObjLoader argument provides a loader directly. |
[in] | astromRefObjLoader | An instance of LoadReferenceObjectsTasks that supplies an external reference catalog for astrometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled. |
[in] | photoRefObjLoader | An instance of LoadReferenceObjectsTasks that supplies an external reference catalog for photometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled. |
[in] | icSourceSchema | schema for icSource catalog, or None. Schema values specified in config.icSourceFieldsToCopy will be taken from this schema. If set to None, no values will be propagated from the icSourceCatalog |
[in,out] | kwargs | other keyword arguments for lsst.pipe.base.CmdLineTask |
If you want this task to unpersist inputs or persist outputs, then call the run
method (a wrapper around the calibrate
method).
If you already have the inputs unpersisted and do not want to persist the output then it is more direct to call the calibrate
method:
See CalibrateConfig
Exposure metadata
The command line task interface supports a flag --debug
to import debug.py
from your $PYTHONPATH
; see baseDebug for more about debug.py
.
CalibrateTask has a debug dictionary containing one key:
For example, put something like:
into your debug.py
file and run calibrateTask.py
with the --debug
flag.
Some subtasks may have their own debug variables; see individual Task documentation.
Definition at line 183 of file calibrate.py.
def lsst.pipe.tasks.calibrate.CalibrateTask.__init__ | ( | self, | |
butler = None , |
|||
astromRefObjLoader = None , |
|||
photoRefObjLoader = None , |
|||
icSourceSchema = None , |
|||
kwargs | |||
) |
Construct a CalibrateTask.
[in] | butler | The butler is passed to the refObjLoader constructor in case it is needed. Ignored if the refObjLoader argument provides a loader directly. |
[in] | astromRefObjLoader | An instance of LoadReferenceObjectsTasks that supplies an external reference catalog for astrometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled. |
[in] | photoRefObjLoader | An instance of LoadReferenceObjectsTasks that supplies an external reference catalog for photometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled. |
[in] | icSourceSchema | schema for icSource catalog, or None. Schema values specified in config.icSourceFieldsToCopy will be taken from this schema. If set to None, no values will be propagated from the icSourceCatalog |
[in,out] | kwargs | other keyword arguments for lsst.pipe.base.CmdLineTask |
Definition at line 281 of file calibrate.py.
def lsst.pipe.tasks.calibrate.CalibrateTask.calibrate | ( | self, | |
exposure, | |||
exposureIdInfo = None , |
|||
background = None , |
|||
icSourceCat = None |
|||
) |
Calibrate an exposure (science image or coadd)
[in,out] | exposure | exposure to calibrate (an lsst.afw.image.ExposureF or similar); in:
|
[in] | exposureIdInfo | ID info for exposure (an lsst.obs.base.ExposureIdInfo) If not provided, returned SourceCatalog IDs will not be globally unique. |
[in,out] | background | background model already subtracted from exposure (an lsst.afw.math.BackgroundList). May be None if no background has been subtracted, though that is unusual for calibration. A refined background model is output. |
[in] | icSourceCat | A SourceCatalog from CharacterizeImageTask from which we can copy some fields. |
Definition at line 449 of file calibrate.py.
def lsst.pipe.tasks.calibrate.CalibrateTask.copyIcSourceFields | ( | self, | |
icSourceCat, | |||
sourceCat | |||
) |
Match sources in icSourceCat and sourceCat and copy the specified fields.
[in] | icSourceCat | catalog from which to copy fields |
[in,out] | sourceCat | catalog to which to copy fields |
The fields copied are those specified by config.icSourceFieldsToCopy
that actually exist in the schema. This was set up by the constructor using self.schemaMapper.
Definition at line 632 of file calibrate.py.
def lsst.pipe.tasks.calibrate.CalibrateTask.getSchemaCatalogs | ( | self | ) |
Return a dict of empty catalogs for each catalog dataset produced by this task.
Definition at line 593 of file calibrate.py.
def lsst.pipe.tasks.calibrate.CalibrateTask.run | ( | self, | |
dataRef, | |||
exposure = None , |
|||
background = None , |
|||
icSourceCat = None , |
|||
doUnpersist = True |
|||
) |
Calibrate an exposure, optionally unpersisting inputs and persisting outputs.
This is a wrapper around the calibrate
method that unpersists inputs (if doUnpersist
true) and persists outputs (if config.doWrite
true)
[in] | dataRef | butler data reference corresponding to a science image |
[in,out] | exposure | characterized exposure (an lsst.afw.image.ExposureF or similar), or None to unpersist existing icExp and icBackground. See calibrate method for details of what is read and written. |
[in,out] | background | initial model of background already subtracted from exposure (an lsst.afw.math.BackgroundList). May be None if no background has been subtracted, though that is unusual for calibration. A refined background model is output. Ignored if exposure is None. |
[in] | icSourceCat | catalog from which to copy the fields specified by icSourceKeys, or None; |
[in] | doUnpersist | unpersist data:
|
Definition at line 385 of file calibrate.py.
def lsst.pipe.tasks.calibrate.CalibrateTask.setMetadata | ( | self, | |
exposure, | |||
photoRes = None |
|||
) |
Set task and exposure metadata.
Logs a warning and continues if needed data is missing.
[in,out] | exposure | exposure whose metadata is to be set |
[in] | photoRes | results of running photoCal; if None then it was not run |
Definition at line 601 of file calibrate.py.
def lsst.pipe.tasks.calibrate.CalibrateTask.writeOutputs | ( | self, | |
dataRef, | |||
exposure, | |||
background, | |||
sourceCat, | |||
astromMatches, | |||
matchMeta | |||
) |
Write output data to the output repository @param[in] dataRef butler data reference corresponding to a science image @param[in] exposure exposure to write @param[in] background background model for exposure @param[in] sourceCat catalog of measured sources @param[in] astromMatches list of source/refObj matches from the astrometry solver
Definition at line 569 of file calibrate.py.
lsst.pipe.tasks.calibrate.CalibrateTask.algMetadata |
Definition at line 347 of file calibrate.py.
lsst.pipe.tasks.calibrate.CalibrateTask.calibSourceKey |
Definition at line 321 of file calibrate.py.
|
static |
Definition at line 276 of file calibrate.py.
lsst.pipe.tasks.calibrate.CalibrateTask.pixelMargin |
Definition at line 367 of file calibrate.py.
|
static |
Definition at line 278 of file calibrate.py.
lsst.pipe.tasks.calibrate.CalibrateTask.schema |
Definition at line 341 of file calibrate.py.
lsst.pipe.tasks.calibrate.CalibrateTask.schemaMapper |
Definition at line 312 of file calibrate.py.