LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+ffe7eabc7e,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g36da64cc00+ea84795170,g3ddfee87b4+955a963fd8,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+955a963fd8,g591dd9f2cf+bac198a2cb,g5ec818987f+420292cfeb,g858d7b2824+d6c9a0a3b8,g876c692160+aabc49a3c3,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+e6cd765486,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+acd47f83f4,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+12c8382528,gba4ed39666+1ac82b564f,gbb8dafda3b+0574160a1f,gbeb006f7da+dea2fbb49f,gc28159a63d+c6dfa2ddaf,gc86a011abf+d6c9a0a3b8,gcf0d15dbbd+955a963fd8,gdaeeff99f8+1cafcb7cd4,gdc0c513512+d6c9a0a3b8,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,gee10cc3b42+90ebb246c7,gf1cff7945b+d6c9a0a3b8,w.2024.13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.isr.isrTask.IsrTaskConfig Class Reference
Inheritance diagram for lsst.ip.isr.isrTask.IsrTaskConfig:
lsst.ip.isr.isrTask.IsrTaskConnections

Public Member Functions

 validate (self)
 

Static Public Attributes

 datasetType
 
 fallbackFilterName
 
 useFallbackDate
 
 expectWcs
 
 fwhm
 
 qa
 
 doHeaderProvenance
 
 doRaiseOnCalibMismatch
 
 cameraKeywordsToCompare
 
 doConvertIntToFloat
 
 doSaturation
 
 saturatedMaskName
 
 saturation
 
 growSaturationFootprintSize
 
 doSuspect
 
 suspectMaskName
 
 numEdgeSuspect
 
 edgeMaskLevel
 
 doSetBadRegions
 
 badStatistic
 
 doOverscan
 
 overscan
 
 doAssembleCcd
 
 assembleCcd
 
 doAssembleIsrExposures
 
 doTrimToMatchCalib
 
 doBias
 
 biasDataProductName
 
 doBiasBeforeOverscan
 
 doDeferredCharge
 
 deferredChargeCorrection
 
 doVariance
 
 gain
 
 readNoise
 
 doEmpiricalReadNoise
 
 usePtcReadNoise
 
 maskNegativeVariance
 
 negativeVarianceMaskName
 
 doLinearize
 
 doCrosstalk
 
 doCrosstalkBeforeAssemble
 
 crosstalk
 
 doDefect
 
 doNanMasking
 
 doWidenSaturationTrails
 
 doBrighterFatter
 
 doFluxConservingBrighterFatterCorrection
 
 brighterFatterLevel
 
 brighterFatterMaxIter
 
 brighterFatterThreshold
 
 brighterFatterApplyGain
 
 brighterFatterMaskListToInterpolate
 
 brighterFatterMaskGrowSize
 
 doDark
 
 darkDataProductName
 
 doStrayLight
 
 strayLight
 
 doFlat
 
 flatDataProductName
 
 flatScalingType
 
 flatUserScale
 
 doTweakFlat
 
 doApplyGains
 
 usePtcGains
 
 normalizeGains
 
 doFringe
 
 fringe
 
 fringeAfterFlat
 
 doAmpOffset
 
 ampOffset
 
 doMeasureBackground
 
 doCameraSpecificMasking
 
 masking
 
 doInterpolate
 
 doSaturationInterpolation
 
 doNanInterpolation
 
 doNanInterpAfterFlat
 
 maskListToInterpolate
 
 doSaveInterpPixels
 
 fluxMag0T1
 
 defaultFluxMag0T1
 
 doVignette
 
 doMaskVignettePolygon
 
 vignetteValue
 
 vignette
 
 doAttachTransmissionCurve
 
 doUseOpticsTransmission
 
 doUseFilterTransmission
 
 doUseSensorTransmission
 
 doUseAtmosphereTransmission
 
 doIlluminationCorrection
 
 illuminationCorrectionDataProductName
 
 illumScale
 
 illumFilters
 
 doStandardStatistics
 
 doCalculateStatistics
 
 isrStats
 
 doBinnedExposures
 
 binFactor1
 
 binFactor2
 
 doWrite
 

Detailed Description

Configuration parameters for IsrTask.

Items are grouped in the order in which they are executed by the task.

