CalibrateTask¶
Python API summary¶
from lsst.pipe.tasks.calibrate import CalibrateTask
-
class
CalibrateTask(butler=None, astromRefObjLoader=None, photoRefObjLoader=None, icSourceSchema=None, initInputs=None, **kwargs) Calibrate an exposure: measure sources and perform astrometric and photometric calibration
...
- attributeconfig
Access configuration fields and retargetable subtasks.
-
method
run(exposure, exposureIdInfo=None, background=None, icSourceCat=None, idGenerator=None) Calibrate an exposure
...
See also
See the CalibrateTask API reference for complete details.
Retargetable subtasks¶
applyApCorr¶
- Default
- Field type
Subtask to apply aperture corrections
astrometry¶
- Default
lsst.meas.astrom.astrometry.AstrometryTask- Field type
Perform astrometric calibration to refine the WCS
catalogCalculation¶
Subtask to run catalogCalculation plugins on catalog
computeSummaryStats¶
Subtask to run computeSummaryStats on exposure
deblend¶
- Default
lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask- Field type
Split blended sources into their components
detection¶
- Default
- Field type
Detect sources
measurement¶
- Default
- Field type
Measure sources
photoCal¶
- Default
- Field type
Perform photometric calibration
postCalibrationMeasurement¶
- Default
- Field type
Second round of measurement for plugins that need to be run after photocal
setPrimaryFlags¶
- Default
- Field type
Set flags for primary source classification in single frame processing. True if sources are not sky sources and not a parent.
skySources¶
- Default
- Field type
Generate sky sources
Configuration fields¶
astromRefObjLoader¶
- Data type
lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig- Field type
reference object loader for astrometric calibration
checkUnitsParseStrict¶
Strictness of Astropy unit compatibility check, can be ‘raise’, ‘warn’ or ‘silent’
connections¶
- Data type
lsst.pipe.base.config.CalibrateConfigConnections- Field type
Configurations describing the connections of the PipelineTask to datatypes
doApCorr¶
Run subtask to apply aperture correction
doAstrometry¶
Perform astrometric calibration?
doComputeSummaryStats¶
Run subtask to measure exposure summary statistics?
doDeblend¶
Run deblender input exposure
doPhotoCal¶
Perform phometric calibration?
doSkySources¶
Generate sky sources?
doWrite¶
Save calibration results?
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 or doAstrometry 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.
idGenerator¶
- Data type
lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig- Field type
Configuration for how to generate catalog IDs from data IDs.
matchRadiusPix¶
Match radius for matching icSourceCat objects to sourceCat objects (pixels)
photoRefObjLoader¶
- Data type
lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig- Field type
reference object loader for photometric calibration
requireAstrometry¶
Raise an exception if astrometry fails? Ignored if doAstrometry false.
requirePhotoCal¶
Raise an exception if photoCal fails? Ignored if doPhotoCal false.
saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default.
saveMetadata¶
Flag to enable/disable metadata saving for a task, enabled by default. Deprecated: This field is deprecated and will be removed after v26.