CalibrateTask

Python API summary

from lsst.pipe.tasks.calibrate import CalibrateTask
classCalibrateTask(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, background=None, icSourceCat=None, idGenerator=None)

Calibrate an exposure...

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

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

computeSummaryStats

Default

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask

Field type

ConfigurableField

Subtask to run computeSummaryStats on exposure

createSummaryMetrics

Default

lsst.pipe.tasks.calibrate._EmptyTargetTask

Field type

ConfigurableField

Subtask to create metrics from the summary stats. This must be retargeted, likely to ananalysis_tools task such as CalexpSummaryMetrics.

deblend

Default

lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask

Field type

ConfigurableField

Split blended sources into their components

detection

Default

lsst.meas.algorithms.detection.SourceDetectionTask

Field type

ConfigurableField

Detect sources

measurement

Default

lsst.meas.base.sfm.SingleFrameMeasurementTask

Field type

ConfigurableField

Measure sources

normalizedCalibrationFlux

Default

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask

Field type

ConfigurableField

Task to normalize the calibration flux (e.g. compensated tophats).

photoCal

Default

lsst.pipe.tasks.photoCal.PhotoCalTask

Field type

ConfigurableField

Perform photometric calibration

postCalibrationMeasurement

Default

lsst.meas.base.sfm.SingleFrameMeasurementTask

Field type

ConfigurableField

Second round of measurement for plugins that need to be run after photocal

setPrimaryFlags

Default

lsst.meas.algorithms.setPrimaryFlags.SetPrimaryFlagsTask

Field type

ConfigurableField

Set flags for primary source classification in single frame processing. True if sources are not sky sources and not a parent.

skySources

Default

lsst.meas.algorithms.skyObjects.SkyObjectsTask

Field type

ConfigurableField

Generate sky sources

Configuration fields

astromRefObjLoader

Data type

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig

Field type

ConfigField

reference object loader for astrometric calibration

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.CalibrateConfigConnections

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?

doComputeSummaryStats

Default
True
Field type

bool Field

Run subtask to measure exposure summary statistics?

doCreateSummaryMetrics

Default
False
Field type

bool Field

Run the subtask to create summary metrics, and then write those metrics.

doDeblend

Default
True
Field type

bool Field

Run deblender input exposure

doNormalizedCalibration

Default
True
Field type

bool Field

Use normalized calibration flux (e.g. compensated tophats)?

doPhotoCal

Default
True
Field type

bool Field

Perform phometric calibration?

doSkySources

Default
True
Field type

bool Field

Generate sky sources?

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 or doAstrometry false)?

doWriteMatchesDenormalized

Default
True
Field type

bool Field

Write reference matches in denormalized format? This format uses more disk space, but is more convenient to read for debugging. 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.

idGenerator

Data type

lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig

Field type

ConfigField

Configuration for how to generate catalog IDs from data IDs.

matchRadiusPix

Default
3
Field type

float Field

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

photoRefObjLoader

Data type

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig

Field type

ConfigField

reference object loader for photometric calibration

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.

saveLogOutput

Default
True
Field type

bool Field

Flag to enable/disable saving of log output for a task, enabled by default.