IsrMockLSSTConfig#

class lsst.ip.isr.IsrMockLSSTConfig(*args, **kw)#

Bases: IsrMockConfig

Configuration parameters for isrMockLSST.

Attributes Summary

`assembleCcd`	CCD assembly task; used for defect box conversions.
`badParallelOverscanColumnLevel`	Bright parallel overscan column level (electron).
`badParallelOverscanColumnNeighborsLevel`	Bright parallel overscan column neighbors level (electron).
`bfStrength`	The brighter fatter effect scaling parameter (cannot be zero).Nominally = 1, but = 2 is more realistic.
`biasLevel`	Background contribution to be generated from the bias offset in adu.
`brightDefectLevel`	Bright defect level (electron).
`brighterFatterCalibType`	Type of calibration to generate if doGenerateData=True, otherwise ignored.
`calibMode`	Set to true to produce mock calibration products, e.g. combined bias, dark, flat, etc.
`clockInjectedOffsetLevel`	Clock-injected offset (on-chip bias level), in electron.
`darkRate`	Background level contribution (in electron/s) to be generated from dark current.
`darkTime`	Exposure time for the dark current contribution.
`detectorIndex`	Index for the detector to use.
`doAdd2DBias`	Add 2D bias residual frame to data.
`doAddBadParallelOverscanColumn`	Add a bad column to the parallel overscan.
`doAddBadParallelOverscanColumnNeighbors`	Add low-level bad columns next to parallel overscan bad column.
`doAddBias`	Add bias signal to data.
`doAddBrightDefects`	Add bright defects (bad column) to data.
`doAddBrighterFatter`	Add brighter fatter and/or diffusion effects to image.
`doAddClockInjectedOffset`	Add clock-injected offset to data (on-chip bias level).
`doAddCrosstalk`	Apply simulated crosstalk to output image.
`doAddDark`	Add dark signal to data.
`doAddDarkNoiseOnly`	Add only dark current noise, for testing consistency.
`doAddDeferredCharge`	Add serial CTI at the amp level? (`bool`, default `False`)
`doAddFlat`	Add flat signal to data.
`doAddFringe`	Add fringe signal to data.
`doAddHighSignalNonlinearity`	Add high signal non-linearity to overscan and data regions? (`bool`, default `True`)
`doAddLowSignalNonlinearity`	Add low signal non-linearity to overscan and data regions? (Not supported yet.) (`bool`, default `False`)
`doAddOverscan`	If untrimmed, add overscan ramp to overscan and data regions.
`doAddParallelOverscanRamp`	Add overscan ramp to parallel overscan and data regions.
`doAddSerialOverscanRamp`	Add overscan ramp to serial overscan and data regions.
`doAddSky`	Apply 'sky' signal to output image.
`doAddSource`	Add simulated source to output image.
`doApplyGain`	Add gain to data.
`doBrighterFatter`	Return a simulated brighter-fatter kernel.
`doCrosstalkCoeffs`	Return the matrix of crosstalk coefficients.
`doDataRef`	Return a simulated gen2 butler dataRef.
`doDefects`	Return a simulated defect list.
`doDeferredCharge`	Return a simulated deferred charge calibration.
`doGenerateAmpDict`	Return a dict of exposure amplifiers instead of an afwImage.Exposure.
`doGenerateData`	Return a non-image data structure if True.
`doGenerateImage`	Return the generated output image if True.
`doLinearizer`	Return linearizer dataset.
`doRoundAdu`	Round adu values to nearest integer.
`doTransmissionCurve`	Return a simulated transmission curve.
`expTime`	Exposure time for simulated data.
`flatDrop`	Fractional flux drop due to flat from center to edge of detector along x-axis.
`fringeScale`	Peak fluxes for the components of the fringe ripple in adu (IsrTask) or electron (IsrTaskLSST).
`fringeX0`	Center position for the fringe ripples.
`fringeY0`	Center position for the fringe ripples.
`gain`	Gain for simulated data in electron/adu.
`gainDict`	Dictionary of amp name to gain; any amps not listed will use config.gain as the value.
`highSignalNonlinearityThreshold`	Threshold (in adu) for the non-linearity to be considered `high signal`.
`isLsstLike`	If True, products have one raw image per amplifier, otherwise, one raw image per detector.
`isTrimmed`	If True, amplifiers have been trimmed and mosaicked to remove regions outside the data BBox.
`nRecalc`	Number of electrons to accumulate before recalculating pixel shapes.
`noise2DBias`	Noise (in electron) to generate a 2D bias residual frame.
`overscanScale`	Amplitude of the ramp function to add to overscan data in adu (IsrTask) or electron (IsrTaskLSST) (`float`, default `100.0`)
`plateScale`	Plate scale used in constructing mock camera.
`radialDistortion`	Radial distortion term used in constructing mock camera.
`readNoise`	Read noise of the detector in electron.
`rngSeed`	Seed for random number generator used to add noise.
`skyLevel`	Background contribution to be generated from 'the sky' in adu (IsrTask) or electron (IsrTaskLSST).
`sourceAmp`	Amplifier to place simulated 'astronomical sources'.
`sourceFlux`	Peak flux level of simulated 'astronomical sources' in adu (IsrTask) or electron (IsrTaskLSST).
`sourceX`	Peak position (in amplifier coordinates) of simulated 'astronomical sources'.
`sourceY`	Peak position (in amplifier coordinates) of simulated 'astronomical sources'.

