lsst.pipe.tasks g8b9e2231ea+fa07cb600e
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)
 
def validate (self)
 

Static Public Attributes

pexConfig doWrite
 
pexConfig doWriteHeavyFootprintsInSources
 
pexConfig doWriteMatches
 
pexConfig doWriteMatchesDenormalized
 
pexConfig doAstrometry
 
pexConfig astromRefObjLoader
 
pexConfig photoRefObjLoader
 
pexConfig astrometry
 
pexConfig requireAstrometry
 
pexConfig doPhotoCal
 
pexConfig requirePhotoCal
 
pexConfig photoCal
 
pexConfig icSourceFieldsToCopy
 
pexConfig matchRadiusPix
 
pexConfig checkUnitsParseStrict
 
pexConfig detection
 
pexConfig doDeblend
 
pexConfig deblend
 
pexConfig doSkySources
 
pexConfig skySources
 
pexConfig measurement
 
pexConfig postCalibrationMeasurement
 
pexConfig setPrimaryFlags
 
pexConfig doApCorr
 
pexConfig applyApCorr
 
pexConfig catalogCalculation
 
pexConfig doInsertFakes
 
pexConfig insertFakes
 
pexConfig doComputeSummaryStats
 
pexConfig computeSummaryStats
 
pexConfig doWriteExposure
 

Detailed Description

Config for CalibrateTask

Definition at line 153 of file calibrate.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 316 of file calibrate.py.

◆ validate()

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

Definition at line 332 of file calibrate.py.

Member Data Documentation

◆ applyApCorr

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

Definition at line 275 of file calibrate.py.

◆ astrometry

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

Definition at line 191 of file calibrate.py.

◆ astromRefObjLoader

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

Definition at line 183 of file calibrate.py.

◆ catalogCalculation

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

Definition at line 282 of file calibrate.py.

◆ checkUnitsParseStrict

pexConfig 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 229 of file calibrate.py.

◆ computeSummaryStats

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

Definition at line 305 of file calibrate.py.

◆ deblend

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

Definition at line 244 of file calibrate.py.

◆ detection

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

Definition at line 235 of file calibrate.py.

◆ doApCorr

pexConfig 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 270 of file calibrate.py.

◆ doAstrometry

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

Definition at line 178 of file calibrate.py.

◆ doComputeSummaryStats

pexConfig 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 300 of file calibrate.py.

◆ doDeblend

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

Definition at line 239 of file calibrate.py.

◆ doInsertFakes

pexConfig 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 286 of file calibrate.py.

◆ doPhotoCal

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

Definition at line 201 of file calibrate.py.

◆ doSkySources

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

Definition at line 248 of file calibrate.py.

◆ doWrite

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

Definition at line 155 of file calibrate.py.

◆ doWriteExposure

pexConfig 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 309 of file calibrate.py.

◆ doWriteHeavyFootprintsInSources

pexConfig 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 160 of file calibrate.py.

◆ doWriteMatches

pexConfig 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 166 of file calibrate.py.

◆ doWriteMatchesDenormalized

pexConfig 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 171 of file calibrate.py.

◆ icSourceFieldsToCopy

pexConfig 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 216 of file calibrate.py.

◆ insertFakes

pexConfig 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 293 of file calibrate.py.

◆ matchRadiusPix

pexConfig 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 223 of file calibrate.py.

◆ measurement

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

Definition at line 257 of file calibrate.py.

◆ photoCal

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

Definition at line 212 of file calibrate.py.

◆ photoRefObjLoader

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

Definition at line 187 of file calibrate.py.

◆ postCalibrationMeasurement

pexConfig 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 261 of file calibrate.py.

◆ requireAstrometry

pexConfig 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 195 of file calibrate.py.

◆ requirePhotoCal

pexConfig 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 206 of file calibrate.py.

◆ setPrimaryFlags

pexConfig 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 265 of file calibrate.py.

◆ skySources

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

Definition at line 253 of file calibrate.py.


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