Definition at line 363 of file isrTask.py.

Member Function Documentation

◆ validate()

lsst.ip.isr.isrTask.IsrTaskConfig.validate ( self)

Definition at line 967 of file isrTask.py.

967 def validate(self):
968 super().validate()
969 if self.doFlat and self.doApplyGains:
970 raise ValueError("You may not specify both doFlat and doApplyGains")
971 if self.doBiasBeforeOverscan and self.doTrimToMatchCalib:
972 raise ValueError("You may not specify both doBiasBeforeOverscan and doTrimToMatchCalib")
973 if self.doSaturationInterpolation and self.saturatedMaskName not in self.maskListToInterpolate:
974 self.maskListToInterpolate.append(self.saturatedMaskName)
975 if not self.doSaturationInterpolation and self.saturatedMaskName in self.maskListToInterpolate:
976 self.maskListToInterpolate.remove(self.saturatedMaskName)
977 if self.doNanInterpolation and "UNMASKEDNAN" not in self.maskListToInterpolate:
978 self.maskListToInterpolate.append("UNMASKEDNAN")
979 if self.doCalculateStatistics and self.isrStats.doCtiStatistics:
980 if self.doApplyGains != self.isrStats.doApplyGainsForCtiStatistics:
981 raise ValueError("doApplyGains must match isrStats.applyGainForCtiStatistics.")
982
983

Member Data Documentation

◆ ampOffset

lsst.ip.isr.isrTask.IsrTaskConfig.ampOffset
static
Initial value:
= pexConfig.ConfigurableField(
doc="Amp offset correction task.",
target=AmpOffsetTask,
)

Definition at line 776 of file isrTask.py.

◆ assembleCcd

lsst.ip.isr.isrTask.IsrTaskConfig.assembleCcd
static
Initial value:
= pexConfig.ConfigurableField(
target=AssembleCcdTask,
doc="CCD assembly task",
)

Definition at line 508 of file isrTask.py.

◆ badStatistic

lsst.ip.isr.isrTask.IsrTaskConfig.badStatistic
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="How to estimate the average value for BAD regions.",
default='MEANCLIP',
allowed={
"MEANCLIP": "Correct using the (clipped) mean of good data",
"MEDIAN": "Correct using the median of the good data",
},
)

Definition at line 481 of file isrTask.py.

◆ biasDataProductName

lsst.ip.isr.isrTask.IsrTaskConfig.biasDataProductName
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the bias data product",
default="bias",
)

Definition at line 531 of file isrTask.py.

◆ binFactor1

lsst.ip.isr.isrTask.IsrTaskConfig.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 946 of file isrTask.py.

◆ binFactor2

lsst.ip.isr.isrTask.IsrTaskConfig.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 952 of file isrTask.py.

◆ brighterFatterApplyGain

lsst.ip.isr.isrTask.IsrTaskConfig.brighterFatterApplyGain
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Should the gain be applied when applying the brighter-fatter correction?"
)

Definition at line 663 of file isrTask.py.

◆ brighterFatterLevel

lsst.ip.isr.isrTask.IsrTaskConfig.brighterFatterLevel
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
default="DETECTOR",
doc="The level at which to correct for brighter-fatter.",
allowed={
"AMP": "Every amplifier treated separately.",
"DETECTOR": "One kernel per detector",
}
)

Definition at line 642 of file isrTask.py.

◆ brighterFatterMaskGrowSize

lsst.ip.isr.isrTask.IsrTaskConfig.brighterFatterMaskGrowSize
static
Initial value:
= pexConfig.Field(
dtype=int,
default=0,
doc="Number of pixels to grow the masks listed in config.brighterFatterMaskListToInterpolate "
"when brighter-fatter correction is applied."
)

Definition at line 674 of file isrTask.py.

◆ brighterFatterMaskListToInterpolate

lsst.ip.isr.isrTask.IsrTaskConfig.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 668 of file isrTask.py.

◆ brighterFatterMaxIter

lsst.ip.isr.isrTask.IsrTaskConfig.brighterFatterMaxIter
static
Initial value:
= pexConfig.Field(
dtype=int,
default=10,
doc="Maximum number of iterations for the brighter-fatter correction"
)

Definition at line 651 of file isrTask.py.