Methods Summary

`setDefaults`()	Subclass hook for computing defaults.
`validate`()	Validate the Config, raising an exception if invalid.

Attributes Documentation

assembleCcd#: CCD assembly task; used for defect box conversions. (ConfigurableInstance, default <class 'lsst.ip.isr.assembleCcdTask.AssembleCcdConfig'>)

badParallelOverscanColumnLevel#: Bright parallel overscan column level (electron). Should be above saturation. (float, default 300000.0)

badParallelOverscanColumnNeighborsLevel#: Bright parallel overscan column neighbors level (electron). (float, default 50.0)

bfStrength#: The brighter fatter effect scaling parameter (cannot be zero).Nominally = 1, but = 2 is more realistic. (float, default 2.0)

biasLevel#: Background contribution to be generated from the bias offset in adu. (float, default 8000.0)

brightDefectLevel#: Bright defect level (electron). (float, default 30000.0)

brighterFatterCalibType#

Type of calibration to generate if doGenerateData=True, otherwise ignored. (str, default 'KERNEL')

Allowed values:

'KERNEL': No default suspect values; only config overrides will be used.
'ELECTROSTATIC': Use the default from the camera model (old defaults).
'None': Field is optional

calibMode#: Set to true to produce mock calibration products, e.g. combined bias, dark, flat, etc. (bool, default False)

clockInjectedOffsetLevel#: Clock-injected offset (on-chip bias level), in electron. (float, default 8500.0)

darkRate#: Background level contribution (in electron/s) to be generated from dark current. (float, default 5.0)

darkTime#: Exposure time for the dark current contribution. (float, default 5.0)

detectorIndex#: Index for the detector to use. The default value uses a standard 2x4 array of amps. (int, default 20)

doAdd2DBias#: Add 2D bias residual frame to data. (bool, default True)

doAddBadParallelOverscanColumn#: Add a bad column to the parallel overscan. (bool, default True)

doAddBadParallelOverscanColumnNeighbors#: Add low-level bad columns next to parallel overscan bad column. (bool, default True)

doAddBias#: Add bias signal to data. (bool, default True)

doAddBrightDefects#: Add bright defects (bad column) to data. (bool, default True)

doAddBrighterFatter#: Add brighter fatter and/or diffusion effects to image. (bool, default False)

doAddClockInjectedOffset#: Add clock-injected offset to data (on-chip bias level). (bool, default True)

doAddCrosstalk#: Apply simulated crosstalk to output image. This cannot be corrected by ISR, as detector.hasCrosstalk()==False. (bool, default False)

doAddDark#: Add dark signal to data. (bool, default True)

doAddDarkNoiseOnly#: Add only dark current noise, for testing consistency. (bool, default False)

doAddDeferredCharge#: Add serial CTI at the amp level? (bool, default False)

doAddFlat#: Add flat signal to data. (bool, default True)

doAddFringe#: Add fringe signal to data. (bool, default True)

