CalibrateTask

Python API summary

from lsst.pipe.tasks.calibrate import CalibrateTask
classCalibrateTask(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.

methodrun(exposure, exposureIdInfo=None, background=None, icSourceCat=None)

!Calibrate an exposure (science image or coadd)...

methodrunDataRef(dataRef, exposure=None, background=None, icSourceCat=None, doUnpersist=True)

!Calibrate an exposure, optionally unpersisting inputs and persisting outputs...

See also

See the CalibrateTask API reference for complete details.

Retargetable subtasks

applyApCorr

Default

lsst.meas.base.applyApCorr.ApplyApCorrTask

Field type

ConfigurableField

Subtask to apply aperture corrections

astromRefObjLoader

Default

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask

Field type

ConfigurableField

reference object loader for astrometric calibration

astrometry

Default

lsst.meas.astrom.astrometry.AstrometryTask

Field type

ConfigurableField

Perform astrometric calibration to refine the WCS

catalogCalculation

Default

lsst.meas.base.catalogCalculation.CatalogCalculationTask

Field type

ConfigurableField

Subtask to run catalogCalculation plugins on catalog

deblend

Default

lsst.meas.deblender.deblend.SourceDeblendTask

Field type

ConfigurableField

Split blended sources into their components

detection

Default

lsst.meas.algorithms.detection.SourceDetectionTask

Field type

ConfigurableField

Detect sources

evalLocCalib

Default

lsst.meas.base.evaluateLocalCalibration.EvaluateLocalCalibrationTask

Field type

ConfigurableField

Task to strip calibrations from an exposure and store their local values in the output source catalog.

insertFakes

Default

lsst.pipe.tasks.fakes.BaseFakeSourcesTask

Field type

ConfigurableField

Injection of fake sources for testing purposes (must be retargeted)

measurement

Default

lsst.meas.base.sfm.SingleFrameMeasurementTask

Field type

ConfigurableField

Measure sources

photoCal

Default

lsst.pipe.tasks.photoCal.PhotoCalTask

Field type

ConfigurableField

Perform photometric calibration

photoRefObjLoader

Default

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask

Field type

ConfigurableField

reference object loader for photometric calibration

Configuration fields

checkUnitsParseStrict

Default
'raise'
Field type

str Field

Strictness of Astropy unit compatibility check, can be ‘raise’, ‘warn’ or ‘silent’

connections

Data type

lsst.pipe.base.config.Connections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

doApCorr

Default
True
Field type

bool Field

Run subtask to apply aperture correction

doAstrometry

Default
True
Field type

bool Field

Perform astrometric calibration?

doDeblend

Default
True
Field type

bool Field

Run deblender input exposure

doEvalLocCalibration

Default
True
Field type

bool Field

Store calibration products (local wcs and PhotoCalib) in output source catalog.

doInsertFakes

Default
False
Field type

bool Field

Run fake sources injection task

doPhotoCal

Default
True
Field type

bool Field

Perform phometric calibration?

doWrite

Default
True
Field type

bool Field

Save calibration results?

doWriteExposure

Default
True
Field type

bool Field

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

Default
True
Field type

bool Field

Include HeavyFootprint data in source table? If false then heavy footprints are saved as normal footprints, which saves some space

doWriteMatches

Default
True
Field type

bool Field

Write reference matches (ignored if doWrite false)?

doWriteMatchesDenormalized

Default
False
Field type

bool Field

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

Default
('calib_psf_candidate', 'calib_psf_used', 'calib_psf_reserved')
Field type

str ListField

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

Default
3
Field type

float Field

Match radius for matching icSourceCat objects to sourceCat objects (pixels)

requireAstrometry

Default
True
Field type

bool Field

Raise an exception if astrometry fails? Ignored if doAstrometry false.

requirePhotoCal

Default
True
Field type

bool Field

Raise an exception if photoCal fails? Ignored if doPhotoCal false.