◆ brighterFatterThreshold

lsst.ip.isr.isrTask.IsrTaskConfig.brighterFatterThreshold
static
Initial value:
= pexConfig.Field(
dtype=float,
default=1000,
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."
)

Definition at line 656 of file isrTask.py.

◆ cameraKeywordsToCompare

lsst.ip.isr.isrTask.IsrTaskConfig.cameraKeywordsToCompare
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="List of header keywords to compare between exposure and calibrations.",
default=[],
)

Definition at line 412 of file isrTask.py.

◆ crosstalk

lsst.ip.isr.isrTask.IsrTaskConfig.crosstalk
static
Initial value:
= pexConfig.ConfigurableField(
target=CrosstalkTask,
doc="Intra-CCD crosstalk correction",
)

Definition at line 609 of file isrTask.py.

◆ darkDataProductName

lsst.ip.isr.isrTask.IsrTaskConfig.darkDataProductName
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the dark data product",
default="dark",
)

Definition at line 687 of file isrTask.py.

◆ datasetType

lsst.ip.isr.isrTask.IsrTaskConfig.datasetType
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Dataset type for input data; users will typically leave this alone, "
"but camera-specific ISR tasks will override it",
default="raw",
)

Definition at line 369 of file isrTask.py.

◆ defaultFluxMag0T1

lsst.ip.isr.isrTask.IsrTaskConfig.defaultFluxMag0T1
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Default value for fluxMag0T1 (for an unrecognized filter).",
default=pow(10.0, 0.4*28.0)
)

Definition at line 844 of file isrTask.py.

◆ deferredChargeCorrection

lsst.ip.isr.isrTask.IsrTaskConfig.deferredChargeCorrection
static
Initial value:
= pexConfig.ConfigurableField(
target=DeferredChargeTask,
doc="Deferred charge correction task.",
)

Definition at line 548 of file isrTask.py.

◆ doAmpOffset

lsst.ip.isr.isrTask.IsrTaskConfig.doAmpOffset
static
Initial value:
= pexConfig.Field(
doc="Calculate and apply amp offset corrections?",
dtype=bool,
default=False,
)

Definition at line 771 of file isrTask.py.

◆ doApplyGains

lsst.ip.isr.isrTask.IsrTaskConfig.doApplyGains
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Correct the amplifiers for their gains instead of applying flat correction",
default=False,
)

Definition at line 738 of file isrTask.py.

◆ doAssembleCcd

lsst.ip.isr.isrTask.IsrTaskConfig.doAssembleCcd
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Assemble amp-level exposures into a ccd-level exposure?"
)

Definition at line 503 of file isrTask.py.

◆ doAssembleIsrExposures

lsst.ip.isr.isrTask.IsrTaskConfig.doAssembleIsrExposures
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Assemble amp-level calibration exposures into ccd-level exposure?"
)

Definition at line 514 of file isrTask.py.

◆ doAttachTransmissionCurve

lsst.ip.isr.isrTask.IsrTaskConfig.doAttachTransmissionCurve
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Construct and attach a wavelength-dependent throughput curve for this CCD image?"
)

Definition at line 875 of file isrTask.py.

◆ doBias

lsst.ip.isr.isrTask.IsrTaskConfig.doBias
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply bias frame correction?",
default=True,
)

Definition at line 526 of file isrTask.py.

◆ doBiasBeforeOverscan

lsst.ip.isr.isrTask.IsrTaskConfig.doBiasBeforeOverscan
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Reverse order of overscan and bias correction.",
default=False
)

Definition at line 536 of file isrTask.py.

◆ doBinnedExposures

lsst.ip.isr.isrTask.IsrTaskConfig.doBinnedExposures
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should binned exposures be calculated?",
default=False,
)

Definition at line 941 of file isrTask.py.

◆ doBrighterFatter

lsst.ip.isr.isrTask.IsrTaskConfig.doBrighterFatter
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Apply the brighter-fatter correction?"
)

Definition at line 632 of file isrTask.py.

◆ doCalculateStatistics

lsst.ip.isr.isrTask.IsrTaskConfig.doCalculateStatistics
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should additional ISR statistics be calculated?",
default=False,
)

Definition at line 930 of file isrTask.py.

