lsst.pipe.tasks  16.0-54-gbf35a124
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig:
lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Public Attributes

 doNImage
 
 warpType
 
 statistic
 
 doUsePsfMatchedPolygons
 
 badMaskPlanes
 

Static Public Attributes

 dcrNumSubfilters
 
 maxNumIter
 
 minNumIter
 
 convergenceThreshold
 
 useConvergence
 
 baseGain
 
 useProgressiveGain
 
 doAirmassWeight
 
 modelWeightsWidth
 
 useModelWeights
 
 splitSubfilters
 
 regularizeModelIterations
 
 regularizeModelFrequency
 
 convergenceMaskPlanes
 
 regularizationWidth
 
 imageWarpMethod
 
 maskWarpMethod
 
 assembleStaticSkyModel
 
 detect
 
 detectTemplate
 
 maxNumEpochs
 
 maxFractionEpochsLow
 
 maxFractionEpochsHigh
 
 spatialThreshold
 
 doScaleWarpVariance
 
 scaleWarpVariance
 
 doPreserveContainedBySource
 
 doPrefilterArtifacts
 
 prefilterArtifactsMaskPlanes
 
 prefilterArtifactsRatio
 
 subregionSize
 
 doSigmaClip
 
 sigmaClip
 
 clipIter
 
 calcErrorFromInputVariance
 
 scaleZeroPoint
 
 doInterp
 
 interpImage
 
 doWrite
 
 maskPropagationThresholds
 
 removeMaskPlanes
 
 doMaskBrightObjects
 
 brightObjectMaskName
 
 coaddPsf
 
 doAttachTransmissionCurve
 

Detailed Description

Definition at line 38 of file dcrAssembleCoadd.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.setDefaults (   self)

Definition at line 137 of file dcrAssembleCoadd.py.

◆ validate()

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

Definition at line 157 of file assembleCoadd.py.

Member Data Documentation

◆ assembleStaticSkyModel

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.assembleStaticSkyModel
staticinherited
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 1529 of file assembleCoadd.py.

◆ badMaskPlanes

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

Definition at line 155 of file assembleCoadd.py.

◆ baseGain

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.baseGain
static
Initial value:
= pexConfig.Field(
dtype=float,
optional=True,
doc="Relative weight to give the new solution vs. the last solution when updating the model."
"A value of 1.0 gives equal weight to both solutions."
"Small values imply slower convergence of the solution, but can "
"help prevent overshooting and failures in the fit."
"If ``baseGain`` is None, a conservative gain "
"will be calculated from the number of subfilters. ",
default=None,
)

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

◆ calcErrorFromInputVariance

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.calcErrorFromInputVariance
staticinherited
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 95 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 90 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 143 of file assembleCoadd.py.

◆ convergenceMaskPlanes

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.convergenceMaskPlanes
static
Initial value:
= pexConfig.ListField(
dtype=str,
default=["DETECTED"],
doc="Mask planes to use to calculate convergence."
)

Definition at line 116 of file dcrAssembleCoadd.py.

◆ convergenceThreshold

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.convergenceThreshold
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Target relative change in convergence between iterations of forward modeling.",
default=0.001,
)

Definition at line 54 of file dcrAssembleCoadd.py.

◆ dcrNumSubfilters

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.dcrNumSubfilters
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of sub-filters to forward model chromatic effects to fit the supplied exposures.",
default=3,
)

Definition at line 39 of file dcrAssembleCoadd.py.

◆ detect

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

Definition at line 1534 of file assembleCoadd.py.

◆ detectTemplate

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.detectTemplate
staticinherited
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Detect sources on static sky model. Only used if doPreserveContainedBySource is True"
)

Definition at line 1538 of file assembleCoadd.py.

◆ doAirmassWeight

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.doAirmassWeight
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Weight exposures by airmass? Useful if there are relatively few high-airmass observations.",
default=True,
)

Definition at line 83 of file dcrAssembleCoadd.py.

◆ doAttachTransmissionCurve

lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig.doAttachTransmissionCurve
staticinherited
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 147 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 105 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 139 of file assembleCoadd.py.

◆ doNImage

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.doNImage

Definition at line 140 of file dcrAssembleCoadd.py.

◆ doPrefilterArtifacts

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doPrefilterArtifacts
staticinherited
Initial value:
= pexConfig.Field(
doc="Ignore artifact candidates that are mostly covered by the bad pixel mask, "
"because they will be excluded anyway. This prevents them from contributing "
"to the outlier epoch count image and potentially being labeled as persistant."
"'Mostly' is defined by the config 'prefilterArtifactsRatio'.",
dtype=bool,
default=True
)

Definition at line 1592 of file assembleCoadd.py.

◆ doPreserveContainedBySource

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doPreserveContainedBySource
staticinherited
Initial value:
= pexConfig.Field(
doc="Rescue artifacts from clipping that completely lie within a footprint detected"
"on the PsfMatched Template Coadd. Replicates a behavior of SafeClip.",
dtype=bool,
default=True,
)

Definition at line 1586 of file assembleCoadd.py.

◆ doScaleWarpVariance

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doScaleWarpVariance
staticinherited
Initial value:
= pexConfig.Field(
doc="Rescale Warp variance plane using empirical noise?",
dtype=bool,
default=True,
)

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

◆ doUsePsfMatchedPolygons

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doUsePsfMatchedPolygons
inherited

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

◆ imageWarpMethod

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.imageWarpMethod
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the warping kernel to use for shifting the image and variance planes.",
default="lanczos3",
)

