Inheritance diagram for lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig:
Public Member Functions | |
| def | setDefaults (self) |
| def | validate (self) |
Public Attributes | |
| badMaskPlanes | |
Detailed Description
Configuration parameters for the `AssembleCoaddTask`.
Notes
-----
The `doMaskBrightObjects` and `brightObjectMaskName` configuration options
only set the bitplane config.brightObjectMaskName. To make this useful you
*must* also configure the flags.pixel algorithm, for example by adding
.. code-block:: none
config.measurement.plugins["base_PixelFlags"].masksFpCenter.append("BRIGHT_OBJECT")
config.measurement.plugins["base_PixelFlags"].masksFpAnywhere.append("BRIGHT_OBJECT")
to your measureCoaddSources.py and forcedPhotCoadd.py config overrides.
Definition at line 47 of file assembleCoadd.py.
Member Function Documentation
◆ setDefaults()
| def lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.setDefaults | ( | self | ) |
Definition at line 153 of file assembleCoadd.py.
◆ validate()
| def lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.validate | ( | self | ) |
Definition at line 157 of file assembleCoadd.py.
Member Data Documentation
◆ badMaskPlanes
| lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.badMaskPlanes |
Definition at line 155 of file assembleCoadd.py.
◆ brightObjectMaskName
|
static |
Initial value:
= pexConfig.Field(dtype=str, default="BRIGHT_OBJECT",
doc="Name of mask bit used for bright objects")
Definition at line 141 of file assembleCoadd.py.
◆ calcErrorFromInputVariance
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Calculate coadd variance from input variance by stacking statistic."
"Passed to StatisticsControl.setCalcErrorFromInputVariance()",
default=True,
)
Definition at line 95 of file assembleCoadd.py.
◆ clipIter
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of iterations of outlier rejection; ignored if non-clipping statistic selected.",
default=2,
)
Definition at line 90 of file assembleCoadd.py.
◆ coaddPsf
|
static |
Initial value:
= pexConfig.ConfigField(
doc="Configuration for CoaddPsf",
dtype=measAlg.CoaddPsfConfig,
)
Definition at line 143 of file assembleCoadd.py.
◆ doAttachTransmissionCurve
|
static |
Initial value:
= pexConfig.Field(
dtype=bool, default=False, optional=False,
doc=("Attach a piecewise TransmissionCurve for the coadd? "
"(requires all input Exposures to have TransmissionCurves).")
)
Definition at line 147 of file assembleCoadd.py.
◆ doInterp
|
static |
Initial value:
= pexConfig.Field(
doc="Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly.",
dtype=bool,
default=True,
)
Definition at line 105 of file assembleCoadd.py.
◆ doMaskBrightObjects
|
static |
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc="Set mask and flag bits for bright objects?")
Definition at line 139 of file assembleCoadd.py.
◆ doNImage
|
static |
Initial value:
= pexConfig.Field(
doc="Create image of number of contributing exposures for each pixel",
dtype=bool,
default=False,
)
Definition at line 119 of file assembleCoadd.py.
◆ doSigmaClip
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Perform sigma clipped outlier rejection with MEANCLIP statistic? (DEPRECATED)",
default=False,
)
Definition at line 80 of file assembleCoadd.py.
◆ doUsePsfMatchedPolygons
|
static |
Initial value:
= pexConfig.Field(
doc="Use ValidPolygons from shrunk Psf-Matched Calexps? Should be set to True by CompareWarp only.",
dtype=bool,
default=False,
)
Definition at line 124 of file assembleCoadd.py.
◆ doWrite
|
static |
Initial value:
= pexConfig.Field(
doc="Persist coadd?",
dtype=bool,
default=True,
)
Definition at line 114 of file assembleCoadd.py.
◆ interpImage
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=InterpImageTask,
doc="Task to interpolate (and extrapolate) over NaN pixels",
)
Definition at line 110 of file assembleCoadd.py.
◆ maskPropagationThresholds
|
static |
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=float,
doc=("Threshold (in fractional weight) of rejection at which we propagate a mask plane to "
"the coadd; that is, we set the mask bit on the coadd if the fraction the rejected frames "
"would have contributed exceeds this value."),
default={"SAT": 0.1},
)
Definition at line 129 of file assembleCoadd.py.
◆ removeMaskPlanes
|
static |
Initial value:
= pexConfig.ListField(dtype=str, default=["NOT_DEBLENDED"],
doc="Mask planes to remove before coadding")
Definition at line 137 of file assembleCoadd.py.
◆ scaleZeroPoint
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ScaleZeroPointTask,
doc="Task to adjust the photometric zero point of the coadd temp exposures",
)
Definition at line 101 of file assembleCoadd.py.
◆ sigmaClip
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Sigma for outlier rejection; ignored if non-clipping statistic selected.",
default=3.0,
)
Definition at line 85 of file assembleCoadd.py.
◆ statistic
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Main stacking statistic for aggregating over the epochs.",
default="MEANCLIP",
)
Definition at line 75 of file assembleCoadd.py.
◆ subregionSize
|
static |
Initial value:
= pexConfig.ListField(
dtype=int,
doc="Width, height of stack subregion size; "
"make small enough that a full stack of images will fit into memory at once.",
length=2,
default=(2000, 2000),
)
Definition at line 68 of file assembleCoadd.py.
◆ warpType
|
static |
Initial value:
= pexConfig.Field(
doc="Warp name: one of 'direct' or 'psfMatched'",
dtype=str,
default="direct",
)
Definition at line 63 of file assembleCoadd.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/assembleCoadd.py
