lsst.pipe.tasks  17.0.1-26-gd98a1d13+2
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:

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
 
 measurement
 
 doApCorr
 
 applyApCorr
 
 catalogCalculation
 
 doInsertFakes
 
 insertFakes
 
 icSourceSchema
 
 outputSchema
 
 exposure
 
 background
 
 icSourceCat
 
 astromRefCat
 
 photoRefCat
 
 outputExposure
 
 outputCat
 
 outputBackground
 
 matches
 
 matchesDenormalized
 
 doWriteExposure
 

Detailed Description

Config for CalibrateTask

Definition at line 46 of file calibrate.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 259 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 150 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 84 of file calibrate.py.

◆ astromRefCat

lsst.pipe.tasks.calibrate.CalibrateConfig.astromRefCat
static
Initial value:
= InputDatasetField(
doc="Reference catalog to use for astrometry",
name="ref_cat",
storageClass="SimpleCatalog",
dimensions=("skypix",),
manualLoad=True
)

Definition at line 202 of file calibrate.py.

◆ astromRefObjLoader

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

Definition at line 76 of file calibrate.py.

◆ background

lsst.pipe.tasks.calibrate.CalibrateConfig.background
static
Initial value:
= InputDatasetField(
doc="Backgrounds determined by characterize task",
name="icExpBackground",
storageClass="Background",
dimensions=("instrument", "visit", "detector"),
scalar=True
)

Definition at line 188 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 157 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 122 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 137 of file calibrate.py.

◆ detection

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

Definition at line 128 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 145 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 71 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 132 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"
)

Definition at line 161 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 94 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 48 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 252 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 53 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 false)?",
)

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

◆ exposure

lsst.pipe.tasks.calibrate.CalibrateConfig.exposure
static
Initial value:
= InputDatasetField(
doc="Input image to calibrate",
name="icExp",
storageClass="ExposureF",
dimensions=("instrument", "visit", "detector"),
scalar=True
)

Definition at line 181 of file calibrate.py.

◆ icSourceCat

lsst.pipe.tasks.calibrate.CalibrateConfig.icSourceCat
static
Initial value:
= InputDatasetField(
doc="Source catalog created by characterize task",
name="icSrc",
storageClass="SourceCatalog",
dimensions=("instrument", "visit", "detector"),
scalar=True
)

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

◆ icSourceSchema

lsst.pipe.tasks.calibrate.CalibrateConfig.icSourceSchema
static
Initial value:
= InitInputDatasetField(
doc="Schema produced by characterize image task, used to initialize this task",
name="icSrc_schema",
storageClass="SourceCatalog",
)

Definition at line 171 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)"
)

Definition at line 166 of file calibrate.py.

◆ matches

lsst.pipe.tasks.calibrate.CalibrateConfig.matches
static
Initial value:
= OutputDatasetField(
doc="Source/refObj matches from the astrometry solver",
name="srcMatch",
storageClass="Catalog",
dimensions=("instrument", "visit", "detector"),
scalar=True
)

Definition at line 237 of file calibrate.py.

◆ matchesDenormalized

lsst.pipe.tasks.calibrate.CalibrateConfig.matchesDenormalized
static
Initial value:
= OutputDatasetField(
doc="Denormalized matches from astrometry solver",
name="srcMatchFull",
storageClass="Catalog",
dimensions=("instrument", "visit", "detector"),
scalar=True
)

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

◆ measurement

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

Definition at line 141 of file calibrate.py.

◆ outputBackground

lsst.pipe.tasks.calibrate.CalibrateConfig.outputBackground
static
Initial value:
= OutputDatasetField(
doc="Background models estimated in calibration task",
name="calexpBackground",
storageClass="Background",
dimensions=("instrument", "visit", "detector"),
scalar=True
)

Definition at line 230 of file calibrate.py.

◆ outputCat

lsst.pipe.tasks.calibrate.CalibrateConfig.outputCat
static
Initial value:
= OutputDatasetField(
doc="Source catalog produced in calibrate task",
name="src",
storageClass="SourceCatalog",
dimensions=("instrument", "visit", "detector"),
scalar=True
)

Definition at line 223 of file calibrate.py.

◆ outputExposure

lsst.pipe.tasks.calibrate.CalibrateConfig.outputExposure
static
Initial value:
= OutputDatasetField(
doc="Exposure after running calibration task",
name="calexp",
storageClass="ExposureF",
dimensions=("instrument", "visit", "detector"),
scalar=True
)

Definition at line 216 of file calibrate.py.

◆ outputSchema

lsst.pipe.tasks.calibrate.CalibrateConfig.outputSchema
static
Initial value:
= InitOutputDatasetField(
doc="Schema after CalibrateTask has been initialized",
name="src_schema",
storageClass="SourceCatalog",
)

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

◆ photoRefCat

lsst.pipe.tasks.calibrate.CalibrateConfig.photoRefCat
static
Initial value:
= InputDatasetField(
doc="Reference catalog to use for photometric calibration",
name="ref_cat",
storageClass="SimpleCatalog",
dimensions=("skypix",),
manualLoad=True
)

Definition at line 209 of file calibrate.py.

◆ photoRefObjLoader

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

Definition at line 80 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 88 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 99 of file calibrate.py.


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