Inheritance diagram for lsst.ip.isr.isrTaskLSST.IsrTaskLSSTConfig:
Public Member Functions | |
| validate (self) | |
| setDefaults (self) | |
Detailed Description
Configuration parameters for IsrTaskLSST. Items are grouped in the order in which they are executed by the task.
Definition at line 172 of file isrTaskLSST.py.
Member Function Documentation
◆ setDefaults()
| lsst.ip.isr.isrTaskLSST.IsrTaskLSSTConfig.setDefaults | ( | self | ) |
Definition at line 496 of file isrTaskLSST.py.
496 def setDefaults(self):
497 super().setDefaults()
498
499
◆ validate()
| lsst.ip.isr.isrTaskLSST.IsrTaskLSSTConfig.validate | ( | self | ) |
Definition at line 487 of file isrTaskLSST.py.
487 def validate(self):
488 super().validate()
489
490 if self.doCalculateStatistics and self.isrStats.doCtiStatistics:
491 # DM-41912: Implement doApplyGains in LSST IsrTask
492 # if self.doApplyGains !=
493 # self.isrStats.doApplyGainsForCtiStatistics:
494 raise ValueError("doApplyGains must match isrStats.applyGainForCtiStatistics.")
495
Member Data Documentation
◆ assembleCcd
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=AssembleCcdTask,
doc="CCD assembly task.",
)
Definition at line 211 of file isrTaskLSST.py.
◆ binFactor1
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Binning factor for first binned exposure. This is intended for a finely binned output.",
default=8,
check=lambda x: x > 1,
)
Definition at line 474 of file isrTaskLSST.py.
◆ binFactor2
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Binning factor for second binned exposure. This is intended for a coarsely binned output.",
default=64,
check=lambda x: x > 1,
)
Definition at line 480 of file isrTaskLSST.py.
◆ brighterFatterApplyGain
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should the gain be applied when applying the brighter-fatter correction?",
default=True,
)
Definition at line 387 of file isrTaskLSST.py.
◆ brighterFatterFwhmForInterpolation
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="FWHM of PSF in arcseconds used for interpolation in brighter-fatter correction "
"(currently unused).",
default=1.0,
)
Definition at line 404 of file isrTaskLSST.py.
◆ brighterFatterLevel
|
static |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="The level at which to correct for brighter-fatter.",
allowed={
"AMP": "Every amplifier treated separately.",
"DETECTOR": "One kernel per detector.",
},
default="DETECTOR",
)
Definition at line 366 of file isrTaskLSST.py.
◆ brighterFatterMaskGrowSize
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of pixels to grow the masks listed in config.brighterFatterMaskListToInterpolate "
"when brighter-fatter correction is applied.",
default=0,
)
Definition at line 398 of file isrTaskLSST.py.
◆ brighterFatterMaskListToInterpolate
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
doc="List of mask planes that should be interpolated over when applying the brighter-fatter "
"correction.",
default=["SAT", "BAD", "NO_DATA", "UNMASKEDNAN"],
)
Definition at line 392 of file isrTaskLSST.py.
◆ brighterFatterMaxIter
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum number of iterations for the brighter-fatter correction.",
default=10,
)
Definition at line 375 of file isrTaskLSST.py.
◆ brighterFatterThreshold
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Threshold used to stop iterating the brighter-fatter correction. It is the "
"absolute value of the difference between the current corrected image and the one "
"from the previous iteration summed over all the pixels.",
default=1000,
)
Definition at line 380 of file isrTaskLSST.py.
◆ crosstalk
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=CrosstalkTask,
doc="Intra-CCD crosstalk correction.",
)
Definition at line 310 of file isrTaskLSST.py.
◆ deferredChargeCorrection
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=DeferredChargeTask,
doc="Deferred charge correction task.",
)
Definition at line 229 of file isrTaskLSST.py.
◆ doApplyGains
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply gains to the image?",
default=True,
)
Definition at line 247 of file isrTaskLSST.py.
◆ doAssembleCcd
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Assemble amp-level exposures into a ccd-level exposure?"
)
Definition at line 206 of file isrTaskLSST.py.
◆ doBias
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply bias frame correction?",
default=True,
)
Definition at line 217 of file isrTaskLSST.py.
◆ doBinnedExposures
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should binned exposures be calculated?",
default=False,
)
Definition at line 469 of file isrTaskLSST.py.
◆ doBrighterFatter
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply the brighter-fatter correction?",
default=True,
)
Definition at line 361 of file isrTaskLSST.py.
◆ doCalculateStatistics
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should additional ISR statistics be calculated?",
default=True,
)
Definition at line 458 of file isrTaskLSST.py.
◆ doCrosstalk
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply intra-CCD crosstalk correction?",
default=True,
)
Definition at line 305 of file isrTaskLSST.py.
◆ doDark
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply dark frame correction.",
default=True,
)
Definition at line 423 of file isrTaskLSST.py.
◆ doDefect
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply correction for CCD defects, e.g. hot pixels?",
default=True,
)
Definition at line 316 of file isrTaskLSST.py.
◆ doDeferredCharge
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply deferred charge correction?",
default=True,
)
Definition at line 224 of file isrTaskLSST.py.
◆ doDiffNonLinearCorrection
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do differential non-linearity correction?",
default=False,
)
Definition at line 194 of file isrTaskLSST.py.
◆ doFlat
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply flat field correction.",
default=True,
)
Definition at line 430 of file isrTaskLSST.py.
◆ doGainsCorrection
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply temperature correction to the gains?",
default=False,
)
Definition at line 242 of file isrTaskLSST.py.
◆ doHeaderProvenance
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Write calibration identifiers into output exposure header.",
)
Definition at line 187 of file isrTaskLSST.py.
◆ doInterpolate
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Interpolate masked pixels?",
default=True,
)
Definition at line 337 of file isrTaskLSST.py.
◆ doLinearize
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Correct for nonlinearity of the detector's response?",
default=True,
)
Definition at line 235 of file isrTaskLSST.py.
◆ doNanMasking
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask non-finite (NAN, inf) pixels.",
default=True,
)
Definition at line 321 of file isrTaskLSST.py.
◆ doSaturation
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask saturated pixels? NB: this is totally independent of the"
" interpolation option - this is ONLY setting the bits in the mask."
" To have them interpolated make sure doSaturationInterpolation=True",
default=True,
)
Definition at line 276 of file isrTaskLSST.py.
◆ doSaveInterpPixels
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Save a copy of the pre-interpolated pixel values?",
default=False,
)
Definition at line 347 of file isrTaskLSST.py.
◆ doSetBadRegions
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should we set the level of all BAD patches of the chip to the chip's average value?",
default=True,
)
Definition at line 354 of file isrTaskLSST.py.
◆ doStandardStatistics
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should standard image quality statistics be calculated?",
default=True,
)
Definition at line 452 of file isrTaskLSST.py.
◆ doSuspect
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask suspect pixels?",
default=False,
)
Definition at line 293 of file isrTaskLSST.py.
◆ doVariance
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Calculate variance?",
default=True
)
Definition at line 254 of file isrTaskLSST.py.
◆ doWidenSaturationTrails
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Widen bleed trails based on their width.",
default=True,
)
Definition at line 326 of file isrTaskLSST.py.
◆ expectWcs
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Expect input science images to have a WCS (set False for e.g. spectrographs)."
)
Definition at line 178 of file isrTaskLSST.py.
◆ flatScalingType
|
static |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="The method for scaling the flat on the fly.",
default='USER',
allowed={
"USER": "Scale by flatUserScale",
"MEAN": "Scale by the inverse of the mean",
"MEDIAN": "Scale by the inverse of the median",
},
)
Definition at line 435 of file isrTaskLSST.py.
◆ flatUserScale
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="If flatScalingType is 'USER' then scale flat by this amount; ignored otherwise.",
default=1.0,
)
Definition at line 445 of file isrTaskLSST.py.
◆ gain
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="The gain to use if no Detector is present in the Exposure (ignored if NaN).",
default=float("NaN"),
)
Definition at line 259 of file isrTaskLSST.py.
◆ growSaturationFootprintSize
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of pixels by which to grow the saturation footprints.",
default=1,
)
Definition at line 410 of file isrTaskLSST.py.
◆ isrStats
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=IsrStatisticsTask,
doc="Task to calculate additional statistics.",
)
Definition at line 463 of file isrTaskLSST.py.
◆ masking
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=MaskingTask,
doc="Masking task."
)
Definition at line 331 of file isrTaskLSST.py.
◆ maskListToInterpolate
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
doc="List of mask planes that should be interpolated.",
default=['SAT', 'BAD'],
)
Definition at line 342 of file isrTaskLSST.py.
◆ maskNegativeVariance
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask pixels that claim a negative variance. This likely indicates a failure "
"in the measurement of the overscan at an edge due to the data falling off faster "
"than the overscan model can account for it.",
default=True,
)
Definition at line 264 of file isrTaskLSST.py.
◆ negativeVarianceMaskName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Mask plane to use to mark pixels with negative variance, if `maskNegativeVariance` is True.",
default="BAD",
)
Definition at line 271 of file isrTaskLSST.py.
◆ overscanCamera
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=OverscanCameraConfig,
doc="Per-detector and per-amplifier overscan configurations.",
)
Definition at line 200 of file isrTaskLSST.py.
◆ qa
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=isrQa.IsrQaConfig,
doc="QA related configuration options.",
)
Definition at line 183 of file isrTaskLSST.py.
◆ saturatedMaskName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of mask plane to use in saturation detection and interpolation.",
default="SAT",
)
Definition at line 288 of file isrTaskLSST.py.
◆ saturation
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="The saturation level to use if no Detector is present in the Exposure (ignored if NaN)",
default=float("NaN"),
)
Definition at line 283 of file isrTaskLSST.py.
◆ suspectMaskName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of mask plane to use for suspect pixels.",
default="SUSPECT",
)
Definition at line 298 of file isrTaskLSST.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g0aad566f14+f45185db35/python/lsst/ip/isr/isrTaskLSST.py
