lsst.pipe.tasks g281251e7f9+9d3b0d3b84
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.pipe.tasks.coaddBase.CoaddBaseConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.coaddBase.CoaddBaseConfig:

Static Public Attributes

 coaddName
 
 select
 
 badMaskPlanes
 
 inputRecorder
 
 doPsfMatch
 
 modelPsf = measAlg.GaussianPsfFactory.makeField(doc="Model Psf factory")
 
 doApplyExternalPhotoCalib
 
 useGlobalExternalPhotoCalib
 
 doApplyExternalSkyWcs
 
 useGlobalExternalSkyWcs
 
 includeCalibVar
 
 matchingKernelSize
 

Detailed Description

Configuration parameters for CoaddBaseTask

Configuration parameters shared between MakeCoaddTempExp and AssembleCoadd

Definition at line 35 of file coaddBase.py.

Member Data Documentation

◆ badMaskPlanes

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.badMaskPlanes
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="Mask planes that, if set, the associated pixel should not be included in the coaddTempExp.",
default=("NO_DATA",),
)

Definition at line 50 of file coaddBase.py.

◆ coaddName

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.coaddName
static
Initial value:
= pexConfig.Field(
doc="Coadd name: typically one of deep or goodSeeing.",
dtype=str,
default="deep",
)

Definition at line 41 of file coaddBase.py.

◆ doApplyExternalPhotoCalib

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.doApplyExternalPhotoCalib
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc=("Whether to apply external photometric calibration via an "
"`lsst.afw.image.PhotoCalib` object. Uses the "
"`externalPhotoCalibName` field to determine which calibration "
"to load."),
# TODO: remove on DM-39854.
deprecated="Deprecated in favor of the 'visitSummary' connection. Will be removed after v26.",
)

Definition at line 66 of file coaddBase.py.

◆ doApplyExternalSkyWcs

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.doApplyExternalSkyWcs
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc=("Whether to apply external astrometric calibration via an "
"`lsst.afw.geom.SkyWcs` object. Uses `externalSkyWcsName` "
"field to determine which calibration to load."),
# TODO: remove on DM-39854.
deprecated="Deprecated in favor of the 'visitSummary' connection. Will be removed after v26.",
)

Definition at line 85 of file coaddBase.py.

◆ doPsfMatch

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.doPsfMatch
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Match to modelPsf? Sets makePsfMatched=True, makeDirect=False",
deprecated="This field is no longer used. Will be removed after v26.", # TODO: DM-39841
default=False
)

Definition at line 59 of file coaddBase.py.

◆ includeCalibVar

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.includeCalibVar
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Add photometric calibration variance to warp variance plane.",
default=False
)

Definition at line 103 of file coaddBase.py.

◆ inputRecorder

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.inputRecorder
static
Initial value:
= pexConfig.ConfigurableField(
doc="Subtask that helps fill CoaddInputs catalogs added to the final Exposure",
target=CoaddInputRecorderTask
)

Definition at line 55 of file coaddBase.py.

◆ matchingKernelSize

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.matchingKernelSize
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Size in pixels of matching kernel. Must be odd.",
default=21,
check=lambda x: x % 2 == 1
)

Definition at line 108 of file coaddBase.py.

◆ modelPsf

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.modelPsf = measAlg.GaussianPsfFactory.makeField(doc="Model Psf factory")
static

Definition at line 65 of file coaddBase.py.

◆ select

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.select
static
Initial value:
= pexConfig.ConfigurableField(
doc="Image selection subtask.",
target=PsfWcsSelectImagesTask,
)

Definition at line 46 of file coaddBase.py.

◆ useGlobalExternalPhotoCalib

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.useGlobalExternalPhotoCalib
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc=("When using doApplyExternalPhotoCalib, use 'global' calibrations "
"that are not run per-tract. When False, use per-tract photometric "
"calibration files."),
# TODO: remove on DM-39854.
deprecated="Deprecated in favor of the 'visitSummary' connection. Will be removed after v26.",
)

Definition at line 76 of file coaddBase.py.

◆ useGlobalExternalSkyWcs

lsst.pipe.tasks.coaddBase.CoaddBaseConfig.useGlobalExternalSkyWcs
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc=("When using doApplyExternalSkyWcs, use 'global' calibrations "
"that are not run per-tract. When False, use per-tract wcs "
"files."),
# TODO: remove on DM-39854.
deprecated="Deprecated in favor of the 'visitSummary' connection. Will be removed after v26.",
)

Definition at line 94 of file coaddBase.py.


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