LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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

def validate (self)
 

Static Public Attributes

 datasetType
 
 fallbackFilterName
 
 useFallbackDate
 
 expectWcs
 
 fwhm
 
 qa
 
 doConvertIntToFloat
 
 doSaturation
 
 saturatedMaskName
 
 saturation
 
 growSaturationFootprintSize
 
 doSuspect
 
 suspectMaskName
 
 numEdgeSuspect
 
 edgeMaskLevel
 
 doSetBadRegions
 
 badStatistic
 
 doOverscan
 
 overscan
 
 overscanFitType
 
 overscanOrder
 
 overscanNumSigmaClip
 
 overscanIsInt
 
 overscanNumLeadingColumnsToSkip
 
 overscanNumTrailingColumnsToSkip
 
 overscanMaxDev
 
 overscanBiasJump
 
 overscanBiasJumpKeyword
 
 overscanBiasJumpDevices
 
 overscanBiasJumpLocation
 
 doAssembleCcd
 
 assembleCcd
 
 doAssembleIsrExposures
 
 doTrimToMatchCalib
 
 doBias
 
 biasDataProductName
 
 doBiasBeforeOverscan
 
 doVariance
 
 gain
 
 readNoise
 
 doEmpiricalReadNoise
 
 usePtcReadNoise
 
 maskNegativeVariance
 
 negativeVarianceMaskName
 
 doLinearize
 
 doCrosstalk
 
 doCrosstalkBeforeAssemble
 
 crosstalk
 
 doDefect
 
 doNanMasking
 
 doWidenSaturationTrails
 
 doBrighterFatter
 
 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
 
 vignette
 
 doAttachTransmissionCurve
 
 doUseOpticsTransmission
 
 doUseFilterTransmission
 
 doUseSensorTransmission
 
 doUseAtmosphereTransmission
 
 doIlluminationCorrection
 
 illuminationCorrectionDataProductName
 
 illumScale
 
 illumFilters
 
 doWrite
 
 ccdExposure
 
 camera
 
 crosstalkSources
 
 bias
 
 dark
 
 flat
 
 ptc
 
 fringes
 
 strayLightData
 
 bfKernel
 
 newBFKernel
 
 defects
 
 linearizer
 
 opticsTransmission
 
 filterTransmission
 
 sensorTransmission
 
 atmosphereTransmission
 
 illumMaskedImage
 
 outputExposure
 
 preInterpExposure
 
 outputOssThumbnail
 
 outputFlattenedThumbnail
 

Detailed Description

Configuration parameters for IsrTask.

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

Definition at line 326 of file isrTask.py.

Member Function Documentation

◆ validate()

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

Definition at line 927 of file isrTask.py.

927  def validate(self):
928  super().validate()
929  if self.doFlat and self.doApplyGains:
930  raise ValueError("You may not specify both doFlat and doApplyGains")
931  if self.doBiasBeforeOverscan and self.doTrimToMatchCalib:
932  raise ValueError("You may not specify both doBiasBeforeOverscan and doTrimToMatchCalib")
933  if self.doSaturationInterpolation and self.saturatedMaskName not in self.maskListToInterpolate:
934  self.maskListToInterpolate.append(self.saturatedMaskName)
935  if not self.doSaturationInterpolation and self.saturatedMaskName in self.maskListToInterpolate:
936  self.maskListToInterpolate.remove(self.saturatedMaskName)
937  if self.doNanInterpolation and "UNMASKEDNAN" not in self.maskListToInterpolate:
938  self.maskListToInterpolate.append("UNMASKEDNAN")
939 
940 
std::shared_ptr< FrameSet > append(FrameSet const &first, FrameSet const &second)
Construct a FrameSet that performs two transformations in series.
Definition: functional.cc:33

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 785 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 533 of file isrTask.py.

◆ atmosphereTransmission

lsst.ip.isr.isrTask.IsrTaskConnections.atmosphereTransmission
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="transmission_atmosphere",
storageClass="TransmissionCurve",
doc="Transmission curve due to the atmosphere.",
dimensions=["instrument"],
isCalibration=True,
)

Definition at line 232 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 427 of file isrTask.py.

◆ bfKernel

lsst.ip.isr.isrTask.IsrTaskConnections.bfKernel
staticinherited
Initial value:
= cT.PrerequisiteInput(
name='bfKernel',
doc="Input brighter-fatter kernel.",
storageClass="NumpyArray",
dimensions=["instrument"],
isCalibration=True,
minimum=0, # can use either bfKernel or newBFKernel
)

