lsst.pipe.tasks g4a941329ef+046d1863bc
Loading...
Searching...
No Matches
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.CompareWarpAssembleCoaddConnections lsst.pipe.tasks.assembleCoadd.AssembleCoaddConnections

Public Member Functions

 setDefaults (self)
 
 validate (self)
 

Public Attributes

 statistic
 
 doUsePsfMatchedPolygons
 
 warpType
 

Static Public Attributes

 assembleStaticSkyModel
 
 detect
 
 detectTemplate
 
 maskStreaks
 
 streakMaskName
 
 maxNumEpochs
 
 maxFractionEpochsLow
 
 maxFractionEpochsHigh
 
 spatialThreshold
 
 doScaleWarpVariance
 
 scaleWarpVariance
 
 doPreserveContainedBySource
 
 doPrefilterArtifacts
 
 prefilterArtifactsMaskPlanes
 
 prefilterArtifactsRatio
 
 doFilterMorphological
 
 growStreakFp
 

Detailed Description

Definition at line 1222 of file assembleCoadd.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 1328 of file assembleCoadd.py.

◆ validate()

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.validate ( self)

Definition at line 1362 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 1224 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 1229 of file assembleCoadd.py.

◆ detectTemplate

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

Definition at line 1233 of file assembleCoadd.py.

◆ doFilterMorphological

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doFilterMorphological
static
Initial value:
= pexConfig.Field(
doc="Filter artifact candidates based on morphological criteria, i.g. those that appear to "
"be streaks.",
dtype=bool,
default=False
)

Definition at line 1316 of file assembleCoadd.py.

◆ doPrefilterArtifacts

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doPrefilterArtifacts
static
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 1298 of file assembleCoadd.py.

◆ doPreserveContainedBySource

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doPreserveContainedBySource
static
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 1292 of file assembleCoadd.py.

◆ doScaleWarpVariance

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

Definition at line 1283 of file assembleCoadd.py.

◆ doUsePsfMatchedPolygons

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doUsePsfMatchedPolygons

Definition at line 1331 of file assembleCoadd.py.

◆ growStreakFp

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.growStreakFp
static
Initial value:
= pexConfig.Field(
doc="Grow streak footprints by this number multiplied by the PSF width",
dtype=float,
default=5
)

Definition at line 1322 of file assembleCoadd.py.

◆ maskStreaks

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maskStreaks
static
Initial value:
= pexConfig.ConfigurableField(
target=MaskStreaksTask,
doc="Detect streaks on difference between each psfMatched warp and static sky model. Only used if "
"doFilterMorphological is True. Adds a mask plane to an exposure, with the mask plane name set by"
"streakMaskName"
)

Definition at line 1237 of file assembleCoadd.py.

◆ maxFractionEpochsHigh

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maxFractionEpochsHigh
static
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 1267 of file assembleCoadd.py.

◆ maxFractionEpochsLow

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maxFractionEpochsLow
static
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 1259 of file assembleCoadd.py.

◆ maxNumEpochs

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.maxNumEpochs
static
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 1248 of file assembleCoadd.py.

◆ prefilterArtifactsMaskPlanes

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.prefilterArtifactsMaskPlanes
static
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 1306 of file assembleCoadd.py.

◆ prefilterArtifactsRatio

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

Definition at line 1311 of file assembleCoadd.py.

◆ scaleWarpVariance

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

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

◆ statistic

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.statistic

Definition at line 1330 of file assembleCoadd.py.

◆ streakMaskName

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.streakMaskName
static
Initial value:
= pexConfig.Field(
dtype=str,
default="STREAK",
doc="Name of mask bit used for streaks"
)

Definition at line 1243 of file assembleCoadd.py.

◆ warpType

lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.warpType

Definition at line 1368 of file assembleCoadd.py.


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