lsst.pipe.tasks  17.0.1-9-g748177e3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig:
lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Public Attributes

 badMaskPlanes
 

Static Public Attributes

 warpType
 
 subregionSize
 
 statistic
 
 doSigmaClip
 
 sigmaClip
 
 clipIter
 
 calcErrorFromInputVariance
 
 scaleZeroPoint
 
 doInterp
 
 interpImage
 
 doWrite
 
 doNImage
 
 doUsePsfMatchedPolygons
 
 maskPropagationThresholds
 
 removeMaskPlanes
 
 doMaskBrightObjects
 
 brightObjectMaskName
 
 coaddPsf
 
 doAttachTransmissionCurve
 
 inputWarps
 
 skyMap
 
 brightObjectMask
 
 coaddExposure
 
 nImage
 

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

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.setDefaults (   self)

Definition at line 192 of file assembleCoadd.py.

◆ validate()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.validate (   self)

Definition at line 199 of file assembleCoadd.py.

Member Data Documentation

◆ badMaskPlanes

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.badMaskPlanes

Definition at line 194 of file assembleCoadd.py.

◆ brightObjectMask

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.brightObjectMask
static
Initial value:
= pipeBase.InputDatasetField(
doc=("Input Bright Object Mask mask produced with external catalogs to be applied to the mask plane"
" BRIGHT_OBJECT."),
name="brightObjectMask",
storageClass="ObjectMaskCatalog",
dimensions=("Tract", "Patch", "SkyMap", "AbstractFilter"),
scalar=True
)

Definition at line 169 of file assembleCoadd.py.

◆ brightObjectMaskName

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.brightObjectMaskName
static
Initial value:
= pexConfig.Field(dtype=str, default="BRIGHT_OBJECT",
doc="Name of mask bit used for bright objects")

Definition at line 143 of file assembleCoadd.py.

◆ calcErrorFromInputVariance

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.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 97 of file assembleCoadd.py.

◆ clipIter

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.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 92 of file assembleCoadd.py.

◆ coaddExposure

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.coaddExposure
static
Initial value:
= pipeBase.OutputDatasetField(
doc="Output coadded exposure, produced by stacking input warps",
nameTemplate="{outputCoaddName}Coadd",
storageClass="ExposureF",
dimensions=("Tract", "Patch", "SkyMap", "AbstractFilter"),
scalar=True
)

Definition at line 177 of file assembleCoadd.py.

◆ coaddPsf

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.coaddPsf
static
Initial value:
= pexConfig.ConfigField(
doc="Configuration for CoaddPsf",
dtype=measAlg.CoaddPsfConfig,
)

Definition at line 145 of file assembleCoadd.py.

◆ doAttachTransmissionCurve

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.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 149 of file assembleCoadd.py.

◆ doInterp

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.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 107 of file assembleCoadd.py.

◆ doMaskBrightObjects

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.doMaskBrightObjects
static
Initial value:
= pexConfig.Field(dtype=bool, default=False,
doc="Set mask and flag bits for bright objects?")

Definition at line 141 of file assembleCoadd.py.

◆ doNImage

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.doNImage
static
Initial value:
= pexConfig.Field(
doc="Create image of number of contributing exposures for each pixel",
dtype=bool,
default=False,
)

Definition at line 121 of file assembleCoadd.py.

◆ doSigmaClip

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.doSigmaClip
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Perform sigma clipped outlier rejection with MEANCLIP statistic? (DEPRECATED)",
default=False,
)

Definition at line 82 of file assembleCoadd.py.

◆ doUsePsfMatchedPolygons

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.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 126 of file assembleCoadd.py.

◆ doWrite

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.doWrite
static
Initial value:
= pexConfig.Field(
doc="Persist coadd?",
dtype=bool,
default=True,
)

Definition at line 116 of file assembleCoadd.py.

◆ inputWarps

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.inputWarps
static
Initial value:
= pipeBase.InputDatasetField(
doc=("Input list of warps to be assemebled i.e. stacked."
"WarpType (e.g. direct, psfMatched) is controlled by we warpType config parameter"),
nameTemplate="{inputCoaddName}Coadd_{warpType}Warp",
storageClass="ExposureF",
dimensions=("Tract", "Patch", "SkyMap", "Visit", "Instrument"),
manualLoad=True,
)

Definition at line 154 of file assembleCoadd.py.

◆ interpImage

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.interpImage
static
Initial value:
= pexConfig.ConfigurableField(
target=InterpImageTask,
doc="Task to interpolate (and extrapolate) over NaN pixels",
)

Definition at line 112 of file assembleCoadd.py.

◆ maskPropagationThresholds

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.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 131 of file assembleCoadd.py.

◆ nImage

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.nImage
static
Initial value:
= pipeBase.OutputDatasetField(
doc="Output image of number of input images per pixel",
nameTemplate="{outputCoaddName}Coadd_nImage",
storageClass="ImageU",
dimensions=("Tract", "Patch", "SkyMap", "AbstractFilter"),
scalar=True
)

Definition at line 184 of file assembleCoadd.py.

◆ removeMaskPlanes

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.removeMaskPlanes
static
Initial value:
= pexConfig.ListField(dtype=str, default=["NOT_DEBLENDED"],
doc="Mask planes to remove before coadding")

Definition at line 139 of file assembleCoadd.py.

◆ scaleZeroPoint

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.scaleZeroPoint
static
Initial value:
= pexConfig.ConfigurableField(
target=ScaleZeroPointTask,
doc="Task to adjust the photometric zero point of the coadd temp exposures",
)

Definition at line 103 of file assembleCoadd.py.

◆ sigmaClip

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.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 87 of file assembleCoadd.py.

◆ skyMap

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.skyMap
static
Initial value:
= pipeBase.InputDatasetField(
doc="Input definition of geometry/bbox and projection/wcs for coadded exposures",
nameTemplate="{inputCoaddName}Coadd_skyMap",
storageClass="SkyMap",
dimensions=("SkyMap", ),
scalar=True
)

Definition at line 162 of file assembleCoadd.py.

◆ statistic

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.statistic
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Main stacking statistic for aggregating over the epochs.",
default="MEANCLIP",
)

Definition at line 77 of file assembleCoadd.py.

◆ subregionSize

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.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 70 of file assembleCoadd.py.

◆ warpType

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.warpType
static
Initial value:
= pexConfig.Field(
doc="Warp name: one of 'direct' or 'psfMatched'",
dtype=str,
default="direct",
)

Definition at line 65 of file assembleCoadd.py.


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