Definition at line 180 of file isrTask.py.

◆ bias

lsst.ip.isr.isrTask.IsrTaskConnections.bias
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="bias",
doc="Input bias calibration.",
storageClass="ExposureF",
dimensions=["instrument", "detector"],
isCalibration=True,
)

Definition at line 135 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 556 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 672 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 651 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 683 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 677 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 660 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 665 of file isrTask.py.

◆ camera

lsst.ip.isr.isrTask.IsrTaskConnections.camera
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="camera",
storageClass="Camera",
doc="Input camera to construct complete exposures.",
dimensions=["instrument"],
isCalibration=True,
)

Definition at line 109 of file isrTask.py.

◆ ccdExposure

lsst.ip.isr.isrTask.IsrTaskConnections.ccdExposure
staticinherited
Initial value:
= cT.Input(
name="raw",
doc="Input exposure to process.",
storageClass="Exposure",
dimensions=["instrument", "exposure", "detector"],
)

Definition at line 103 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 623 of file isrTask.py.

◆ crosstalkSources

lsst.ip.isr.isrTask.IsrTaskConnections.crosstalkSources
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="isrOverscanCorrected",
doc="Overscan corrected input images.",
storageClass="Exposure",
dimensions=["instrument", "exposure", "detector"],
deferLoad=True,
multiple=True,
lookupFunction=crosstalkSourceLookup,
minimum=0, # not needed for all instruments, no config to control this
)

Definition at line 125 of file isrTask.py.

◆ dark

lsst.ip.isr.isrTask.IsrTaskConnections.dark
staticinherited
Initial value:
= cT.PrerequisiteInput(
name='dark',
doc="Input dark calibration.",
storageClass="ExposureF",
dimensions=["instrument", "detector"],
isCalibration=True,
)

Definition at line 142 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 696 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 332 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 853 of file isrTask.py.

◆ defects

lsst.ip.isr.isrTask.IsrTaskConnections.defects
staticinherited
Initial value:
= cT.PrerequisiteInput(
name='defects',
doc="Input defect tables.",
storageClass="Defects",
dimensions=["instrument", "detector"],
isCalibration=True,
)

Definition at line 196 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 780 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 747 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 528 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 539 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 871 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 551 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 561 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 646 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 798 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 365 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 613 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 618 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 691 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 629 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 583 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 714 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 764 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 898 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 809 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 606 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 791 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 828 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 821 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 634 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 438 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 372 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 814 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 839 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 422 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 703 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 396 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 544 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 739 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 891 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 881 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 876 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 886 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 568 of file isrTask.py.

◆ doVignette

lsst.ip.isr.isrTask.IsrTaskConfig.doVignette
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply vignetting parameters?",
default=False,
)

Definition at line 860 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 639 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 921 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 411 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 349 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 339 of file isrTask.py.

◆ filterTransmission

lsst.ip.isr.isrTask.IsrTaskConnections.filterTransmission
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="transmission_filter",
storageClass="TransmissionCurve",
doc="Transmission curve due to the filter.",
dimensions=["instrument", "physical_filter"],
isCalibration=True,
)

Definition at line 218 of file isrTask.py.

◆ flat

lsst.ip.isr.isrTask.IsrTaskConnections.flat
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="flat",
doc="Input flat calibration.",
storageClass="ExposureF",
dimensions=["instrument", "physical_filter", "detector"],
isCalibration=True,
)

Definition at line 149 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 719 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 724 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 734 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 846 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 769 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 773 of file isrTask.py.

◆ fringes

lsst.ip.isr.isrTask.IsrTaskConnections.fringes
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="fringe",
doc="Input fringe calibration.",
storageClass="ExposureF",
dimensions=["instrument", "physical_filter", "detector"],
isCalibration=True,
minimum=0, # only needed for some bands, even when enabled
)

Definition at line 163 of file isrTask.py.

◆ fwhm

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

Definition at line 354 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 573 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 389 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 913 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 903 of file isrTask.py.

◆ illumMaskedImage

lsst.ip.isr.isrTask.IsrTaskConnections.illumMaskedImage
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="illum",
doc="Input illumination correction.",
storageClass="MaskedImageF",
dimensions=["instrument", "physical_filter", "detector"],
isCalibration=True,
)

