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

Configuration parameters for the AssembleCoaddTask. More...

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

Public Member Functions

def setDefaults
 
def validate
 

Public Attributes

 badMaskPlanes
 
 statistic
 

Static Public Attributes

tuple subregionSize
 
tuple statistic
 
tuple doSigmaClip
 
tuple sigmaClip
 
tuple clipIter
 
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 AssembleCoaddTask.

Definition at line 48 of file assembleCoadd.py.

Member Function Documentation

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

Definition at line 155 of file assembleCoadd.py.

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

Definition at line 159 of file assembleCoadd.py.

Member Data Documentation

tuple lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.autoReference
static
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

Definition at line 157 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.brightObjectMaskName
static
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.AssembleCoaddConfig.clipIter
static
Initial value:
1 = pexConfig.Field(
2  dtype=int,
3  doc="Number of iterations of outlier rejection; ignored if non-clipping statistic selected.",
4  default=2,
5  )

Definition at line 76 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.coaddPsf
static
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
static
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
static
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
static
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.

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

Definition at line 66 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.doWrite
static
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
static
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
static
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
static
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.AssembleCoaddConfig.maxMatchResidualRatio
static
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
static
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.AssembleCoaddConfig.removeMaskPlanes
static
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
static
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.

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

Definition at line 71 of file assembleCoadd.py.

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

Definition at line 61 of file assembleCoadd.py.

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.statistic

Definition at line 166 of file assembleCoadd.py.

tuple lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.subregionSize
static
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: