lsst.pipe.tasks  13.0-60-g3ba4059d+4
 All Classes Namespaces Files Functions Variables Groups Pages
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig Class Reference

Configuration parameters for the SafeClipAssembleCoaddTask. More...

Inheritance diagram for lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig:
lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig

Public Member Functions

def setDefaults
 
def validate
 

Public Attributes

 sigmaClip
 
 clipIter
 
 statistic
 
 doSigmaClip
 
 badMaskPlanes
 

Static Public Attributes

tuple clipDetection
 
tuple minClipFootOverlap
 
tuple minClipFootOverlapSingle
 
tuple minClipFootOverlapDouble
 
tuple maxClipFootOverlapDouble
 
tuple minBigOverlap
 
tuple subregionSize
 
tuple scaleZeroPoint
 
tuple doInterp
 
tuple interpImage
 
tuple matchBackgrounds
 
tuple maxMatchResidualRatio
 
tuple maxMatchResidualRMS
 
tuple doWrite
 
tuple doMatchBackgrounds
 
tuple autoReference
 
tuple maskPropagationThresholds
 
tuple removeMaskPlanes
 
tuple doMaskBrightObjects
 
tuple brightObjectMaskName
 
tuple coaddPsf
 

Detailed Description

Configuration parameters for the SafeClipAssembleCoaddTask.

Definition at line 929 of file assembleCoadd.py.

Member Function Documentation

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

Definition at line 968 of file assembleCoadd.py.

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

Definition at line 985 of file assembleCoadd.py.

Member Data Documentation

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

Definition at line 120 of file assembleCoadd.py.

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

Definition at line 157 of file assembleCoadd.py.

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

Definition at line 147 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.clipDetection
static
Initial value:
1 = pexConfig.ConfigurableField(
2  target=SourceDetectionTask,
3  doc="Detect sources on difference between unclipped and clipped coadd")

Definition at line 935 of file assembleCoadd.py.

lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.clipIter

Definition at line 982 of file assembleCoadd.py.

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

Definition at line 150 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.doInterp
staticinherited
Initial value:
1 = pexConfig.Field(
2  doc="Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly.",
3  dtype=bool,
4  default=True,
5  )

Definition at line 85 of file assembleCoadd.py.

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

Definition at line 145 of file assembleCoadd.py.

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

Definition at line 114 of file assembleCoadd.py.

lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.doSigmaClip

Definition at line 989 of file assembleCoadd.py.

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

Definition at line 109 of file assembleCoadd.py.

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

Definition at line 90 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.maskPropagationThresholds
staticinherited
Initial value:
1 = pexConfig.DictField(
2  keytype=str,
3  itemtype=float,
4  doc=("Threshold (in fractional weight) of rejection at which we propagate a mask plane to "
5  "the coadd; that is, we set the mask bit on the coadd if the fraction the rejected frames "
6  "would have contributed exceeds this value."),
7  default={"SAT": 0.1},
8  )

Definition at line 127 of file assembleCoadd.py.

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

Definition at line 94 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.maxClipFootOverlapDouble
static
Initial value:
1 = pexConfig.Field(
2  doc="Maximum fractional overlap of clipped footprints with visit DETECTED when "
3  "considering two visits",
4  dtype=float,
5  default=0.15
6  )

Definition at line 955 of file assembleCoadd.py.

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

Definition at line 98 of file assembleCoadd.py.

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

Definition at line 104 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.minBigOverlap
static
Initial value:
1 = pexConfig.Field(
2  doc="Minimum number of pixels in footprint to use DETECTED mask from the single visits "
3  "when labeling clipped footprints",
4  dtype=int,
5  default=100
6  )

Definition at line 961 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.minClipFootOverlap
static
Initial value:
1 = pexConfig.Field(
2  doc="Minimum fractional overlap of clipped footprint with visit DETECTED to be clipped",
3  dtype=float,
4  default=0.6
5  )

Definition at line 938 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.minClipFootOverlapDouble
static
Initial value:
1 = pexConfig.Field(
2  doc="Minimum fractional overlap of clipped footprints with visit DETECTED to be "
3  "clipped when two visits overlap",
4  dtype=float,
5  default=0.45
6  )

Definition at line 949 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.minClipFootOverlapSingle
static
Initial value:
1 = pexConfig.Field(
2  doc="Minimum fractional overlap of clipped footprint with visit DETECTED to be "
3  "clipped when only one visit overlaps",
4  dtype=float,
5  default=0.5
6  )

Definition at line 943 of file assembleCoadd.py.

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

Definition at line 135 of file assembleCoadd.py.

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

Definition at line 81 of file assembleCoadd.py.

lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.sigmaClip

Definition at line 981 of file assembleCoadd.py.

lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddConfig.statistic

Definition at line 983 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.subregionSize
staticinherited
Initial value:
1 = pexConfig.ListField(
2  dtype=int,
3  doc="Width, height of stack subregion size; "
4  "make small enough that a full stack of images will fit into memory at once.",
5  length=2,
6  default=(2000, 2000),
7  )

Definition at line 54 of file assembleCoadd.py.


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