lsst.pipe.tasks  14.0-34-g85a33b94+2
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
 
 detect
 
 maxNumEpochs
 
 maxFractionEpochs
 
 spatialThreshold
 
 warpType
 
 subregionSize
 
 doSigmaClip
 
 sigmaClip
 
 clipIter
 
 scaleZeroPoint
 
 doInterp
 
 interpImage
 
 doWrite
 
 doNImage
 
 maskPropagationThresholds
 
 removeMaskPlanes
 
 doMaskBrightObjects
 
 brightObjectMaskName
 
 coaddPsf
 

Detailed Description

Definition at line 1262 of file assembleCoadd.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 1296 of file assembleCoadd.py.

◆ validate()

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

Definition at line 141 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 1263 of file assembleCoadd.py.

◆ badMaskPlanes

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

Definition at line 139 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 129 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 81 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 132 of file assembleCoadd.py.

◆ detect

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.detect
static
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Detect outlier sources on difference between each psfMatched warp and static sky model"
)

Definition at line 1268 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 90 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 127 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 104 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 71 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 99 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 95 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 109 of file assembleCoadd.py.

◆ maxFractionEpochs

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maxFractionEpochs
static
Initial value:
= pexConfig.RangeField(
doc="Fraction of local number of epochs (N) to use as maxNumEpochs. "
"Effective maxNumEpochs is the lesser of floor(maxNumEpochsMinFraction*N) and maxNumEpochs. ",
dtype=float,
default=0.4,
min=0., max=1.,
)

Definition at line 1280 of file assembleCoadd.py.

◆ maxNumEpochs

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maxNumEpochs
static
Initial value:
= pexConfig.Field(
doc="Maximum number of epochs/visits in which an artifact candidate can appear and still be masked. "
"For each footprint detected on the image difference between the psfMatched warp and static sky "
"model, if a significant fraction of pixels (defined by spatialThreshold) are residuals in more "
"than maxNumEpochs, the artifact candidate is persistant rather than transient and not masked.",
dtype=int,
default=2
)

Definition at line 1272 of file assembleCoadd.py.

◆ removeMaskPlanes

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

Definition at line 117 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 86 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 76 of file assembleCoadd.py.

◆ spatialThreshold

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.spatialThreshold
static
Initial value:
= pexConfig.RangeField(
doc="Unitless fraction of pixels defining how much of the outlier region has to meet the "
"temporal criteria. If 0, clip all. If 1, clip none.",
dtype=float,
default=0.5,
min=0., max=1.,
inclusiveMin=True, inclusiveMax=True
)

Definition at line 1287 of file assembleCoadd.py.

◆ statistic

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.statistic

Definition at line 1298 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 59 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 54 of file assembleCoadd.py.


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