CalibrateConfig#

class lsst.pipe.tasks.calibrate.CalibrateConfig(*args, **kw)#

Bases: PipelineTaskConfig

Config for CalibrateTask.

Attributes Summary

`applyApCorr`	Subtask to apply aperture corrections (`ConfigurableInstance`, default `<class 'lsst.meas.base.applyApCorr.ApplyApCorrConfig'>`)
`astromFieldsToCopy`	Fields to copy from the astromCat catalog to the output catalog for matching sources.
`astromRefObjLoader`	reference object loader for astrometric calibration (`LoadReferenceObjectsConfig`, default `<class 'lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig'>`)
`astrometry`	Perform astrometric calibration to refine the WCS (`ConfigurableInstance`, default `<class 'lsst.meas.astrom.astrometry.AstrometryConfig'>`)
`astrometryDetection`	Task to detect sources to used in the astrometric fit.
`catalogCalculation`	Subtask to run catalogCalculation plugins on catalog (`ConfigurableInstance`, default `<class 'lsst.meas.base.catalogCalculation.CatalogCalculationConfig'>`)
`checkUnitsParseStrict`	Strictness of Astropy unit compatibility check, can be 'raise', 'warn' or 'silent' (`str`, default `'raise'`)
`computeSummaryStats`	Subtask to run computeSummaryStats on exposure (`ConfigurableInstance`, default `<class 'lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig'>`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`createSummaryMetrics`	Subtask to create metrics from the summary stats.
`deblend`	Split blended sources into their components (`ConfigurableInstance`, default `<class 'lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig'>`)
`detection`	Detect sources (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>`)
`doApCorr`	Run subtask to apply aperture correction (`bool`, default `True`)
`doAstrometry`	Perform astrometric calibration? (`bool`, default `True`)
`doComputeSummaryStats`	Run subtask to measure exposure summary statistics? (`bool`, default `True`)
`doCreateSummaryMetrics`	Run the subtask to create summary metrics, and then write those metrics.
`doDeblend`	Run deblender input exposure (`bool`, default `True`)
`doNormalizedCalibration`	Use normalized calibration flux (e.g. compensated tophats)? (`bool`, default `True`).
`doPhotoCal`	Perform phometric calibration? (`bool`, default `True`)
`doSkySources`	Generate sky sources? (`bool`, default `True`)
`doWrite`	Save calibration results? (`bool`, default `True`)
`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 (`bool`, default `True`)
`doWriteMatches`	Write reference matches (ignored if doWrite or doAstrometry false)? (`bool`, default `True`)
`doWriteMatchesDenormalized`	Write reference matches in denormalized format? This format uses more disk space, but is more convenient to read for debugging.
`icSourceFieldsToCopy`	Fields to copy from the icSource catalog to the output catalog for matching sources.
`idGenerator`	Configuration for how to generate catalog IDs from data IDs.
`matchRadiusPix`	Match radius for matching icSourceCat objects to sourceCat objects (pixels) (`float`, default `3`)
`measurement`	Measure sources (`ConfigurableInstance`, default `<class 'lsst.meas.base.sfm.SingleFrameMeasurementConfig'>`)
`normalizedCalibrationFlux`	Task to normalize the calibration flux (e.g. compensated tophats).
`photoCal`	Perform photometric calibration (`ConfigurableInstance`, default `<class 'lsst.pipe.tasks.photoCal.PhotoCalConfig'>`)
`photoRefObjLoader`	reference object loader for photometric calibration (`LoadReferenceObjectsConfig`, default `<class 'lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig'>`)
`postCalibrationMeasurement`	Second round of measurement for plugins that need to be run after photocal (`ConfigurableInstance`, default `<class 'lsst.meas.base.sfm.SingleFrameMeasurementConfig'>`)
`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.
`setPrimaryFlags`	Set flags for primary source classification in single frame processing.
`skySources`	Generate sky sources (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.skyObjects.SkyObjectsConfig'>`)

Methods Summary

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

applyApCorr#: Subtask to apply aperture corrections (ConfigurableInstance, default <class 'lsst.meas.base.applyApCorr.ApplyApCorrConfig'>)

astromFieldsToCopy#: Fields to copy from the astromCat catalog to the output catalog for matching sources. Any missing fields will trigger a RuntimeError exception. Ignored if astromCat does not exists. (List, default ('calib_astrometry_used',))

astromRefObjLoader#: reference object loader for astrometric calibration (LoadReferenceObjectsConfig, default <class 'lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig'>)

astrometry#: Perform astrometric calibration to refine the WCS (ConfigurableInstance, default <class 'lsst.meas.astrom.astrometry.AstrometryConfig'>)

astrometryDetection#: Task to detect sources to used in the astrometric fit. (ConfigurableInstance, default <class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>)

catalogCalculation#: Subtask to run catalogCalculation plugins on catalog (ConfigurableInstance, default <class 'lsst.meas.base.catalogCalculation.CatalogCalculationConfig'>)

checkUnitsParseStrict#: Strictness of Astropy unit compatibility check, can be ‘raise’, ‘warn’ or ‘silent’ (str, default 'raise')

computeSummaryStats#: Subtask to run computeSummaryStats on exposure (ConfigurableInstance, default <class 'lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig'>)

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

createSummaryMetrics#: Subtask to create metrics from the summary stats. This must be retargeted, likely to ananalysis_tools task such as CalexpSummaryMetrics. (ConfigurableInstance, default <class 'lsst.pipe.base.config.PipelineTaskConfig'>)

deblend#: Split blended sources into their components (ConfigurableInstance, default <class 'lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig'>)

detection#: Detect sources (ConfigurableInstance, default <class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>)

doApCorr#: Run subtask to apply aperture correction (bool, default True)

doAstrometry#: Perform astrometric calibration? (bool, default True)

doComputeSummaryStats#: Run subtask to measure exposure summary statistics? (bool, default True)

doCreateSummaryMetrics#: Run the subtask to create summary metrics, and then write those metrics. (bool, default False)

doDeblend#: Run deblender input exposure (bool, default True)

doNormalizedCalibration#: Use normalized calibration flux (e.g. compensated tophats)? (bool, default True)

doPhotoCal#: Perform phometric calibration? (bool, default True)

doSkySources#: Generate sky sources? (bool, default True)

doWrite#: Save calibration results? (bool, default True)

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. (bool, default True)

doWriteHeavyFootprintsInSources#: Include HeavyFootprint data in source table? If false then heavy footprints are saved as normal footprints, which saves some space (bool, default True)

doWriteMatches#: Write reference matches (ignored if doWrite or doAstrometry false)? (bool, default True)

doWriteMatchesDenormalized#: 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. (bool, default True)

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. (List, default ('calib_psf_candidate', 'calib_psf_used', 'calib_psf_reserved'))

idGenerator#: Configuration for how to generate catalog IDs from data IDs. (DetectorVisitIdGeneratorConfig, default <class 'lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig'>)

matchRadiusPix#: Match radius for matching icSourceCat objects to sourceCat objects (pixels) (float, default 3)

measurement#: Measure sources (ConfigurableInstance, default <class 'lsst.meas.base.sfm.SingleFrameMeasurementConfig'>)

normalizedCalibrationFlux#: Task to normalize the calibration flux (e.g. compensated tophats). (ConfigurableInstance, default <class 'lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxConfig'>)

photoCal#: Perform photometric calibration (ConfigurableInstance, default <class 'lsst.pipe.tasks.photoCal.PhotoCalConfig'>)

photoRefObjLoader#: reference object loader for photometric calibration (LoadReferenceObjectsConfig, default <class 'lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig'>)

postCalibrationMeasurement#: Second round of measurement for plugins that need to be run after photocal (ConfigurableInstance, default <class 'lsst.meas.base.sfm.SingleFrameMeasurementConfig'>)

requireAstrometry#: Raise an exception if astrometry fails? Ignored if doAstrometry false. (bool, default True)

requirePhotoCal#: Raise an exception if photoCal fails? Ignored if doPhotoCal false. (bool, default True)

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

setPrimaryFlags#: Set flags for primary source classification in single frame processing. True if sources are not sky sources and not a parent. (ConfigurableInstance, default <class 'lsst.meas.algorithms.setPrimaryFlags.SetPrimaryFlagsConfig'>)

skySources#: Generate sky sources (ConfigurableInstance, default <class 'lsst.meas.algorithms.skyObjects.SkyObjectsConfig'>)

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

CalibrateConfig#

Notes#