Definition at line 239 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 908 of file isrTask.py.

◆ linearizer

lsst.ip.isr.isrTask.IsrTaskConnections.linearizer
staticinherited
Initial value:
= cT.PrerequisiteInput(
name='linearizer',
storageClass="Linearizer",
doc="Linearity correction calibration.",
dimensions=["instrument", "detector"],
isCalibration=True,
minimum=0, # can fall back to cameraGeom
)

Definition at line 203 of file isrTask.py.

◆ masking

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

Definition at line 803 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 834 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 593 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 600 of file isrTask.py.

◆ newBFKernel

lsst.ip.isr.isrTask.IsrTaskConnections.newBFKernel
staticinherited
Initial value:
= cT.PrerequisiteInput(
name='brighterFatterKernel',
doc="Newer complete kernel + gain solutions.",
storageClass="BrighterFatterKernel",
dimensions=["instrument", "detector"],
isCalibration=True,
minimum=0, # can use either bfKernel or newBFKernel
)

Definition at line 188 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 757 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 406 of file isrTask.py.

◆ opticsTransmission

lsst.ip.isr.isrTask.IsrTaskConnections.opticsTransmission
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="transmission_optics",
storageClass="TransmissionCurve",
doc="Transmission curve due to the optics.",
dimensions=["instrument"],
isCalibration=True,
)

Definition at line 211 of file isrTask.py.

◆ outputExposure

lsst.ip.isr.isrTask.IsrTaskConnections.outputExposure
staticinherited
Initial value:
= cT.Output(
name='postISRCCD',
doc="Output ISR processed exposure.",
storageClass="Exposure",
dimensions=["instrument", "exposure", "detector"],
)

Definition at line 247 of file isrTask.py.

◆ outputFlattenedThumbnail

lsst.ip.isr.isrTask.IsrTaskConnections.outputFlattenedThumbnail
staticinherited
Initial value:
= cT.Output(
name="FlattenedThumb",
doc="Output flat-corrected thumbnail image.",
storageClass="Thumbnail",
dimensions=["instrument", "exposure", "detector"],
)

Definition at line 265 of file isrTask.py.

◆ outputOssThumbnail

lsst.ip.isr.isrTask.IsrTaskConnections.outputOssThumbnail
staticinherited
Initial value:
= cT.Output(
name="OssThumb",
doc="Output Overscan-subtracted thumbnail image.",
storageClass="Thumbnail",
dimensions=["instrument", "exposure", "detector"],
)

Definition at line 259 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 443 of file isrTask.py.

◆ overscanBiasJump

lsst.ip.isr.isrTask.IsrTaskConfig.overscanBiasJump
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Fit the overscan in a piecewise-fashion to correct for bias jumps?",
default=False,
)

Definition at line 506 of file isrTask.py.

◆ overscanBiasJumpDevices

lsst.ip.isr.isrTask.IsrTaskConfig.overscanBiasJumpDevices
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="List of devices that need piecewise overscan correction.",
default=(),
)

Definition at line 516 of file isrTask.py.

◆ overscanBiasJumpKeyword

lsst.ip.isr.isrTask.IsrTaskConfig.overscanBiasJumpKeyword
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Header keyword containing information about devices.",
default="NO_SUCH_KEY",
)

Definition at line 511 of file isrTask.py.

◆ overscanBiasJumpLocation

lsst.ip.isr.isrTask.IsrTaskConfig.overscanBiasJumpLocation
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Location of bias jump along y-axis.",
default=0,
)

Definition at line 521 of file isrTask.py.

◆ overscanFitType

lsst.ip.isr.isrTask.IsrTaskConfig.overscanFitType
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="The method for fitting the overscan bias level.",
default='MEDIAN',
allowed={
"POLY": "Fit ordinary polynomial to the longest axis of the overscan region",
"CHEB": "Fit Chebyshev polynomial to the longest axis of the overscan region",
"LEG": "Fit Legendre polynomial to the longest axis of the overscan region",
"NATURAL_SPLINE": "Fit natural spline to the longest axis of the overscan region",
"CUBIC_SPLINE": "Fit cubic spline to the longest axis of the overscan region",
"AKIMA_SPLINE": "Fit Akima spline to the longest axis of the overscan region",
"MEAN": "Correct using the mean of the overscan region",
"MEANCLIP": "Correct using a clipped mean of the overscan region",
"MEDIAN": "Correct using the median of the overscan region",
"MEDIAN_PER_ROW": "Correct using the median per row of the overscan region",
},
deprecated=("Please configure overscan via the OverscanCorrectionConfig interface."
" This option will no longer be used, and will be removed after v20.")
)

