CalibrateTask¶
Python API summary¶
from lsst.pipe.tasks.calibrate import CalibrateTask
-
class
(butler=None, astromRefObjLoader=None, photoRefObjLoader=None, icSourceSchema=None, initInputs=None, **kwargs)CalibrateTask
!Calibrate an exposure: measure sources and perform astrometric and photometric calibration
...
-
attribute
config
Access configuration fields and retargetable subtasks.
-
method
(exposure, exposureIdInfo=None, background=None, icSourceCat=None)run
!Calibrate an exposure (science image or coadd)
...
-
method
(dataRef, exposure=None, background=None, icSourceCat=None, doUnpersist=True)runDataRef
!Calibrate an exposure, optionally unpersisting inputs and persisting outputs
...
See also
See the CalibrateTask
API reference for complete details.
Retargetable subtasks¶
astromRefObjLoader¶
- Default
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask
- Field type
reference object loader for astrometric calibration
astrometry¶
- Default
lsst.meas.astrom.astrometry.AstrometryTask
- Field type
Perform astrometric calibration to refine the WCS
catalogCalculation¶
Subtask to run catalogCalculation plugins on catalog
deblend¶
- Default
lsst.meas.deblender.deblend.SourceDeblendTask
- Field type
Split blended sources into their components
evalLocCalib¶
- Default
lsst.meas.base.evaluateLocalCalibration.EvaluateLocalCalibrationTask
- Field type
Task to strip calibrations from an exposure and store their local values in the output source catalog.
photoRefObjLoader¶
- Default
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask
- Field type
reference object loader for photometric calibration
Configuration fields¶
checkUnitsParseStrict¶
Strictness of Astropy unit compatibility check, can be ‘raise’, ‘warn’ or ‘silent’
connections¶
- Data type
lsst.pipe.base.config.Connections
- Field type
Configurations describing the connections of the PipelineTask to datatypes
doEvalLocCalibration¶
Store calibration products (local wcs and PhotoCalib) in output source catalog.
doWriteExposure¶
Write the calexp? If fakes have been added then we do not want to write out the calexp as a normal calexp but as a fakes_calexp.
doWriteHeavyFootprintsInSources¶
Include HeavyFootprint data in source table? If false then heavy footprints are saved as normal footprints, which saves some space
doWriteMatches¶
Write reference matches (ignored if doWrite false)?
doWriteMatchesDenormalized¶
Write reference matches in denormalized format? This format uses more disk space, but is more convenient to read. Ignored if doWriteMatches=False or doWrite=False.
icSourceFieldsToCopy¶
Fields to copy from the icSource catalog to the output catalog for matching sources Any missing fields will trigger a RuntimeError exception. Ignored if icSourceCat is not provided.
matchRadiusPix¶
Match radius for matching icSourceCat objects to sourceCat objects (pixels)
requireAstrometry¶
Raise an exception if astrometry fails? Ignored if doAstrometry false.