lsst.pipe.tasks g5e700ac387+7c0a0cd613
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.calibrate.CalibrateConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.calibrate.CalibrateConfig:
lsst.pipe.tasks.calibrate.CalibrateConnections

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

 doWrite
 
 doWriteHeavyFootprintsInSources
 
 doWriteMatches
 
 doWriteMatchesDenormalized
 
 doAstrometry
 
 astromRefObjLoader
 
 photoRefObjLoader
 
 astrometry
 
 requireAstrometry
 
 doPhotoCal
 
 requirePhotoCal
 
 photoCal
 
 icSourceFieldsToCopy
 
 matchRadiusPix
 
 checkUnitsParseStrict
 
 detection
 
 doDeblend
 
 deblend
 
 doSkySources
 
 skySources
 
 measurement
 
 postCalibrationMeasurement
 
 setPrimaryFlags
 
 doApCorr
 
 applyApCorr
 
 catalogCalculation
 
 doInsertFakes
 
 insertFakes
 
 doComputeSummaryStats
 
 computeSummaryStats
 
 doWriteExposure
 
 idGenerator = DetectorVisitIdGeneratorConfig.make_field()
 

Detailed Description

Config for CalibrateTask.

Definition at line 155 of file calibrate.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.calibrate.CalibrateConfig.setDefaults (   self)

Definition at line 320 of file calibrate.py.

Member Data Documentation

◆ applyApCorr

lsst.pipe.tasks.calibrate.CalibrateConfig.applyApCorr
static
Initial value:
= pexConfig.ConfigurableField(
target=ApplyApCorrTask,
doc="Subtask to apply aperture corrections"
)

Definition at line 278 of file calibrate.py.

◆ astrometry

lsst.pipe.tasks.calibrate.CalibrateConfig.astrometry
static
Initial value:
= pexConfig.ConfigurableField(
target=AstrometryTask,
doc="Perform astrometric calibration to refine the WCS",
)

Definition at line 194 of file calibrate.py.

◆ astromRefObjLoader

lsst.pipe.tasks.calibrate.CalibrateConfig.astromRefObjLoader
static
Initial value:
= pexConfig.ConfigField(
dtype=LoadReferenceObjectsConfig,
doc="reference object loader for astrometric calibration",
)

Definition at line 186 of file calibrate.py.

◆ catalogCalculation

lsst.pipe.tasks.calibrate.CalibrateConfig.catalogCalculation
static
Initial value:
= pexConfig.ConfigurableField(
target=CatalogCalculationTask,
doc="Subtask to run catalogCalculation plugins on catalog"
)

Definition at line 285 of file calibrate.py.

◆ checkUnitsParseStrict

lsst.pipe.tasks.calibrate.CalibrateConfig.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 232 of file calibrate.py.

◆ computeSummaryStats

lsst.pipe.tasks.calibrate.CalibrateConfig.computeSummaryStats
static
Initial value:
= pexConfig.ConfigurableField(
target=ComputeExposureSummaryStatsTask,
doc="Subtask to run computeSummaryStats on exposure"
)

Definition at line 308 of file calibrate.py.

◆ deblend

lsst.pipe.tasks.calibrate.CalibrateConfig.deblend
static
Initial value:
= pexConfig.ConfigurableField(
target=SourceDeblendTask,
doc="Split blended sources into their components"
)

Definition at line 247 of file calibrate.py.

◆ detection

lsst.pipe.tasks.calibrate.CalibrateConfig.detection
static
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Detect sources"
)

Definition at line 238 of file calibrate.py.

◆ doApCorr

lsst.pipe.tasks.calibrate.CalibrateConfig.doApCorr
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run subtask to apply aperture correction"
)

Definition at line 273 of file calibrate.py.

◆ doAstrometry

lsst.pipe.tasks.calibrate.CalibrateConfig.doAstrometry
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Perform astrometric calibration?",
)

Definition at line 181 of file calibrate.py.

◆ doComputeSummaryStats

lsst.pipe.tasks.calibrate.CalibrateConfig.doComputeSummaryStats
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run subtask to measure exposure summary statistics?"
)

Definition at line 303 of file calibrate.py.

◆ doDeblend

lsst.pipe.tasks.calibrate.CalibrateConfig.doDeblend
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run deblender input exposure"
)

Definition at line 242 of file calibrate.py.

◆ doInsertFakes

lsst.pipe.tasks.calibrate.CalibrateConfig.doInsertFakes
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Run fake sources injection task",
deprecated=("doInsertFakes is no longer supported. This config will be removed after v24. "
"Please use ProcessCcdWithFakesTask instead.")
)