doAddHighSignalNonlinearity#: Add high signal non-linearity to overscan and data regions? (bool, default True)

doAddLowSignalNonlinearity#: Add low signal non-linearity to overscan and data regions? (Not supported yet.) (bool, default False)

doAddOverscan#: If untrimmed, add overscan ramp to overscan and data regions. (bool, default True)

doAddParallelOverscanRamp#: Add overscan ramp to parallel overscan and data regions. (bool, default True)

doAddSerialOverscanRamp#: Add overscan ramp to serial overscan and data regions. (bool, default True)

doAddSky#: Apply ‘sky’ signal to output image. (bool, default True)

doAddSource#: Add simulated source to output image. (bool, default True)

doApplyGain#: Add gain to data. (bool, default True)

doBrighterFatter#: Return a simulated brighter-fatter kernel. (bool, default False)

doCrosstalkCoeffs#: Return the matrix of crosstalk coefficients. (bool, default False)

doDataRef#: Return a simulated gen2 butler dataRef. (bool, default False)

doDefects#: Return a simulated defect list. (bool, default False)

doDeferredCharge#: Return a simulated deferred charge calibration. (bool, default False)

doGenerateAmpDict#: Return a dict of exposure amplifiers instead of an afwImage.Exposure. (bool, default False)

doGenerateData#: Return a non-image data structure if True. (bool, default False)

doGenerateImage#: Return the generated output image if True. (bool, default False)

doLinearizer#: Return linearizer dataset. (bool, default False)

doRoundAdu#: Round adu values to nearest integer. (bool, default True)

doTransmissionCurve#: Return a simulated transmission curve. (bool, default False)

expTime#: Exposure time for simulated data. (float, default 5.0)

flatDrop#: Fractional flux drop due to flat from center to edge of detector along x-axis. (float, default 0.1)

fringeScale#: Peak fluxes for the components of the fringe ripple in adu (IsrTask) or electron (IsrTaskLSST). (List, default [200.0])

fringeX0#: Center position for the fringe ripples. (List, default [-100])

fringeY0#: Center position for the fringe ripples. (List, default [0])

gain#: Gain for simulated data in electron/adu. (float, default 1.0)

gainDict#: Dictionary of amp name to gain; any amps not listed will use config.gain as the value. Units are electron/adu. (Dict, default {'C:0,0': 1.65, 'C:0,1': 1.6, 'C:0,2': 1.55, 'C:0,3': 1.7, 'C:1,0': 1.75, 'C:1,1': 1.8, 'C:1,2': 1.85, 'C:1,3': 1.7})

highSignalNonlinearityThreshold#: Threshold (in adu) for the non-linearity to be considered high signal. (float, default 40000.0)

isLsstLike#: If True, products have one raw image per amplifier, otherwise, one raw image per detector. (bool, default True)

isTrimmed#: If True, amplifiers have been trimmed and mosaicked to remove regions outside the data BBox. (bool, default True)

nRecalc#: Number of electrons to accumulate before recalculating pixel shapes. (int, default 10000)

noise2DBias#: Noise (in electron) to generate a 2D bias residual frame. (float, default 2.0)

overscanScale#: Amplitude of the ramp function to add to overscan data in adu (IsrTask) or electron (IsrTaskLSST) (float, default 100.0)

plateScale#: Plate scale used in constructing mock camera. (float, default 20.0)

radialDistortion#: Radial distortion term used in constructing mock camera. (float, default 0.925)

readNoise#: Read noise of the detector in electron. (float, default 5.0)

rngSeed#: Seed for random number generator used to add noise. (int, default 20000913)

skyLevel#: Background contribution to be generated from ‘the sky’ in adu (IsrTask) or electron (IsrTaskLSST). (float, default 1000.0)

sourceAmp#: Amplifier to place simulated ‘astronomical sources’. (List, default [0])

sourceFlux#: Peak flux level of simulated ‘astronomical sources’ in adu (IsrTask) or electron (IsrTaskLSST). (List, default [45000.0])

sourceX#: Peak position (in amplifier coordinates) of simulated ‘astronomical sources’. (List, default [50.0])

sourceY#: Peak position (in amplifier coordinates) of simulated ‘astronomical sources’. (List, default [25.0])

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.