Definition at line 447 of file isrTask.py.

◆ overscanIsInt

lsst.ip.isr.isrTask.IsrTaskConfig.overscanIsInt
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Treat overscan as an integer image for purposes of overscan.FitType=MEDIAN"
" and overscan.FitType=MEDIAN_PER_ROW.",
default=True,
deprecated=("Please configure overscan via the OverscanCorrectionConfig interface."
" This option will no longer be used, and will be removed after v20.")
)

Definition at line 481 of file isrTask.py.

◆ overscanMaxDev

lsst.ip.isr.isrTask.IsrTaskConfig.overscanMaxDev
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum deviation from the median for overscan",
default=1000.0, check=lambda x: x > 0
)

Definition at line 501 of file isrTask.py.

◆ overscanNumLeadingColumnsToSkip

lsst.ip.isr.isrTask.IsrTaskConfig.overscanNumLeadingColumnsToSkip
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of columns to skip in overscan, i.e. those closest to amplifier",
default=0,
)

Definition at line 491 of file isrTask.py.

◆ overscanNumSigmaClip

lsst.ip.isr.isrTask.IsrTaskConfig.overscanNumSigmaClip
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Rejection threshold (sigma) for collapsing overscan before fit",
default=3.0,
deprecated=("Please configure overscan via the OverscanCorrectionConfig interface."
" This option will no longer be used, and will be removed after v20.")
)

Definition at line 474 of file isrTask.py.

◆ overscanNumTrailingColumnsToSkip

lsst.ip.isr.isrTask.IsrTaskConfig.overscanNumTrailingColumnsToSkip
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of columns to skip in overscan, i.e. those farthest from amplifier",
default=0,
)

Definition at line 496 of file isrTask.py.

◆ overscanOrder

lsst.ip.isr.isrTask.IsrTaskConfig.overscanOrder
static
Initial value:
= pexConfig.Field(
dtype=int,
doc=("Order of polynomial or to fit if overscan fit type is a polynomial, "
"or number of spline knots if overscan fit type is a spline."),
default=1,
deprecated=("Please configure overscan via the OverscanCorrectionConfig interface."
" This option will no longer be used, and will be removed after v20.")
)

Definition at line 466 of file isrTask.py.

◆ preInterpExposure

lsst.ip.isr.isrTask.IsrTaskConnections.preInterpExposure
staticinherited
Initial value:
= cT.Output(
name='preInterpISRCCD',
doc="Output ISR processed exposure, with pixels left uninterpolated.",
storageClass="ExposureF",
dimensions=["instrument", "exposure", "detector"],
)

Definition at line 253 of file isrTask.py.

◆ ptc

lsst.ip.isr.isrTask.IsrTaskConnections.ptc
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="ptc",
doc="Input Photon Transfer Curve dataset",
storageClass="PhotonTransferCurveDataset",
dimensions=["instrument", "detector"],
isCalibration=True,
)

Definition at line 156 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 359 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 578 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 379 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 384 of file isrTask.py.

◆ sensorTransmission

lsst.ip.isr.isrTask.IsrTaskConnections.sensorTransmission
staticinherited
Initial value:
= cT.PrerequisiteInput(
name="transmission_sensor",
storageClass="TransmissionCurve",
doc="Transmission curve due to the sensor.",
dimensions=["instrument", "detector"],
isCalibration=True,
)

Definition at line 225 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 708 of file isrTask.py.

◆ strayLightData

lsst.ip.isr.isrTask.IsrTaskConnections.strayLightData
staticinherited
Initial value:
= cT.PrerequisiteInput(
name='yBackground',
doc="Input stray light calibration.",
storageClass="StrayLightData",
dimensions=["instrument", "physical_filter", "detector"],
deferLoad=True,
isCalibration=True,
minimum=0, # only needed for some bands, even when enabled
)

Definition at line 171 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 401 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 344 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 Photon Transfer Curve?",
default=False,
)

Definition at line 752 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 588 of file isrTask.py.

◆ vignette

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

Definition at line 865 of file isrTask.py.


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