lsst.ip.isr  13.0-15-g0af5a6c+32
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
 
 doWrite
 
 assembleCcd
 
 gain
 
 readNoise
 
 saturation
 
 fringeAfterFlat
 
 fringe
 
 fwhm
 
 saturatedMaskName
 
 suspectMaskName
 
 flatScalingType
 
 flatUserScale
 
 overscanFitType
 
 overscanOrder
 
 overscanRej
 
 growSaturationFootprintSize
 
 doSaturationInterpolation
 
 fluxMag0T1
 
 keysToRemoveFromAssembledCcd
 
 doAssembleIsrExposures
 
 doAssembleCcd
 
 expectWcs
 
 doLinearize
 
 doCrosstalk
 
 crosstalk
 
 doBrighterFatter
 
 brighterFatterKernelFile
 
 brighterFatterMaxIter
 
 brighterFatterThreshold
 
 brighterFatterApplyGain
 
 datasetType
 
 fallbackFilterName
 

Detailed Description

Definition at line 47 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 78 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 233 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 216 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 221 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 226 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 207 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 238 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 187 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 182 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 48 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 211 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 202 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 53 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 68 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 58 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 63 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 197 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 167 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 73 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 192 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 244 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 121 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 131 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 172 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 102 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 97 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 106 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 82 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 162 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 177 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",
"MEDIAN": "Correct using the median of the overscan region",
},
)

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

◆ overscanRej

lsst.ip.isr.isrTask.IsrTaskConfig.overscanRej
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Rejection threshold (sigma) for collapsing overscan before fit",
default=3.0,
)

Definition at line 157 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 87 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 111 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 92 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 116 of file isrTask.py.


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