LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
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

 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
 
 doComputeSummaryStats
 
 computeSummaryStats
 
 doCreateSummaryMetrics
 
 createSummaryMetrics
 
 doWriteExposure
 
 idGenerator = DetectorVisitIdGeneratorConfig.make_field()
 

Detailed Description

Config for CalibrateTask.

Definition at line 179 of file calibrate.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 340 of file calibrate.py.

340 def setDefaults(self):
341 super().setDefaults()
342 self.postCalibrationMeasurement.plugins.names = ["base_LocalPhotoCalib", "base_LocalWcs"]
343 self.postCalibrationMeasurement.doReplaceWithNoise = False
344 for key in self.postCalibrationMeasurement.slots:
345 setattr(self.postCalibrationMeasurement.slots, key, None)
346 self.astromRefObjLoader.anyFilterMapsToThis = "phot_g_mean"
347 # The photoRefCat connection is the name to use for the colorterms.
348 self.photoCal.photoCatName = self.connections.photoRefCat
349
350 # Keep track of which footprints contain streaks
351 self.measurement.plugins['base_PixelFlags'].masksFpAnywhere = ['STREAK']
352 self.measurement.plugins['base_PixelFlags'].masksFpCenter = ['STREAK']
353
354

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 302 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 218 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 210 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 309 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 256 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 318 of file calibrate.py.

◆ createSummaryMetrics

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

◆ detection

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

Definition at line 262 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 297 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 205 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 313 of file calibrate.py.

◆ doCreateSummaryMetrics

lsst.pipe.tasks.calibrate.CalibrateConfig.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 322 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 266 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 228 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 275 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 182 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 332 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 187 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 193 of file calibrate.py.

◆ doWriteMatchesDenormalized

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

◆ idGenerator

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

Definition at line 338 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 250 of file calibrate.py.

◆ measurement

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

Definition at line 284 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 239 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 214 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 288 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 222 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 233 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 292 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 280 of file calibrate.py.


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