Definition at line 126 of file dcrAssembleCoadd.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 110 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 129 of file assembleCoadd.py.

◆ maskWarpMethod

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.maskWarpMethod
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the warping kernel to use for shifting the mask plane.",
default="bilinear",
)

Definition at line 131 of file dcrAssembleCoadd.py.

◆ maxFractionEpochsHigh

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maxFractionEpochsHigh
staticinherited
Initial value:
= pexConfig.RangeField(
doc="Fraction of local number of epochs (N) to use as effective maxNumEpochs for high N. "
"Effective maxNumEpochs = "
"min(maxFractionEpochsLow * N, maxNumEpochs + maxFractionEpochsHigh * N)",
dtype=float,
default=0.03,
min=0., max=1.,
)

Definition at line 1561 of file assembleCoadd.py.

◆ maxFractionEpochsLow

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maxFractionEpochsLow
staticinherited
Initial value:
= pexConfig.RangeField(
doc="Fraction of local number of epochs (N) to use as effective maxNumEpochs for low N. "
"Effective maxNumEpochs = "
"min(maxFractionEpochsLow * N, maxNumEpochs + maxFractionEpochsHigh * N)",
dtype=float,
default=0.4,
min=0., max=1.,
)

Definition at line 1553 of file assembleCoadd.py.

◆ maxNumEpochs

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maxNumEpochs
staticinherited
Initial value:
= pexConfig.Field(
doc="Charactistic maximum local number of epochs/visits in which an artifact candidate can appear "
"and still be masked. The effective maxNumEpochs is a broken linear function of local "
"number of epochs (N): min(maxFractionEpochsLow*N, maxNumEpochs + maxFractionEpochsHigh*N). "
"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 the computed effective maxNumEpochs, the artifact candidate is deemed persistant rather "
"than transient and not masked.",
dtype=int,
default=2
)

Definition at line 1542 of file assembleCoadd.py.

◆ maxNumIter

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.maxNumIter
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum number of iterations of forward modeling.",
default=8,
)

Definition at line 44 of file dcrAssembleCoadd.py.

◆ minNumIter

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.minNumIter
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Minimum number of iterations of forward modeling.",
default=3,
)

Definition at line 49 of file dcrAssembleCoadd.py.

◆ modelWeightsWidth

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.modelWeightsWidth
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Width of the region around detected sources to include in the DcrModel.",
default=3,
)

Definition at line 88 of file dcrAssembleCoadd.py.

◆ prefilterArtifactsMaskPlanes

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.prefilterArtifactsMaskPlanes
staticinherited
Initial value:
= pexConfig.ListField(
doc="Prefilter artifact candidates that are mostly covered by these bad mask planes.",
dtype=str,
default=('NO_DATA', 'BAD', 'SAT', 'SUSPECT'),
)

Definition at line 1600 of file assembleCoadd.py.

◆ prefilterArtifactsRatio

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.prefilterArtifactsRatio
staticinherited
Initial value:
= pexConfig.Field(
doc="Prefilter artifact candidates with less than this fraction overlapping good pixels",
dtype=float,
default=0.05
)

Definition at line 1605 of file assembleCoadd.py.

◆ regularizationWidth

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.regularizationWidth
static
Initial value:
= pexConfig.Field(
dtype=int,
default=2,
doc="Minimum radius of a region to include in regularization, in pixels."
)

Definition at line 121 of file dcrAssembleCoadd.py.

◆ regularizeModelFrequency

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.regularizeModelFrequency
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum relative change of the model allowed between subfilters."
"Set to zero to disable.",
default=4.,
)

Definition at line 110 of file dcrAssembleCoadd.py.

◆ regularizeModelIterations

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.regularizeModelIterations
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum relative change of the model allowed between iterations."
"Set to zero to disable.",
default=2.,
)

Definition at line 104 of file dcrAssembleCoadd.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 137 of file assembleCoadd.py.

◆ scaleWarpVariance

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.scaleWarpVariance
staticinherited
Initial value:
= pexConfig.ConfigurableField(
target=ScaleVarianceTask,
doc="Rescale variance on warps",
)

Definition at line 1582 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 101 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 85 of file assembleCoadd.py.

◆ spatialThreshold

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.spatialThreshold
staticinherited
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 1569 of file assembleCoadd.py.

◆ splitSubfilters

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.splitSubfilters
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Calculate DCR for two evenly-spaced wavelengths in each subfilter."
"Instead of at the midpoint",
default=False,
)

Definition at line 98 of file dcrAssembleCoadd.py.

◆ statistic

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.statistic

Definition at line 146 of file dcrAssembleCoadd.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 68 of file assembleCoadd.py.

◆ useConvergence

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.useConvergence
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use convergence test as a forward modeling end condition?"
"If not set, skips calculating convergence and runs for ``maxNumIter`` iterations",
default=True,
)

Definition at line 59 of file dcrAssembleCoadd.py.

◆ useModelWeights

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.useModelWeights
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Width of the region around detected sources to include in the DcrModel.",
default=True,
)

Definition at line 93 of file dcrAssembleCoadd.py.

◆ useProgressiveGain

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.useProgressiveGain
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use a gain that slowly increases above ``baseGain`` to accelerate convergence? "
"When calculating the next gain, we use up to 5 previous gains and convergence values."
"Can be set to False to force the model to change at the rate of ``baseGain``. ",
default=True,
)

Definition at line 76 of file dcrAssembleCoadd.py.

◆ warpType

lsst.pipe.tasks.dcrAssembleCoadd.DcrAssembleCoaddConfig.warpType

Definition at line 141 of file dcrAssembleCoadd.py.


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