lsst.pipe.tasks g59f6dce098+83b7f37e51
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

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

Detailed Description

Configuration parameters for CoaddBaseTask

Configuration parameters shared between MakeCoaddTempExp and AssembleCoadd

Definition at line 34 of file coaddBase.py.

Member Data Documentation

◆ badMaskPlanes

pexConfig 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 49 of file coaddBase.py.

◆ coaddName

pexConfig 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 40 of file coaddBase.py.

◆ doApplyExternalPhotoCalib

pexConfig 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.")
)

Definition at line 64 of file coaddBase.py.

◆ doApplyExternalSkyWcs

pexConfig 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.")
)

Definition at line 92 of file coaddBase.py.

◆ doPsfMatch

pexConfig lsst.pipe.tasks.coaddBase.CoaddBaseConfig.doPsfMatch
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Match to modelPsf? Deprecated. Sets makePsfMatched=True, makeDirect=False",
default=False
)

Definition at line 58 of file coaddBase.py.

◆ externalPhotoCalibName

pexConfig lsst.pipe.tasks.coaddBase.CoaddBaseConfig.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"
},
deprecated="This configuration is no longer used, and will be removed after v25.0",
)

Definition at line 79 of file coaddBase.py.

◆ externalSkyWcsName

pexConfig lsst.pipe.tasks.coaddBase.CoaddBaseConfig.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"
},
deprecated="This configuration is no longer used, and will be removed after v25.0",
)

Definition at line 106 of file coaddBase.py.

◆ includeCalibVar

pexConfig 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 117 of file coaddBase.py.

◆ inputRecorder

pexConfig 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 54 of file coaddBase.py.

◆ matchingKernelSize

pexConfig 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 122 of file coaddBase.py.

◆ modelPsf

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

Definition at line 63 of file coaddBase.py.

◆ select

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

Definition at line 45 of file coaddBase.py.

◆ useGlobalExternalPhotoCalib

pexConfig lsst.pipe.tasks.coaddBase.CoaddBaseConfig.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 72 of file coaddBase.py.

◆ useGlobalExternalSkyWcs

pexConfig lsst.pipe.tasks.coaddBase.CoaddBaseConfig.useGlobalExternalSkyWcs
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=("When using doApplyExternalSkyWcs, use 'global' calibrations "
"that are not run per-tract. When False, use per-tract wcs "
"files.")
)

Definition at line 99 of file coaddBase.py.


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