Inheritance diagram for lsst.ip.isr.isrTask.IsrTaskConfig:
Public Member Functions | |
| def | validate (self) |
Detailed Description
Configuration parameters for IsrTask. Items are grouped in the order in which they are executed by the task.
Definition at line 58 of file isrTask.py.
Member Function Documentation
◆ validate()
| def lsst.ip.isr.isrTask.IsrTaskConfig.validate | ( | self | ) |
Definition at line 659 of file isrTask.py.
Member Data Documentation
◆ assembleCcd
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=AssembleCcdTask,
doc="CCD assembly task",
)
Definition at line 348 of file isrTask.py.
◆ atmosphereTransmission
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Transmission curve due to the atmosphere.",
name="transmission_atmosphere",
scalar=True,
storageClass="TablePersistableTransmissionCurve",
dimensions=["Instrument"],
)
Definition at line 143 of file isrTask.py.
◆ 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 258 of file isrTask.py.
◆ bfKernel
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Input brighter-fatter kernel.",
name="bfKernel",
scalar=True,
storageClass="NumpyArray",
dimensions=["Instrument", "ExposureRange"],
)
Definition at line 108 of file isrTask.py.
◆ bias
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Input bias calibration.",
name="bias",
scalar=True,
storageClass="ImageF",
dimensions=["Instrument", "ExposureRange", "Detector"],
)
Definition at line 87 of file isrTask.py.
◆ biasDataProductName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the bias data product",
default="bias",
)
Definition at line 371 of file isrTask.py.
◆ 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 461 of file isrTask.py.
◆ brighterFatterKernelFile
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
default='',
doc="Kernel file used for the brighter fatter correction"
)
Definition at line 444 of file isrTask.py.
◆ 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 435 of file isrTask.py.
◆ brighterFatterMaxIter
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
default=10,
doc="Maximum number of iterations for the brighter fatter correction"
)
Definition at line 449 of file isrTask.py.
◆ 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 454 of file isrTask.py.
◆ camera
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Input camera to construct complete exposures.",
name="camera",
scalar=True,
storageClass="TablePersistableCamera",
dimensions=["Instrument", "ExposureRange"],
)
Definition at line 80 of file isrTask.py.
◆ ccdExposure
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Input exposure to process",
name="raw",
scalar=True,
storageClass="ExposureU",
dimensions=["Instrument", "Exposure", "Detector"],
)
Definition at line 73 of file isrTask.py.
◆ crosstalk
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=CrosstalkTask,
doc="Intra-CCD crosstalk correction",
)
Definition at line 417 of file isrTask.py.
◆ dark
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Input dark calibration.",
name="dark",
scalar=True,
storageClass="ImageF",
dimensions=["Instrument", "ExposureRange", "Detector"],
)
Definition at line 94 of file isrTask.py.
◆ darkDataProductName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the dark data product",
default="dark",
)
Definition at line 490 of file isrTask.py.
◆ 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",
)
Original gen2 config.
Definition at line 179 of file isrTask.py.
◆ 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 608 of file isrTask.py.
◆ defects
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Input defect tables.",
name="defects",
scalar=True,
storageClass="Catalog",
dimensions=["Instrument", "ExposureRange", "Detector"],
)
Definition at line 115 of file isrTask.py.
◆ 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 576 of file isrTask.py.
◆ 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 540 of file isrTask.py.
◆ doAssembleCcd
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Assemble amp-level exposures into a ccd-level exposure?"
)
Definition at line 343 of file isrTask.py.
◆ doAssembleIsrExposures
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Assemble amp-level calibration exposures into ccd-level exposure?"
)
Definition at line 354 of file isrTask.py.
◆ 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 626 of file isrTask.py.
◆ doBias
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply bias frame correction?",
default=True,
)
Definition at line 366 of file isrTask.py.
◆ doBrighterFatter
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Apply the brighter fatter correction"
)
Definition at line 430 of file isrTask.py.
◆ doCameraSpecificMasking
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask camera-specific bad regions?",
default=False,
)
Definition at line 590 of file isrTask.py.
◆ doConvertIntToFloat
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Convert integer raw images to floating point values?",
default=True,
)
Definition at line 207 of file isrTask.py.
◆ doCrosstalk
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply intra-CCD crosstalk correction?",
default=False,
)
Definition at line 407 of file isrTask.py.
◆ doCrosstalkBeforeAssemble
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply crosstalk correction before CCD assembly, and before trimming?",
default=True,
)
Definition at line 412 of file isrTask.py.
◆ doDark
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply dark frame correction?",
default=True,
)
Definition at line 485 of file isrTask.py.
◆ doDefect
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply correction for CCD defects, e.g. hot pixels?",
default=True,
)
Definition at line 468 of file isrTask.py.
◆ doEmpiricalReadNoise
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Calculate empirical read noise instead of value from AmpInfo data?"
)
Definition at line 393 of file isrTask.py.
◆ doFlat
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply flat field correction?",
default=True,
)
Definition at line 508 of file isrTask.py.
◆ doFringe
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply fringe correction?",
default=True,
)
Definition at line 552 of file isrTask.py.
◆ doLinearize
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Correct for nonlinearity of the detector's response?",
default=True,
)
Definition at line 400 of file isrTask.py.
◆ doMeasureBackground
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Measure the background level on the reduced image?",
default=False,
)
Definition at line 583 of file isrTask.py.
◆ 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 568 of file isrTask.py.
◆ doOverscan
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do overscan subtraction?",
default=True,
)
Definition at line 269 of file isrTask.py.
◆ doSaturation
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask saturated pixels?",
default=True,
)
Definition at line 214 of file isrTask.py.
◆ doSaturationInterpolation
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Perform interpolation over pixels masked as saturated?",
default=True,
)
Definition at line 473 of file isrTask.py.
◆ 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 253 of file isrTask.py.
◆ 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 497 of file isrTask.py.
◆ doSuspect
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Mask suspect pixels?",
default=True,
)
Definition at line 236 of file isrTask.py.
◆ doTrimToMatchCalib
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Trim raw data to match calibration bounding boxes?"
)
Definition at line 359 of file isrTask.py.
◆ doTweakFlat
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Tweak flats to match observed amplifier ratios?",
default=False
)
Definition at line 533 of file isrTask.py.
◆ doUseAtmosphereTransmission
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Load and use transmission_atmosphere (if doAttachTransmissionCurve is True)?"
)
Definition at line 646 of file isrTask.py.
◆ doUseFilterTransmission
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Load and use transmission_filter (if doAttachTransmissionCurve is True)?"
)
Definition at line 636 of file isrTask.py.
◆ doUseOpticsTransmission
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Load and use transmission_optics (if doAttachTransmissionCurve is True)?"
)
Definition at line 631 of file isrTask.py.
◆ doUseSensorTransmission
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Load and use transmission_sensor (if doAttachTransmissionCurve is True)?"
)
Definition at line 641 of file isrTask.py.
◆ doVariance
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Calculate variance?",
default=True
)
Definition at line 378 of file isrTask.py.
◆ doVignette
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply vignetting parameters?",
default=False,
)
Definition at line 615 of file isrTask.py.
◆ doWidenSaturationTrails
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Widen bleed trails based on their width?",
default=True
)
Definition at line 423 of file isrTask.py.
◆ doWrite
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Persist postISRCCD?",
default=True,
)
Definition at line 653 of file isrTask.py.
◆ 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 191 of file isrTask.py.
◆ fallbackFilterName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Fallback default filter name for calibrations.",
optional=True
)
Definition at line 186 of file isrTask.py.
◆ filterTransmission
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Transmission curve due to the filter.",
name="transmission_filter",
scalar=True,
storageClass="TablePersistableTransmissionCurve",
dimensions=["Instrument", "PhysicalFilter", "ExposureRange"],
)
Definition at line 129 of file isrTask.py.
◆ flat
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Input flat calibration.",
name="flat",
scalar=True,
storageClass="MaskedImageF",
dimensions=["Instrument", "PhysicalFilter", "ExposureRange", "Detector"],
)
Definition at line 101 of file isrTask.py.
◆ flatDataProductName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of the flat data product",
default="flat",
)
Definition at line 513 of file isrTask.py.
◆ 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 518 of file isrTask.py.
◆ 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 528 of file isrTask.py.
◆ 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 601 of file isrTask.py.
◆ fringe
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=FringeTask,
doc="Fringe subtraction task",
)
Definition at line 557 of file isrTask.py.
◆ fringeAfterFlat
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Do fringe subtraction after flat-fielding?",
default=True,
)
Definition at line 561 of file isrTask.py.
◆ fwhm
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="FWHM of PSF in arcseconds.",
default=1.0,
)
Definition at line 196 of file isrTask.py.
◆ 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 383 of file isrTask.py.
◆ growSaturationFootprintSize
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of pixels by which to grow the saturation footprints",
default=1,
)
Definition at line 229 of file isrTask.py.
◆ isrName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of ISR",
default="ISR",
)
Definition at line 66 of file isrTask.py.
◆ masking
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=MaskingTask,
doc="Masking task."
)
Definition at line 595 of file isrTask.py.
◆ 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 545 of file isrTask.py.
◆ numEdgeSuspect
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of edge pixels to be flagged as untrustworthy.",
default=0,
)
Definition at line 246 of file isrTask.py.
◆ opticsTransmission
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Transmission curve due to the optics.",
name="transmission_optics",
scalar=True,
storageClass="TablePersistableTransmissionCurve",
dimensions=["Instrument", "ExposureRange"],
)
Definition at line 122 of file isrTask.py.
◆ outputExposure
|
static |
Initial value:
= pipeBase.OutputDatasetField(
doc="Output ISR processed exposure.",
name="postISRCCD",
scalar=True,
storageClass="ExposureF",
dimensions=["Instrument", "Visit", "Detector"],
)
Definition at line 152 of file isrTask.py.
◆ outputFlattenedThumbnail
|
static |
Initial value:
= pipeBase.OutputDatasetField(
doc="Output flat-corrected thumbnail image.",
name="FlattenedThumb",
scalar=True,
storageClass="TextStorage",
dimensions=["Instrument", "Visit", "Detector"],
)
Definition at line 166 of file isrTask.py.
◆ outputOssThumbnail
|
static |
Initial value:
= pipeBase.OutputDatasetField(
doc="Output Overscan-subtracted thumbnail image.",
name="OssThumb",
scalar=True,
storageClass="Thumbnail",
dimensions=["Instrument", "Visit", "Detector"],
)
Definition at line 159 of file isrTask.py.
◆ 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 321 of file isrTask.py.
◆ overscanBiasJumpDevices
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
doc="List of devices that need piecewise overscan correction.",
default=(),
)
Definition at line 331 of file isrTask.py.
◆ overscanBiasJumpKeyword
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Header keyword containing information about devices.",
default="NO_SUCH_KEY",
)
Definition at line 326 of file isrTask.py.
◆ overscanBiasJumpLocation
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Location of bias jump along y-axis.",
default=0,
)
Definition at line 336 of file isrTask.py.
◆ 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 274 of file isrTask.py.
◆ overscanIsInt
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Treat overscan as an integer image for purposes of overscan.FitType=MEDIAN",
default=True,
)
Definition at line 301 of file isrTask.py.
◆ 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 316 of file isrTask.py.
◆ 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 306 of file isrTask.py.
◆ overscanNumSigmaClip
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Rejection threshold (sigma) for collapsing overscan before fit",
default=3.0,
)
Definition at line 296 of file isrTask.py.
◆ 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 311 of file isrTask.py.
◆ 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 290 of file isrTask.py.
◆ qa
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=isrQa.IsrQaConfig,
doc="QA related configuration options.",
)
Definition at line 201 of file isrTask.py.
◆ quantum
|
static |
Initial value:
= pipeBase.QuantumConfig(
dimensions=["Visit", "Detector", "Instrument"],
)
Definition at line 174 of file isrTask.py.
◆ 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 388 of file isrTask.py.
◆ 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 219 of file isrTask.py.
◆ 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 224 of file isrTask.py.
◆ sensorTransmission
|
static |
Initial value:
= pipeBase.InputDatasetField(
doc="Transmission curve due to the sensor.",
name="transmission_sensor",
scalar=True,
storageClass="TablePersistableTransmissionCurve",
dimensions=["Instrument", "ExposureRange", "Detector"],
)
Definition at line 136 of file isrTask.py.
◆ strayLight
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=StrayLightTask,
doc="y-band stray light correction"
)
Definition at line 502 of file isrTask.py.
◆ suspectMaskName
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
doc="Name of mask plane to use for suspect pixels",
default="SUSPECT",
)
Definition at line 241 of file isrTask.py.
◆ vignette
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=VignetteTask,
doc="Vignetting task.",
)
Definition at line 620 of file isrTask.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/Linux64/ip_isr/16.0-22-g62d8060+4/python/lsst/ip/isr/isrTask.py