◆ doCameraSpecificMasking

lsst.ip.isr.isrTask.IsrTaskConfig.doCameraSpecificMasking
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask camera-specific bad regions?",
default=False,
)

Definition at line 789 of file isrTask.py.

◆ doConvertIntToFloat

lsst.ip.isr.isrTask.IsrTaskConfig.doConvertIntToFloat
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Convert integer raw images to floating point values?",
default=True,
)

Definition at line 419 of file isrTask.py.

◆ doCrosstalk

lsst.ip.isr.isrTask.IsrTaskConfig.doCrosstalk
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply intra-CCD crosstalk correction?",
default=False,
)

Definition at line 599 of file isrTask.py.

◆ doCrosstalkBeforeAssemble

lsst.ip.isr.isrTask.IsrTaskConfig.doCrosstalkBeforeAssemble
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply crosstalk correction before CCD assembly, and before trimming?",
default=False,
)

Definition at line 604 of file isrTask.py.

◆ doDark

lsst.ip.isr.isrTask.IsrTaskConfig.doDark
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply dark frame correction?",
default=True,
)

Definition at line 682 of file isrTask.py.

◆ doDefect

lsst.ip.isr.isrTask.IsrTaskConfig.doDefect
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply correction for CCD defects, e.g. hot pixels?",
default=True,
)

Definition at line 615 of file isrTask.py.

◆ doDeferredCharge

lsst.ip.isr.isrTask.IsrTaskConfig.doDeferredCharge
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply deferred charge correction?",
default=False,
)

Definition at line 543 of file isrTask.py.

◆ doEmpiricalReadNoise

lsst.ip.isr.isrTask.IsrTaskConfig.doEmpiricalReadNoise
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Calculate empirical read noise instead of value from AmpInfo data?"
)

Definition at line 569 of file isrTask.py.

◆ doFlat

lsst.ip.isr.isrTask.IsrTaskConfig.doFlat
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply flat field correction?",
default=True,
)

Definition at line 705 of file isrTask.py.

◆ doFluxConservingBrighterFatterCorrection

lsst.ip.isr.isrTask.IsrTaskConfig.doFluxConservingBrighterFatterCorrection
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Apply the flux-conserving BFE correction by Miller et al.?"
)

Definition at line 637 of file isrTask.py.

◆ doFringe

lsst.ip.isr.isrTask.IsrTaskConfig.doFringe
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply fringe correction?",
default=True,
)

Definition at line 755 of file isrTask.py.

◆ doHeaderProvenance

lsst.ip.isr.isrTask.IsrTaskConfig.doHeaderProvenance
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Write calibration identifiers into output exposure header?",
)

Definition at line 400 of file isrTask.py.

◆ doIlluminationCorrection

lsst.ip.isr.isrTask.IsrTaskConfig.doIlluminationCorrection
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Perform illumination correction?"
)

Definition at line 902 of file isrTask.py.

◆ doInterpolate

lsst.ip.isr.isrTask.IsrTaskConfig.doInterpolate
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Interpolate masked pixels?",
default=True,
)

Definition at line 800 of file isrTask.py.

◆ doLinearize

lsst.ip.isr.isrTask.IsrTaskConfig.doLinearize
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Correct for nonlinearity of the detector's response?",
default=True,
)

Definition at line 592 of file isrTask.py.

◆ doMaskVignettePolygon

lsst.ip.isr.isrTask.IsrTaskConfig.doMaskVignettePolygon
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Add a mask bit for pixels within the vignetted region. Ignored if doVignette "
"is False"),
default=True,
)

Definition at line 857 of file isrTask.py.

◆ doMeasureBackground

lsst.ip.isr.isrTask.IsrTaskConfig.doMeasureBackground
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Measure the background level on the reduced image?",
default=False,
)

Definition at line 782 of file isrTask.py.

◆ doNanInterpAfterFlat

lsst.ip.isr.isrTask.IsrTaskConfig.doNanInterpAfterFlat
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("If True, ensure we interpolate NaNs after flat-fielding, even if we "
"also have to interpolate them before flat-fielding."),
default=False,
)

Definition at line 819 of file isrTask.py.

◆ doNanInterpolation

