Inheritance diagram for lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig:
Public Member Functions | |
| setDefaults (self) | |
| validate (self) | |
Public Attributes | |
| statistic | |
| doUsePsfMatchedPolygons | |
| warpType | |
Detailed Description
Definition at line 1221 of file assembleCoadd.py.
Member Function Documentation
◆ setDefaults()
| lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.setDefaults | ( | self | ) |
Definition at line 1327 of file assembleCoadd.py.
1327 def setDefaults(self):
1328 AssembleCoaddConfig.setDefaults(self)
1329 self.statistic = 'MEAN'
1330 self.doUsePsfMatchedPolygons = True
1331
1332 # Real EDGE removed by psfMatched NO_DATA border half the width of the matching kernel
1333 # CompareWarp applies psfMatched EDGE pixels to directWarps before assembling
1334 if "EDGE" in self.badMaskPlanes:
1335 self.badMaskPlanes.remove('EDGE')
1336 self.removeMaskPlanes.append('EDGE')
1337 self.assembleStaticSkyModel.badMaskPlanes = ["NO_DATA", ]
1338 self.assembleStaticSkyModel.warpType = 'psfMatched'
1339 self.assembleStaticSkyModel.connections.warpType = 'psfMatched'
1340 self.assembleStaticSkyModel.statistic = 'MEANCLIP'
1341 self.assembleStaticSkyModel.sigmaClip = 2.5
1342 self.assembleStaticSkyModel.clipIter = 3
1343 self.assembleStaticSkyModel.calcErrorFromInputVariance = False
1344 self.assembleStaticSkyModel.doWrite = False
1345 self.detect.doTempLocalBackground = False
1346 self.detect.reEstimateBackground = False
1347 self.detect.returnOriginalFootprints = False
1348 self.detect.thresholdPolarity = "both"
1349 self.detect.thresholdValue = 5
1350 self.detect.minPixels = 4
1351 self.detect.isotropicGrow = True
1352 self.detect.thresholdType = "pixel_stdev"
1353 self.detect.nSigmaToGrow = 0.4
1354 # The default nSigmaToGrow for SourceDetectionTask is already 2.4,
1355 # Explicitly restating because ratio with detect.nSigmaToGrow matters
1356 self.detectTemplate.nSigmaToGrow = 2.4
1357 self.detectTemplate.doTempLocalBackground = False
1358 self.detectTemplate.reEstimateBackground = False
1359 self.detectTemplate.returnOriginalFootprints = False
1360
◆ validate()
| lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.validate | ( | self | ) |
Definition at line 1361 of file assembleCoadd.py.
1361 def validate(self):
1362 super().validate()
1363 if self.assembleStaticSkyModel.doNImage:
1364 raise ValueError("No dataset type exists for a PSF-Matched Template N Image."
1365 "Please set assembleStaticSkyModel.doNImage=False")
1366
1367 if self.assembleStaticSkyModel.doWrite and (self.warpType == self.assembleStaticSkyModel.warpType):
1368 raise ValueError("warpType (%s) == assembleStaticSkyModel.warpType (%s) and will compete for "
1369 "the same dataset name. Please set assembleStaticSkyModel.doWrite to False "
1370 "or warpType to 'direct'. assembleStaticSkyModel.warpType should ways be "
1371 "'PsfMatched'" % (self.warpType, self.assembleStaticSkyModel.warpType))
1372
1373
Member Data Documentation
◆ 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 1223 of file assembleCoadd.py.
◆ 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 1228 of file assembleCoadd.py.
◆ detectTemplate
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Detect sources on static sky model. Only used if doPreserveContainedBySource is True"
)
Definition at line 1232 of file assembleCoadd.py.
◆ 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 1315 of file assembleCoadd.py.
◆ 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 1297 of file assembleCoadd.py.
◆ 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 1291 of file assembleCoadd.py.
◆ doScaleWarpVariance
|
static |
Initial value:
= pexConfig.Field(
doc="Rescale Warp variance plane using empirical noise?",
dtype=bool,
default=True,
)
Definition at line 1282 of file assembleCoadd.py.
◆ doUsePsfMatchedPolygons
| lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.doUsePsfMatchedPolygons |
Definition at line 1330 of file assembleCoadd.py.
◆ 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 1321 of file assembleCoadd.py.
◆ 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 1236 of file assembleCoadd.py.
◆ 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 1266 of file assembleCoadd.py.
◆ 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 1258 of file assembleCoadd.py.
◆ 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 1247 of file assembleCoadd.py.
◆ 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 1305 of file assembleCoadd.py.
◆ 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 1310 of file assembleCoadd.py.
◆ scaleWarpVariance
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ScaleVarianceTask,
doc="Rescale variance on warps",
)
Definition at line 1287 of file assembleCoadd.py.
◆ 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 1274 of file assembleCoadd.py.
◆ statistic
| lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.statistic |
Definition at line 1329 of file assembleCoadd.py.
◆ streakMaskName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
default="STREAK",
doc="Name of mask bit used for streaks"
)
Definition at line 1242 of file assembleCoadd.py.
◆ warpType
| lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig.warpType |
Definition at line 1367 of file assembleCoadd.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-7.0.1/Linux64/pipe_tasks/gb957171fc7+21ad70029f/python/lsst/pipe/tasks/assembleCoadd.py
