lsst.ip.isr  16.0-14-g6c7ed55+11
Static Public Attributes | List of all members
lsst.ip.isr.isrTask.IsrTaskConfig Class Reference
Inheritance diagram for lsst.ip.isr.isrTask.IsrTaskConfig:

Static Public Attributes

 doBias
 
 doDark
 
 doFlat
 
 doFringe
 
 doDefect
 
 doAddDistortionModel
 
 doWrite
 
 biasDataProductName
 
 darkDataProductName
 
 flatDataProductName
 
 assembleCcd
 
 gain
 
 readNoise
 
 saturation
 
 fringeAfterFlat
 
 fringe
 
 fwhm
 
 saturatedMaskName
 
 suspectMaskName
 
 flatScalingType
 
 flatUserScale
 
 overscanFitType
 
 overscanOrder
 
 overscanNumSigmaClip
 
 overscanNumLeadingColumnsToSkip
 
 overscanNumTrailingColumnsToSkip
 
 growSaturationFootprintSize
 
 doSaturationInterpolation
 
 doNanInterpAfterFlat
 
 fluxMag0T1
 
 keysToRemoveFromAssembledCcd
 
 doAssembleIsrExposures
 
 doAssembleCcd
 
 expectWcs
 
 doLinearize
 
 doCrosstalk
 
 crosstalk
 
 doBrighterFatter
 
 brighterFatterLevel
 
 brighterFatterKernelFile
 
 brighterFatterMaxIter
 
 brighterFatterThreshold
 
 brighterFatterApplyGain
 
 datasetType
 
 fallbackFilterName
 
 doAttachTransmissionCurve
 
 doUseOpticsTransmission
 
 doUseFilterTransmission
 
 doUseSensorTransmission
 
 doUseAtmosphereTransmission
 
 doEmpiricalReadNoise
 

Detailed Description

Definition at line 45 of file isrTask.py.

Member Data Documentation

◆ assembleCcd

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

Definition at line 96 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 81 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 277 of file isrTask.py.

◆ brighterFatterKernelFile

lsst.ip.isr.isrTask.IsrTaskConfig.brighterFatterKernelFile
static
Initial value:
= pexConfig.Field(
dtype=str,
default='',
doc="Kernel file used for the brighter fatter correction"
)

Definition at line 260 of file isrTask.py.

◆ brighterFatterLevel

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

Definition at line 252 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 265 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 270 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 243 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 86 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 282 of file isrTask.py.

◆ doAddDistortionModel

lsst.ip.isr.isrTask.IsrTaskConfig.doAddDistortionModel
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply a distortion model based on camera geometry to the WCS?",
default=True,
)

Definition at line 71 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 223 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 218 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 290 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 46 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 247 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 238 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 51 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 66 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 315 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 56 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 61 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 233 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 202 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?",
default=True,
)

Definition at line 197 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 310 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 300 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 295 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 305 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 76 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 228 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 288 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 91 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 139 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 149 of file isrTask.py.

◆ fluxMag0T1

lsst.ip.isr.isrTask.IsrTaskConfig.fluxMag0T1
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="The approximate flux of a zero-magnitude object in a one-second exposure",
default=1e10,
)

Definition at line 208 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 120 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 115 of file isrTask.py.

◆ fwhm

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

Definition at line 124 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 100 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 192 of file isrTask.py.

◆ keysToRemoveFromAssembledCcd

lsst.ip.isr.isrTask.IsrTaskConfig.keysToRemoveFromAssembledCcd
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="fields to remove from the metadata of the assembled ccd.",
default=[],
)

Definition at line 213 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",
},
)

Definition at line 154 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 182 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,
)

Definition at line 176 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 187 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,
)

Definition at line 170 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 105 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 129 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 110 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 134 of file isrTask.py.


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