lsst.ip.isr.isrTask.IsrTaskConfig.doNanInterpolation
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Perform interpolation over pixels masked as NaN?"
" NB: This is independent of doNanMasking; if that is False this plane"
" will likely be blank, resulting in a no-op here.",
default=True,
)

Definition at line 812 of file isrTask.py.

◆ doNanMasking

lsst.ip.isr.isrTask.IsrTaskConfig.doNanMasking
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask non-finite (NAN, inf) pixels?",
default=True,
)

Definition at line 620 of file isrTask.py.

◆ doOverscan

lsst.ip.isr.isrTask.IsrTaskConfig.doOverscan
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do overscan subtraction?",
default=True,
)

Definition at line 492 of file isrTask.py.

◆ doRaiseOnCalibMismatch

lsst.ip.isr.isrTask.IsrTaskConfig.doRaiseOnCalibMismatch
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Should IsrTask halt if exposure and calibration header values do not match?",
)

Definition at line 407 of file isrTask.py.

◆ doSaturation

lsst.ip.isr.isrTask.IsrTaskConfig.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 426 of file isrTask.py.

◆ doSaturationInterpolation

lsst.ip.isr.isrTask.IsrTaskConfig.doSaturationInterpolation
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Perform interpolation over pixels masked as saturated?"
" NB: This is independent of doSaturation; if that is False this plane"
" will likely be blank, resulting in a no-op here.",
default=True,
)

Definition at line 805 of file isrTask.py.

◆ doSaveInterpPixels

lsst.ip.isr.isrTask.IsrTaskConfig.doSaveInterpPixels
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Save a copy of the pre-interpolated pixel values?",
default=False,
)

Definition at line 830 of file isrTask.py.

◆ doSetBadRegions

lsst.ip.isr.isrTask.IsrTaskConfig.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 476 of file isrTask.py.

◆ doStandardStatistics

lsst.ip.isr.isrTask.IsrTaskConfig.doStandardStatistics
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should standard image quality statistics be calculated?",
default=True,
)

Definition at line 924 of file isrTask.py.

◆ doStrayLight

lsst.ip.isr.isrTask.IsrTaskConfig.doStrayLight
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Subtract stray light in the y-band (due to encoder LEDs)?",
default=False,
)

Definition at line 694 of file isrTask.py.

◆ doSuspect

lsst.ip.isr.isrTask.IsrTaskConfig.doSuspect
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask suspect pixels?",
default=False,
)

Definition at line 450 of file isrTask.py.

◆ doTrimToMatchCalib

lsst.ip.isr.isrTask.IsrTaskConfig.doTrimToMatchCalib
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Trim raw data to match calibration bounding boxes?"
)

Definition at line 519 of file isrTask.py.

◆ doTweakFlat

lsst.ip.isr.isrTask.IsrTaskConfig.doTweakFlat
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Tweak flats to match observed amplifier ratios?",
default=False
)

Definition at line 730 of file isrTask.py.

◆ doUseAtmosphereTransmission

lsst.ip.isr.isrTask.IsrTaskConfig.doUseAtmosphereTransmission
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Load and use transmission_atmosphere (if doAttachTransmissionCurve is True)?"
)

Definition at line 895 of file isrTask.py.

◆ doUseFilterTransmission

lsst.ip.isr.isrTask.IsrTaskConfig.doUseFilterTransmission
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Load and use transmission_filter (if doAttachTransmissionCurve is True)?"
)

Definition at line 885 of file isrTask.py.

◆ doUseOpticsTransmission

lsst.ip.isr.isrTask.IsrTaskConfig.doUseOpticsTransmission
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Load and use transmission_optics (if doAttachTransmissionCurve is True)?"
)

Definition at line 880 of file isrTask.py.

◆ doUseSensorTransmission

lsst.ip.isr.isrTask.IsrTaskConfig.doUseSensorTransmission
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Load and use transmission_sensor (if doAttachTransmissionCurve is True)?"
)

Definition at line 890 of file isrTask.py.

◆ doVariance

lsst.ip.isr.isrTask.IsrTaskConfig.doVariance
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Calculate variance?",
default=True
)

Definition at line 554 of file isrTask.py.

◆ doVignette

lsst.ip.isr.isrTask.IsrTaskConfig.doVignette
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Compute and attach the validPolygon defining the unvignetted region to the exposure "
"according to vignetting parameters?"),
default=False,
)

Definition at line 851 of file isrTask.py.

◆ doWidenSaturationTrails

lsst.ip.isr.isrTask.IsrTaskConfig.doWidenSaturationTrails
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Widen bleed trails based on their width?",
default=True
)

Definition at line 625 of file isrTask.py.

◆ doWrite

lsst.ip.isr.isrTask.IsrTaskConfig.doWrite
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Persist postISRCCD?",
default=True,
)

Definition at line 961 of file isrTask.py.

◆ edgeMaskLevel

lsst.ip.isr.isrTask.IsrTaskConfig.edgeMaskLevel
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Mask edge pixels in which coordinate frame: DETECTOR or AMP?",
default="DETECTOR",
allowed={
'DETECTOR': 'Mask only the edges of the full detector.',
'AMP': 'Mask edges of each amplifier.',
},
)

Definition at line 465 of file isrTask.py.

◆ expectWcs

lsst.ip.isr.isrTask.IsrTaskConfig.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 386 of file isrTask.py.

◆ fallbackFilterName

lsst.ip.isr.isrTask.IsrTaskConfig.fallbackFilterName
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Fallback default filter name for calibrations.",
optional=True
)

Definition at line 376 of file isrTask.py.

◆ flatDataProductName

lsst.ip.isr.isrTask.IsrTaskConfig.flatDataProductName
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the flat data product",
default="flat",
)

Definition at line 710 of file isrTask.py.

◆ flatScalingType

lsst.ip.isr.isrTask.IsrTaskConfig.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 715 of file isrTask.py.

◆ flatUserScale

lsst.ip.isr.isrTask.IsrTaskConfig.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 725 of file isrTask.py.

◆ fluxMag0T1

lsst.ip.isr.isrTask.IsrTaskConfig.fluxMag0T1
static
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=float,
doc="The approximate flux of a zero-magnitude object in a one-second exposure, per filter.",
default=dict((f, pow(10.0, 0.4*m)) for f, m in (("Unknown", 28.0),
))
)

Definition at line 837 of file isrTask.py.

◆ fringe

lsst.ip.isr.isrTask.IsrTaskConfig.fringe
static
Initial value:
= pexConfig.ConfigurableField(
target=FringeTask,
doc="Fringe subtraction task",
)

Definition at line 760 of file isrTask.py.

◆ fringeAfterFlat

lsst.ip.isr.isrTask.IsrTaskConfig.fringeAfterFlat
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do fringe subtraction after flat-fielding?",
default=True,
)

Definition at line 764 of file isrTask.py.

◆ fwhm

lsst.ip.isr.isrTask.IsrTaskConfig.fwhm
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="FWHM of PSF in arcseconds (currently unused).",
default=1.0,
)

Definition at line 391 of file isrTask.py.

◆ gain

lsst.ip.isr.isrTask.IsrTaskConfig.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 559 of file isrTask.py.

◆ growSaturationFootprintSize

lsst.ip.isr.isrTask.IsrTaskConfig.growSaturationFootprintSize
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of pixels by which to grow the saturation footprints",
default=1,
)

Definition at line 443 of file isrTask.py.

◆ illumFilters

lsst.ip.isr.isrTask.IsrTaskConfig.illumFilters
static
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
doc="Only perform illumination correction for these filters."
)

Definition at line 917 of file isrTask.py.

◆ illuminationCorrectionDataProductName

lsst.ip.isr.isrTask.IsrTaskConfig.illuminationCorrectionDataProductName
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the illumination correction data product.",
default="illumcor",
)

Definition at line 907 of file isrTask.py.

◆ illumScale

lsst.ip.isr.isrTask.IsrTaskConfig.illumScale
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Scale factor for the illumination correction.",
default=1.0,
)

Definition at line 912 of file isrTask.py.

◆ isrStats

lsst.ip.isr.isrTask.IsrTaskConfig.isrStats
static
Initial value:
= pexConfig.ConfigurableField(
target=IsrStatisticsTask,
doc="Task to calculate additional statistics.",
)

Definition at line 935 of file isrTask.py.

◆ masking

lsst.ip.isr.isrTask.IsrTaskConfig.masking
static
Initial value:
= pexConfig.ConfigurableField(
target=MaskingTask,
doc="Masking task."
)

Definition at line 794 of file isrTask.py.

◆ maskListToInterpolate

lsst.ip.isr.isrTask.IsrTaskConfig.maskListToInterpolate
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="List of mask planes that should be interpolated.",
default=['SAT', 'BAD'],
)

Definition at line 825 of file isrTask.py.

◆ maskNegativeVariance

lsst.ip.isr.isrTask.IsrTaskConfig.maskNegativeVariance
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
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."
)

Definition at line 579 of file isrTask.py.

◆ negativeVarianceMaskName

lsst.ip.isr.isrTask.IsrTaskConfig.negativeVarianceMaskName
static
Initial value:
= pexConfig.Field(
dtype=str,
default="BAD",
doc="Mask plane to use to mark pixels with negative variance, if `maskNegativeVariance` is True.",
)

Definition at line 586 of file isrTask.py.

◆ normalizeGains

lsst.ip.isr.isrTask.IsrTaskConfig.normalizeGains
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Normalize all the amplifiers in each CCD to have the same median value.",
default=False,
)

Definition at line 748 of file isrTask.py.

◆ numEdgeSuspect

lsst.ip.isr.isrTask.IsrTaskConfig.numEdgeSuspect
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of edge pixels to be flagged as untrustworthy.",
default=0,
)

Definition at line 460 of file isrTask.py.

◆ overscan

lsst.ip.isr.isrTask.IsrTaskConfig.overscan
static
Initial value:
= pexConfig.ConfigurableField(
target=OverscanCorrectionTask,
doc="Overscan subtraction task for image segments.",
)

Definition at line 497 of file isrTask.py.

◆ qa

lsst.ip.isr.isrTask.IsrTaskConfig.qa
static
Initial value:
= pexConfig.ConfigField(
dtype=isrQa.IsrQaConfig,
doc="QA related configuration options.",
)

Definition at line 396 of file isrTask.py.

◆ readNoise

lsst.ip.isr.isrTask.IsrTaskConfig.readNoise
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="The read noise to use if no Detector is present in the Exposure",
default=0.0,
)

Definition at line 564 of file isrTask.py.

◆ saturatedMaskName

lsst.ip.isr.isrTask.IsrTaskConfig.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 433 of file isrTask.py.

◆ saturation

lsst.ip.isr.isrTask.IsrTaskConfig.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 438 of file isrTask.py.

◆ strayLight

lsst.ip.isr.isrTask.IsrTaskConfig.strayLight
static
Initial value:
= pexConfig.ConfigurableField(
target=StrayLightTask,
doc="y-band stray light correction"
)

Definition at line 699 of file isrTask.py.

◆ suspectMaskName

lsst.ip.isr.isrTask.IsrTaskConfig.suspectMaskName
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of mask plane to use for suspect pixels",
default="SUSPECT",
)

Definition at line 455 of file isrTask.py.

◆ useFallbackDate

lsst.ip.isr.isrTask.IsrTaskConfig.useFallbackDate
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Pass observation date when using fallback filter.",
default=False,
)

Definition at line 381 of file isrTask.py.

◆ usePtcGains

lsst.ip.isr.isrTask.IsrTaskConfig.usePtcGains
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use the gain values from the input Photon Transfer Curve?",
default=False,
)

Definition at line 743 of file isrTask.py.

◆ usePtcReadNoise

lsst.ip.isr.isrTask.IsrTaskConfig.usePtcReadNoise
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Use readnoise values from the Photon Transfer Curve?"
)

Definition at line 574 of file isrTask.py.

◆ vignette

lsst.ip.isr.isrTask.IsrTaskConfig.vignette
static
Initial value:
= pexConfig.ConfigurableField(
target=VignetteTask,
doc="Vignetting task.",
)

Definition at line 869 of file isrTask.py.

◆ vignetteValue

lsst.ip.isr.isrTask.IsrTaskConfig.vignetteValue
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Value to replace image array pixels with in the vignetted region? Ignored if None.",
optional=True,
default=None,
)

Definition at line 863 of file isrTask.py.


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