Definition at line 289 of file calibrate.py.

◆ doPhotoCal

lsst.pipe.tasks.calibrate.CalibrateConfig.doPhotoCal
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Perform phometric calibration?",
)

Definition at line 204 of file calibrate.py.

◆ doSkySources

lsst.pipe.tasks.calibrate.CalibrateConfig.doSkySources
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Generate sky sources?",
)

Definition at line 251 of file calibrate.py.

◆ doWrite

lsst.pipe.tasks.calibrate.CalibrateConfig.doWrite
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Save calibration results?",
)

Definition at line 158 of file calibrate.py.

◆ doWriteExposure

lsst.pipe.tasks.calibrate.CalibrateConfig.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 312 of file calibrate.py.

◆ doWriteHeavyFootprintsInSources

lsst.pipe.tasks.calibrate.CalibrateConfig.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 163 of file calibrate.py.

◆ doWriteMatches

lsst.pipe.tasks.calibrate.CalibrateConfig.doWriteMatches
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Write reference matches (ignored if doWrite or doAstrometry false)?",
)

Definition at line 169 of file calibrate.py.

◆ doWriteMatchesDenormalized

lsst.pipe.tasks.calibrate.CalibrateConfig.doWriteMatchesDenormalized
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc=("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."),
)

Definition at line 174 of file calibrate.py.

◆ icSourceFieldsToCopy

lsst.pipe.tasks.calibrate.CalibrateConfig.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 219 of file calibrate.py.

◆ idGenerator

lsst.pipe.tasks.calibrate.CalibrateConfig.idGenerator = DetectorVisitIdGeneratorConfig.make_field()
static

Definition at line 318 of file calibrate.py.

◆ insertFakes

lsst.pipe.tasks.calibrate.CalibrateConfig.insertFakes
static
Initial value:
= pexConfig.ConfigurableField(
target=BaseFakeSourcesTask,
doc="Injection of fake sources for testing purposes (must be "
"retargeted)",
deprecated=("insertFakes is no longer supported. This config will be removed after v24. "
"Please use ProcessCcdWithFakesTask instead.")
)

Definition at line 296 of file calibrate.py.

◆ matchRadiusPix

lsst.pipe.tasks.calibrate.CalibrateConfig.matchRadiusPix
static
Initial value:
= pexConfig.Field(
dtype=float,
default=3,
doc=("Match radius for matching icSourceCat objects to sourceCat "
"objects (pixels)"),
)

Definition at line 226 of file calibrate.py.

◆ measurement

lsst.pipe.tasks.calibrate.CalibrateConfig.measurement
static
Initial value:
= pexConfig.ConfigurableField(
target=SingleFrameMeasurementTask,
doc="Measure sources"
)

Definition at line 260 of file calibrate.py.

◆ photoCal

lsst.pipe.tasks.calibrate.CalibrateConfig.photoCal
static
Initial value:
= pexConfig.ConfigurableField(
target=PhotoCalTask,
doc="Perform photometric calibration",
)

Definition at line 215 of file calibrate.py.

◆ photoRefObjLoader

lsst.pipe.tasks.calibrate.CalibrateConfig.photoRefObjLoader
static
Initial value:
= pexConfig.ConfigField(
dtype=LoadReferenceObjectsConfig,
doc="reference object loader for photometric calibration",
)

Definition at line 190 of file calibrate.py.

◆ postCalibrationMeasurement

lsst.pipe.tasks.calibrate.CalibrateConfig.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 264 of file calibrate.py.

◆ requireAstrometry

lsst.pipe.tasks.calibrate.CalibrateConfig.requireAstrometry
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=("Raise an exception if astrometry fails? Ignored if doAstrometry "
"false."),
)

Definition at line 198 of file calibrate.py.

◆ requirePhotoCal

lsst.pipe.tasks.calibrate.CalibrateConfig.requirePhotoCal
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=("Raise an exception if photoCal fails? Ignored if doPhotoCal "
"false."),
)

Definition at line 209 of file calibrate.py.

◆ setPrimaryFlags

lsst.pipe.tasks.calibrate.CalibrateConfig.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 268 of file calibrate.py.

◆ skySources

lsst.pipe.tasks.calibrate.CalibrateConfig.skySources
static
Initial value:
= pexConfig.ConfigurableField(
target=SkyObjectsTask,
doc="Generate sky sources",
)

Definition at line 256 of file calibrate.py.


The documentation for this class was generated from the following file: