CfhtIsrTaskConfig¶
-
class
lsst.obs.cfht.cfhtIsrTask.
CfhtIsrTaskConfig
¶ Bases:
lsst.ip.isr.isrTask.IsrTaskConfig
Attributes Summary
assembleCcd
CCD assembly task ( ConfigurableInstance
, default<class 'lsst.ip.isr.assembleCcdTask.AssembleCcdConfig'>
)biasDataProductName
Name of the bias data product ( str
, default'bias'
)brighterFatterApplyGain
Should the gain be applied when applying the brighter fatter correction? ( bool
, defaultTrue
)brighterFatterKernelFile
Kernel file used for the brighter fatter correction ( str
, default''
)brighterFatterMaxIter
Maximum number of iterations for the brighter fatter correction ( int
, default10
)brighterFatterThreshold
Threshold used to stop iterating the brighter fatter correction. crosstalk
Intra-CCD crosstalk correction ( ConfigurableInstance
, default<class 'lsst.ip.isr.crosstalk.CrosstalkConfig'>
)darkDataProductName
Name of the dark data product ( str
, default'dark'
)datasetType
Dataset type for input data; users will typically leave this alone, but camera-specific ISR tasks will override it ( str
, default'raw'
)doAddDistortionModel
Apply a distortion model based on camera geometry to the WCS? ( bool
, defaultTrue
)doAssembleCcd
Assemble amp-level exposures into a ccd-level exposure? ( bool
, defaultTrue
)doAssembleIsrExposures
Assemble amp-level calibration exposures into ccd-level exposure? ( bool
, defaultFalse
)doAttachTransmissionCurve
Construct and attach a wavelength-dependent throughput curve for this CCD image? ( bool
, defaultFalse
)doBias
Apply bias frame correction? ( bool
, defaultTrue
)doBrighterFatter
Apply the brighter fatter correction ( bool
, defaultFalse
)doCrosstalk
Apply intra-CCD crosstalk correction? ( bool
, defaultFalse
)doDark
Apply dark frame correction? ( bool
, defaultTrue
)doDefect
Apply correction for CCD defects, e.g. doEmpiricalReadNoise
Calculate empirical read noise instead of value from AmpInfo data? ( bool
, defaultFalse
)doFlat
Apply flat field correction? ( bool
, defaultTrue
)doFringe
Apply fringe correction? ( bool
, defaultTrue
)doLinearize
Correct for nonlinearity of the detector’s response? ( bool
, defaultTrue
)doNanInterpAfterFlat
If True, ensure we interpolate NaNs after flat-fielding, even if we also have to interpolate them before flat-fielding. doSaturationInterpolation
Perform interpolation over pixels masked as saturated? ( bool
, defaultTrue
)doUseAtmosphereTransmission
Load and use transmission_atmosphere (if doAttachTransmissionCurve is True)? ( bool
, defaultTrue
)doUseFilterTransmission
Load and use transmission_filter (if doAttachTransmissionCurve is True)? ( bool
, defaultTrue
)doUseOpticsTransmission
Load and use transmission_optics (if doAttachTransmissionCurve is True)? ( bool
, defaultTrue
)doUseSensorTransmission
Load and use transmission_sensor (if doAttachTransmissionCurve is True)? ( bool
, defaultTrue
)doWrite
Persist postISRCCD? ( bool
, defaultTrue
)expectWcs
Expect input science images to have a WCS (set False for e.g. fallbackFilterName
Fallback default filter name for calibrations ( str
, defaultNone
)flatDataProductName
Name of the flat data product ( str
, default'flat'
)flatScalingType
The method for scaling the flat on the fly. flatUserScale
If flatScalingType is ‘USER’ then scale flat by this amount; ignored otherwise ( float
, default1.0
)fluxMag0T1
The approximate flux of a zero-magnitude object in a one-second exposure ( float
, default10000000000.0
)fringe
Fringe subtraction task ( ConfigurableInstance
, default<class 'lsst.ip.isr.fringe.FringeConfig'>
)fringeAfterFlat
Do fringe subtraction after flat-fielding? ( bool
, defaultTrue
)fwhm
FWHM of PSF (arcsec) ( float
, default1.0
)gain
The gain to use if no Detector is present in the Exposure (ignored if NaN) ( float
, defaultnan
)growSaturationFootprintSize
Number of pixels by which to grow the saturation footprints ( int
, default1
)keysToRemoveFromAssembledCcd
fields to remove from the metadata of the assembled ccd. overscanFitType
The method for fitting the overscan bias level. overscanNumLeadingColumnsToSkip
Number of columns to skip in overscan, i.e. overscanNumTrailingColumnsToSkip
Number of columns to skip in overscan, i.e. overscanOrder
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. overscanRej
Rejection threshold (sigma) for collapsing overscan before fit ( float
, default3.0
)readNoise
The read noise to use if no Detector is present in the Exposure ( float
, default0.0
)safe
Safety margin for CFHT sensors gain determination ( float
, default0.95
)saturatedMaskName
Name of mask plane to use in saturation detection and interpolation ( str
, default'SAT'
)saturation
The saturation level to use if no Detector is present in the Exposure (ignored if NaN) ( float
, defaultnan
)suspectMaskName
Name of mask plane to use for suspect pixels ( str
, default'SUSPECT'
)Methods Summary
setDefaults
()Derived config classes that must compute defaults rather than using the Field defaults should do so here. Attributes Documentation
-
assembleCcd
¶ CCD assembly task (
ConfigurableInstance
, default<class 'lsst.ip.isr.assembleCcdTask.AssembleCcdConfig'>
)
-
brighterFatterApplyGain
¶ Should the gain be applied when applying the brighter fatter correction? (
bool
, defaultTrue
)
-
brighterFatterMaxIter
¶ Maximum number of iterations for the brighter fatter correction (
int
, default10
)
-
brighterFatterThreshold
¶ 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. (
float
, default1000
)
-
crosstalk
¶ Intra-CCD crosstalk correction (
ConfigurableInstance
, default<class 'lsst.ip.isr.crosstalk.CrosstalkConfig'>
)
-
datasetType
¶ Dataset type for input data; users will typically leave this alone, but camera-specific ISR tasks will override it (
str
, default'raw'
)
-
doAddDistortionModel
¶ Apply a distortion model based on camera geometry to the WCS? (
bool
, defaultTrue
)
-
doAssembleIsrExposures
¶ Assemble amp-level calibration exposures into ccd-level exposure? (
bool
, defaultFalse
)
-
doAttachTransmissionCurve
¶ Construct and attach a wavelength-dependent throughput curve for this CCD image? (
bool
, defaultFalse
)
-
doEmpiricalReadNoise
¶ Calculate empirical read noise instead of value from AmpInfo data? (
bool
, defaultFalse
)
-
doNanInterpAfterFlat
¶ If True, ensure we interpolate NaNs after flat-fielding, even if we also have to interpolate them before flat-fielding. (
bool
, defaultFalse
)
-
doSaturationInterpolation
¶ Perform interpolation over pixels masked as saturated? (
bool
, defaultTrue
)
-
doUseAtmosphereTransmission
¶ Load and use transmission_atmosphere (if doAttachTransmissionCurve is True)? (
bool
, defaultTrue
)
-
doUseFilterTransmission
¶ Load and use transmission_filter (if doAttachTransmissionCurve is True)? (
bool
, defaultTrue
)
-
doUseOpticsTransmission
¶ Load and use transmission_optics (if doAttachTransmissionCurve is True)? (
bool
, defaultTrue
)
-
doUseSensorTransmission
¶ Load and use transmission_sensor (if doAttachTransmissionCurve is True)? (
bool
, defaultTrue
)
-
expectWcs
¶ Expect input science images to have a WCS (set False for e.g. spectrographs) (
bool
, defaultTrue
)
-
flatScalingType
¶ The method for scaling the flat on the fly. (
str
, default'USER'
)Allowed values:
'USER'
- Scale by flatUserScale
'MEAN'
- Scale by the inverse of the mean
'MEDIAN'
- Scale by the inverse of the median
'None'
- Field is optional
-
flatUserScale
¶ If flatScalingType is ‘USER’ then scale flat by this amount; ignored otherwise (
float
, default1.0
)
-
fluxMag0T1
¶ The approximate flux of a zero-magnitude object in a one-second exposure (
float
, default10000000000.0
)
-
fringe
¶ Fringe subtraction task (
ConfigurableInstance
, default<class 'lsst.ip.isr.fringe.FringeConfig'>
)
-
gain
¶ The gain to use if no Detector is present in the Exposure (ignored if NaN) (
float
, defaultnan
)
-
growSaturationFootprintSize
¶ Number of pixels by which to grow the saturation footprints (
int
, default1
)
-
keysToRemoveFromAssembledCcd
¶ fields to remove from the metadata of the assembled ccd. (
List
, default[]
)
-
overscanFitType
¶ The method for fitting the overscan bias level. (
str
, default'MEDIAN'
)Allowed values:
'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
'None'
- Field is optional
-
overscanNumLeadingColumnsToSkip
¶ Number of columns to skip in overscan, i.e. those closest to amplifier (
int
, default0
)
-
overscanNumTrailingColumnsToSkip
¶ Number of columns to skip in overscan, i.e. those farthest from amplifier (
int
, default0
)
-
overscanOrder
¶ 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. (
int
, default1
)
-
saturatedMaskName
¶ Name of mask plane to use in saturation detection and interpolation (
str
, default'SAT'
)
-
saturation
¶ The saturation level to use if no Detector is present in the Exposure (ignored if NaN) (
float
, defaultnan
)
Methods Documentation
-
setDefaults
()¶ Derived config classes that must compute defaults rather than using the Field defaults should do so here. To correctly use inherited defaults, implementations of setDefaults() must call their base class’ setDefaults()
-