Configuration parameters for CoaddBaseTask. More...
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 | |
| externalPhotoCalibName | |
| doApplyExternalSkyWcs | |
| useGlobalExternalSkyWcs | |
| externalSkyWcsName | |
| includeCalibVar | |
| matchingKernelSize | |
Detailed Description
Configuration parameters for CoaddBaseTask.
@anchor CoaddBaseConfig_ @brief Configuration parameters shared between MakeCoaddTempExp and AssembleCoadd
Definition at line 38 of file coaddBase.py.
Member Data Documentation
◆ 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 54 of file coaddBase.py.
◆ coaddName
|
static |
Initial value:
= pexConfig.Field(
doc="Coadd name: typically one of deep or goodSeeing.",
dtype=str,
default="deep",
)
Definition at line 45 of file coaddBase.py.
◆ 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.")
)
Definition at line 69 of file coaddBase.py.
◆ 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.")
)
Definition at line 96 of file coaddBase.py.
◆ doPsfMatch
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Match to modelPsf? Deprecated. Sets makePsfMatched=True, makeDirect=False",
default=False
)
Definition at line 63 of file coaddBase.py.
◆ externalPhotoCalibName
|
static |
Initial value:
= pexConfig.ChoiceField(
# TODO: Remove this config with the removal of Gen2 in DM-20572.
dtype=str,
doc=("Type of external PhotoCalib if `doApplyExternalPhotoCalib` is True. "
"This field is only used for Gen2 middleware."),
default="jointcal",
allowed={
"jointcal": "Use jointcal_photoCalib",
"fgcm": "Use fgcm_photoCalib",
"fgcm_tract": "Use fgcm_tract_photoCalib"
}
)
Definition at line 84 of file coaddBase.py.
◆ externalSkyWcsName
|
static |
Initial value:
= pexConfig.ChoiceField(
# TODO: Remove this config with the removal of Gen2 in DM-20572.
dtype=str,
doc=("Type of external SkyWcs if `doApplyExternalSkyWcs` is True. "
"This field is only used for Gen2 middleware."),
default="jointcal",
allowed={
"jointcal": "Use jointcal_wcs"
}
)
Definition at line 110 of file coaddBase.py.
◆ includeCalibVar
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Add photometric calibration variance to warp variance plane.",
default=False
)
Definition at line 120 of file coaddBase.py.
◆ inputRecorder
|
static |
Initial value:
= pexConfig.ConfigurableField(
doc="Subtask that helps fill CoaddInputs catalogs added to the final Exposure",
target=CoaddInputRecorderTask
)
Definition at line 59 of file coaddBase.py.
◆ 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 125 of file coaddBase.py.
◆ modelPsf
|
static |
Definition at line 68 of file coaddBase.py.
◆ select
|
static |
Initial value:
= pexConfig.ConfigurableField(
doc="Image selection subtask.",
target=WcsSelectImagesTask,
)
Definition at line 50 of file coaddBase.py.
◆ useGlobalExternalPhotoCalib
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=("When using doApplyExternalPhotoCalib, use 'global' calibrations "
"that are not run per-tract. When False, use per-tract photometric "
"calibration files.")
)
Definition at line 77 of file coaddBase.py.
◆ 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.")
)
Definition at line 103 of file coaddBase.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-147-g0e635eb1+1acddb5be5/python/lsst/pipe/tasks/coaddBase.py
