lsst.pipe.tasks.calibrate.CalibrateConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.calibrate.CalibrateConfig:
Public Member Functions | |
| setDefaults (self) | |
Detailed Description
Config for CalibrateTask.
Definition at line 183 of file calibrate.py.
Member Function Documentation
◆ setDefaults()
| lsst.pipe.tasks.calibrate.CalibrateConfig.setDefaults | ( | self | ) |
Definition at line 366 of file calibrate.py.
Member Data Documentation
◆ applyApCorr
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ApplyApCorrTask,
doc="Subtask to apply aperture corrections"
)
Definition at line 328 of file calibrate.py.
◆ astrometry
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=AstrometryTask,
doc="Perform astrometric calibration to refine the WCS",
)
Definition at line 222 of file calibrate.py.
◆ astrometryDetection
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Task to detect sources to used in the astrometric fit."
)
Definition at line 226 of file calibrate.py.
◆ astromFieldsToCopy
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=("calib_astrometry_used", ),
doc=("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.")
)
Definition at line 259 of file calibrate.py.
◆ astromRefCat
|
staticinherited |
Initial value:
= cT.PrerequisiteInput(
doc="Reference catalog to use for astrometry",
name="gaia_dr3_20230707",
storageClass="SimpleCatalog",
dimensions=("skypix",),
deferLoad=True,
multiple=True,
)
Definition at line 106 of file calibrate.py.
◆ astromRefObjLoader
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=LoadReferenceObjectsConfig,
doc="reference object loader for astrometric calibration",
)
Definition at line 214 of file calibrate.py.
◆ background
|
staticinherited |
Initial value:
= cT.Input(
doc="Backgrounds determined by characterize task",
name="icExpBackground",
storageClass="Background",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 92 of file calibrate.py.
◆ catalogCalculation
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=CatalogCalculationTask,
doc="Subtask to run catalogCalculation plugins on catalog"
)
Definition at line 335 of file calibrate.py.
◆ checkUnitsParseStrict
|
static |
Initial value:
= pexConfig.Field(
doc=("Strictness of Astropy unit compatibility check, can be 'raise', "
"'warn' or 'silent'"),
dtype=str,
default="raise",
)
Definition at line 273 of file calibrate.py.
◆ computeSummaryStats
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ComputeExposureSummaryStatsTask,
doc="Subtask to run computeSummaryStats on exposure"
)
Definition at line 344 of file calibrate.py.
◆ createSummaryMetrics
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=_EmptyTargetTask,
doc="Subtask to create metrics from the summary stats. This must be retargeted, likely to an"
"analysis_tools task such as CalexpSummaryMetrics."
)
Definition at line 353 of file calibrate.py.
◆ deblend
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SourceDeblendTask,
doc="Split blended sources into their components"
)
Definition at line 288 of file calibrate.py.
◆ detection
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Detect sources"
)
Definition at line 279 of file calibrate.py.
◆ doApCorr
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run subtask to apply aperture correction"
)
Definition at line 323 of file calibrate.py.
◆ doAstrometry
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Perform astrometric calibration?",
)
Definition at line 209 of file calibrate.py.
◆ doComputeSummaryStats
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run subtask to measure exposure summary statistics?"
)
Definition at line 339 of file calibrate.py.
◆ doCreateSummaryMetrics
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Run the subtask to create summary metrics, and then write those metrics."
)
Definition at line 348 of file calibrate.py.
◆ doDeblend
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run deblender input exposure"
)
Definition at line 283 of file calibrate.py.
◆ doNormalizedCalibration
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Use normalized calibration flux (e.g. compensated tophats)?",
)
Definition at line 305 of file calibrate.py.
◆ doPhotoCal
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Perform phometric calibration?",
)
Definition at line 237 of file calibrate.py.
◆ doSkySources
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Generate sky sources?",
)
Definition at line 292 of file calibrate.py.
◆ doWrite
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Save calibration results?",
)
Definition at line 186 of file calibrate.py.
◆ doWriteExposure
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="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."
)
Definition at line 358 of file calibrate.py.
◆ doWriteHeavyFootprintsInSources
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Include HeavyFootprint data in source table? If false then heavy "
"footprints are saved as normal footprints, which saves some space"
)
Definition at line 191 of file calibrate.py.
◆ doWriteMatches
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Write reference matches (ignored if doWrite or doAstrometry false)?",
)
Definition at line 197 of file calibrate.py.
◆ doWriteMatchesDenormalized
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=("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."),
)
Definition at line 202 of file calibrate.py.
◆ exposure
|
staticinherited |
Initial value:
= cT.Input(
doc="Input image to calibrate",
name="icExp",
storageClass="ExposureF",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 85 of file calibrate.py.
◆ icSourceCat
|
staticinherited |
Initial value:
= cT.Input(
doc="Source catalog created by characterize task",
name="icSrc",
storageClass="SourceCatalog",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 99 of file calibrate.py.
◆ icSourceFieldsToCopy
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=("calib_psf_candidate", "calib_psf_used", "calib_psf_reserved"),
doc=("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.")
)
Definition at line 252 of file calibrate.py.
◆ icSourceSchema
|
staticinherited |
Initial value:
= cT.InitInput(
doc="Schema produced by characterize image task, used to initialize this task",
name="icSrc_schema",
storageClass="SourceCatalog",
)
Definition at line 73 of file calibrate.py.
◆ idGenerator
|
static |
Definition at line 364 of file calibrate.py.
◆ matches
|
staticinherited |
Initial value:
= cT.Output(
doc="Source/refObj matches from the astrometry solver",
name="srcMatch",
storageClass="Catalog",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 152 of file calibrate.py.
◆ matchesDenormalized
|
staticinherited |
Initial value:
= cT.Output(
doc="Denormalized matches from astrometry solver",
name="srcMatchFull",
storageClass="Catalog",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 159 of file calibrate.py.
◆ matchRadiusPix
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=3,
doc=("Match radius for matching icSourceCat objects to sourceCat "
"objects (pixels)"),
)
Definition at line 267 of file calibrate.py.
◆ measurement
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SingleFrameMeasurementTask,
doc="Measure sources"
)
Definition at line 301 of file calibrate.py.
◆ normalizedCalibrationFlux
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=NormalizedCalibrationFluxTask,
doc="Task to normalize the calibration flux (e.g. compensated tophats).",
)
Definition at line 310 of file calibrate.py.
◆ outputBackground
|
staticinherited |
Initial value:
= cT.Output(
doc="Background models estimated in calibration task",
name="calexpBackground",
storageClass="Background",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 138 of file calibrate.py.
◆ outputCat
|
staticinherited |
Initial value:
= cT.Output(
doc="Source catalog produced in calibrate task",
name="src",
storageClass="SourceCatalog",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 131 of file calibrate.py.
◆ outputExposure
|
staticinherited |
Initial value:
= cT.Output(
doc="Exposure after running calibration task",
name="calexp",
storageClass="ExposureF",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 124 of file calibrate.py.
◆ outputSchema
|
staticinherited |
Initial value:
= cT.InitOutput(
doc="Schema after CalibrateTask has been initialized",
name="src_schema",
storageClass="SourceCatalog",
)
Definition at line 79 of file calibrate.py.
◆ outputSummaryMetrics
|
staticinherited |
Initial value:
= cT.Output(
doc="Summary metrics created by the calibration task",
name="calexpSummary_metrics",
storageClass="MetricMeasurementBundle",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 145 of file calibrate.py.
◆ photoCal
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=PhotoCalTask,
doc="Perform photometric calibration",
)
Definition at line 248 of file calibrate.py.
◆ photoRefCat
|
staticinherited |
Initial value:
= cT.PrerequisiteInput(
doc="Reference catalog to use for photometric calibration",
name="ps1_pv3_3pi_20170110",
storageClass="SimpleCatalog",
dimensions=("skypix",),
deferLoad=True,
multiple=True
)
Definition at line 115 of file calibrate.py.
◆ photoRefObjLoader
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=LoadReferenceObjectsConfig,
doc="reference object loader for photometric calibration",
)
Definition at line 218 of file calibrate.py.
◆ postCalibrationMeasurement
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SingleFrameMeasurementTask,
doc="Second round of measurement for plugins that need to be run after photocal"
)
Definition at line 314 of file calibrate.py.
◆ requireAstrometry
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=("Raise an exception if astrometry fails? Ignored if doAstrometry "
"false."),
)
Definition at line 231 of file calibrate.py.
◆ requirePhotoCal
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=("Raise an exception if photoCal fails? Ignored if doPhotoCal "
"false."),
)
Definition at line 242 of file calibrate.py.
◆ setPrimaryFlags
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SetPrimaryFlagsTask,
doc=("Set flags for primary source classification in single frame "
"processing. True if sources are not sky sources and not a parent.")
)
Definition at line 318 of file calibrate.py.
◆ skySources
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SkyObjectsTask,
doc="Generate sky sources",
)
Definition at line 297 of file calibrate.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/calibrate.py
Generated on Sun Apr 26 2026 09:20:56 for lsst.pipe.tasks by
1.13.2