lsst.pipe.tasks  13.0-66-gfbf2f2ce+5
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig:
lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Public Attributes

 statistic
 
 badMaskPlanes
 

Static Public Attributes

 assembleStaticSkyModel
 
 chiThreshold
 
 minPixels
 
 doMaskNegative
 
 temporalThreshold
 
 spatialThreshold
 
 growMaskBy
 
 warpType
 
 subregionSize
 
 doSigmaClip
 
 sigmaClip
 
 clipIter
 
 scaleZeroPoint
 
 doInterp
 
 interpImage
 
 matchBackgrounds
 
 maxMatchResidualRatio
 
 maxMatchResidualRMS
 
 doWrite
 
 doNImage
 
 doMatchBackgrounds
 
 autoReference
 
 maskPropagationThresholds
 
 removeMaskPlanes
 
 doMaskBrightObjects
 
 brightObjectMaskName
 
 coaddPsf
 

Detailed Description

Definition at line 1437 of file assembleCoadd.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 1483 of file assembleCoadd.py.

◆ validate()

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

Definition at line 168 of file assembleCoadd.py.

Member Data Documentation

◆ assembleStaticSkyModel

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.assembleStaticSkyModel
static
Initial value:
= pexConfig.ConfigurableField(
target=AssembleCoaddTask,
doc="Task to assemble an artifact-free, PSF-matched Coadd to serve as a"
" naive/first-iteration model of the static sky.",
)

Definition at line 1438 of file assembleCoadd.py.

◆ autoReference

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.autoReference
staticinherited
Initial value:
= pexConfig.Field(
doc="Automatically select the coadd temp exposure to use as a reference for background matching? "
"Ignored if doMatchBackgrounds false. "
"If False you must specify the reference temp exposure as the data Id",
dtype=bool,
default=True,
)

Definition at line 129 of file assembleCoadd.py.

◆ badMaskPlanes

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.badMaskPlanes
inherited

Definition at line 166 of file assembleCoadd.py.

◆ brightObjectMaskName

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

Definition at line 156 of file assembleCoadd.py.

◆ chiThreshold

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.chiThreshold
static
Initial value:
= pexConfig.RangeField(
doc="Detection threshold (sigma) for artifacts in warp diff "
"(chi-image of PSF-Matched warp minus the model of the static sky)",
dtype=float,
default=5,
min=0,
)

Definition at line 1443 of file assembleCoadd.py.

◆ clipIter

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.clipIter
staticinherited
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of iterations of outlier rejection; ignored if non-clipping statistic selected.",
default=2,
)

Definition at line 80 of file assembleCoadd.py.

◆ coaddPsf

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

Definition at line 159 of file assembleCoadd.py.

◆ doInterp

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

◆ doMaskBrightObjects

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

Definition at line 154 of file assembleCoadd.py.

◆ doMaskNegative

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doMaskNegative
static
Initial value:
= pexConfig.Field(
doc="Also mask outlier regions of flux less than the static sky model?",
dtype=bool,
default=True
)

Definition at line 1457 of file assembleCoadd.py.

◆ doMatchBackgrounds

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.doMatchBackgrounds
staticinherited
Initial value:
= pexConfig.Field(
doc="Match backgrounds of coadd temp exposures before coadding them? "
"If False, the coadd temp expsosures must already have been background subtracted or matched",
dtype=bool,
default=False,
)

Definition at line 123 of file assembleCoadd.py.

◆ doNImage

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

Definition at line 118 of file assembleCoadd.py.

◆ doSigmaClip

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

Definition at line 70 of file assembleCoadd.py.

◆ doWrite

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

Definition at line 113 of file assembleCoadd.py.

◆ growMaskBy

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.growMaskBy
static
Initial value:
= pexConfig.Field(
doc="Number of pixels by which to grow the masks on artifacts.",
dtype=int,
default=5
)

Definition at line 1477 of file assembleCoadd.py.

◆ interpImage

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

Definition at line 94 of file assembleCoadd.py.

◆ maskPropagationThresholds

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

◆ matchBackgrounds

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.matchBackgrounds
staticinherited
Initial value:
= pexConfig.ConfigurableField(
target=MatchBackgroundsTask,
doc="Task to match backgrounds",
)

Definition at line 98 of file assembleCoadd.py.

◆ maxMatchResidualRatio

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.maxMatchResidualRatio
staticinherited
Initial value:
= pexConfig.Field(
doc="Maximum ratio of the mean squared error of the background matching model to the variance "
"of the difference in backgrounds",
dtype=float,
default=1.1
)

Definition at line 102 of file assembleCoadd.py.

◆ maxMatchResidualRMS

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.maxMatchResidualRMS
staticinherited
Initial value:
= pexConfig.Field(
doc="Maximum RMS of residuals of the background offset fit in matchBackgrounds.",
dtype=float,
default=1.0
)

Definition at line 108 of file assembleCoadd.py.

◆ minPixels

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.minPixels
static
Initial value:
= pexConfig.Field(
doc="Minimum number of pixels in a region (in a warp diff chi-image) "
"above chiThreshold to trigger masking. "
"Detected artifacts with fewer than the specified number of pixels will be ignored.",
dtype=int,
default=1
)

Definition at line 1450 of file assembleCoadd.py.

◆ removeMaskPlanes

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

Definition at line 144 of file assembleCoadd.py.

◆ scaleZeroPoint

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

Definition at line 85 of file assembleCoadd.py.

◆ sigmaClip

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.sigmaClip
staticinherited
Initial value:
= pexConfig.Field(
dtype=float,
doc="Sigma for outlier rejection; ignored if non-clipping statistic selected.",
default=3.0,
)

Definition at line 75 of file assembleCoadd.py.

◆ spatialThreshold

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.spatialThreshold
static
Initial value:
= pexConfig.Field(
doc="Unitless fraction of pixels defining how much of the outlier region has to meet the "
"temporal criteria",
dtype=float,
default=0.5
)

Definition at line 1471 of file assembleCoadd.py.

◆ statistic

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.statistic

Definition at line 1488 of file assembleCoadd.py.

◆ subregionSize

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

◆ temporalThreshold

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.temporalThreshold
static
Initial value:
= pexConfig.Field(
doc="Unitless fraction of number of epochs to classify as an artifact/outlier source versus"
" a source that is intrinsically variable or difficult to subtract cleanly. "
"If outlier region in warp-diff Chi-image is mostly (defined by spatialThreshold) "
"an outlier in less than temporalThreshold * number of epochs, then mask. "
"Otherwise, do not mask.",
dtype=float,
default=0.075
)

Definition at line 1462 of file assembleCoadd.py.

◆ warpType

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

Definition at line 53 of file assembleCoadd.py.


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