lsst.ip.isr.isrMockLSST.IsrMockLSSTConfig Class Reference
Inheritance diagram for lsst.ip.isr.isrMockLSST.IsrMockLSSTConfig:
Public Member Functions | |
| validate (self) | |
| setDefaults (self) | |
Detailed Description
Configuration parameters for isrMockLSST.
Definition at line 51 of file isrMockLSST.py.
Member Function Documentation
◆ setDefaults()
| lsst.ip.isr.isrMockLSST.IsrMockLSSTConfig.setDefaults | ( | self | ) |
Definition at line 208 of file isrMockLSST.py.
◆ validate()
| lsst.ip.isr.isrMockLSST.IsrMockLSSTConfig.validate | ( | self | ) |
Definition at line 198 of file isrMockLSST.py.
Member Data Documentation
◆ assembleCcd
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=AssembleCcdTask,
doc="CCD assembly task; used for defect box conversions.",
)
Definition at line 193 of file isrMockLSST.py.
◆ badParallelOverscanColumnLevel
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=300000.,
doc="Bright parallel overscan column level (electron). Should be above saturation.",
)
Definition at line 86 of file isrMockLSST.py.
◆ badParallelOverscanColumnNeighborsLevel
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=50.0,
doc="Bright parallel overscan column neighbors level (electron).",
)
Definition at line 96 of file isrMockLSST.py.
◆ bfStrength
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=2.0,
doc="The brighter fatter effect scaling parameter (cannot be zero)."
"Nominally = 1, but = 2 is more realistic."
)
Definition at line 111 of file isrMockLSST.py.
◆ biasLevel
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=8000.0,
doc="Background contribution to be generated from the bias offset in adu.",
)
Definition at line 139 of file isrMock.py.
◆ brightDefectLevel
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=30000.0,
doc="Bright defect level (electron).",
)
Definition at line 76 of file isrMockLSST.py.
◆ brighterFatterCalibType
|
staticinherited |
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Type of calibration to generate if doGenerateData=True, otherwise ignored.",
allowed={
"KERNEL": "No default suspect values; only config overrides will be used.",
"ELECTROSTATIC": "Use the default from the camera model (old defaults).",
},
default="KERNEL",
)
Definition at line 235 of file isrMock.py.
◆ calibMode
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Set to true to produce mock calibration products, e.g. combined bias, dark, flat, etc.",
)
Definition at line 61 of file isrMockLSST.py.
◆ clockInjectedOffsetLevel
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=8500.0,
doc="Clock-injected offset (on-chip bias level), in electron.",
)
Definition at line 127 of file isrMockLSST.py.
◆ darkRate
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=5.0,
doc="Background level contribution (in electron/s) to be generated from dark current.",
)
Definition at line 144 of file isrMock.py.
◆ darkTime
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=5.0,
doc="Exposure time for the dark current contribution.",
)
Definition at line 149 of file isrMock.py.
◆ detectorIndex
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
default=20,
doc="Index for the detector to use. The default value uses a standard 2x4 array of amps.",
)
Definition at line 78 of file isrMock.py.
◆ doAdd2DBias
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add 2D bias residual frame to data.",
)
Definition at line 66 of file isrMockLSST.py.
◆ doAddBadParallelOverscanColumn
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add a bad column to the parallel overscan.",
)
Definition at line 81 of file isrMockLSST.py.
◆ doAddBadParallelOverscanColumnNeighbors
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add low-level bad columns next to parallel overscan bad column.",
)
Definition at line 91 of file isrMockLSST.py.
◆ doAddBias
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add bias signal to data.",
)
Definition at line 198 of file isrMock.py.
◆ doAddBrightDefects
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add bright defects (bad column) to data.",
)
Definition at line 71 of file isrMockLSST.py.
◆ doAddBrighterFatter
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Add brighter fatter and/or diffusion effects to image.",
)
Definition at line 101 of file isrMockLSST.py.
◆ doAddClockInjectedOffset
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add clock-injected offset to data (on-chip bias level).",
)
Definition at line 122 of file isrMockLSST.py.
◆ doAddCrosstalk
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Apply simulated crosstalk to output image. This cannot be corrected by ISR, "
"as detector.hasCrosstalk()==False.",
)
Definition at line 187 of file isrMock.py.
◆ doAddDark
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add dark signal to data.",
)
Definition at line 203 of file isrMock.py.
◆ doAddDarkNoiseOnly
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Add only dark current noise, for testing consistency.",
)
Definition at line 137 of file isrMockLSST.py.
◆ doAddDeferredCharge
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Add serial CTI at the amp level?",
)
Definition at line 106 of file isrMockLSST.py.
◆ doAddFlat
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add flat signal to data.",
)
Definition at line 208 of file isrMock.py.
◆ doAddFringe
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add fringe signal to data.",
)
Definition at line 213 of file isrMock.py.
◆ doAddHighSignalNonlinearity
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add high signal non-linearity to overscan and data regions?",
)
Definition at line 152 of file isrMockLSST.py.
◆ doAddLowSignalNonlinearity
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Add low signal non-linearity to overscan and data regions? (Not supported yet.)",
)
Definition at line 157 of file isrMockLSST.py.
◆ doAddOverscan
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="If untrimmed, add overscan ramp to overscan and data regions.",
)
Definition at line 193 of file isrMock.py.
◆ doAddParallelOverscanRamp
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add overscan ramp to parallel overscan and data regions.",
)
Definition at line 142 of file isrMockLSST.py.
◆ doAddSerialOverscanRamp
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add overscan ramp to serial overscan and data regions.",
)
Definition at line 147 of file isrMockLSST.py.
◆ doAddSky
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Apply 'sky' signal to output image.",
)
Definition at line 177 of file isrMock.py.
◆ doAddSource
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add simulated source to output image.",
)
Definition at line 182 of file isrMock.py.
◆ doApplyGain
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add gain to data.",
)
Definition at line 167 of file isrMockLSST.py.
◆ doBrighterFatter
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated brighter-fatter kernel.",
)
Definition at line 230 of file isrMock.py.
◆ doCrosstalkCoeffs
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return the matrix of crosstalk coefficients.",
)
Definition at line 250 of file isrMock.py.
◆ doDataRef
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated gen2 butler dataRef.",
)
Definition at line 260 of file isrMock.py.
◆ doDefects
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated defect list.",
)
Definition at line 225 of file isrMock.py.
◆ doDeferredCharge
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated deferred charge calibration.",
)
Definition at line 245 of file isrMock.py.
◆ doGenerateAmpDict
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a dict of exposure amplifiers instead of an afwImage.Exposure.",
)
Definition at line 275 of file isrMock.py.
◆ doGenerateData
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a non-image data structure if True.",
)
Definition at line 270 of file isrMock.py.
◆ doGenerateImage
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return the generated output image if True.",
)
Definition at line 265 of file isrMock.py.
◆ doLinearizer
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return linearizer dataset.",
)
Definition at line 255 of file isrMock.py.
◆ doRoundAdu
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Round adu values to nearest integer.",
)
Definition at line 172 of file isrMockLSST.py.
◆ doTransmissionCurve
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated transmission curve.",
)
Definition at line 220 of file isrMock.py.
◆ expTime
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=5.0,
doc="Exposure time for simulated data.",
)
Definition at line 99 of file isrMock.py.
◆ flatDrop
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=0.1,
doc="Fractional flux drop due to flat from center to edge of detector along x-axis.",
)
Definition at line 154 of file isrMock.py.
◆ fringeScale
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=float,
default=[200.0],
doc="Peak fluxes for the components of the fringe ripple in "
"adu (IsrTask) or electron (IsrTaskLSST).",
)
Definition at line 159 of file isrMock.py.
◆ fringeX0
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=float,
default=[-100],
doc="Center position for the fringe ripples.",
)
Definition at line 165 of file isrMock.py.
◆ fringeY0
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=float,
default=[-0],
doc="Center position for the fringe ripples.",
)
Definition at line 170 of file isrMock.py.
◆ gain
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=1.0,
doc="Gain for simulated data in electron/adu.",
)
Definition at line 89 of file isrMock.py.
◆ gainDict
|
static |
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=float,
doc="Dictionary of amp name to gain; any amps not listed will use "
"config.gain as the value. Units are electron/adu.",
default={
"C:0,0": 1.65,
"C:0,1": 1.60,
"C:0,2": 1.55,
"C:0,3": 1.70,
"C:1,0": 1.75,
"C:1,1": 1.80,
"C:1,2": 1.85,
"C:1,3": 1.70,
},
)
Definition at line 177 of file isrMockLSST.py.
◆ highSignalNonlinearityThreshold
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=40_000.,
doc="Threshold (in adu) for the non-linearity to be considered ``high signal``.",
)
Definition at line 162 of file isrMockLSST.py.
◆ isLsstLike
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If True, products have one raw image per amplifier, otherwise, one raw image per detector.",
)
Definition at line 58 of file isrMock.py.
◆ isTrimmed
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="If True, amplifiers have been trimmed and mosaicked to remove regions outside the data BBox.",
)
Definition at line 73 of file isrMock.py.
◆ noise2DBias
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=2.0,
doc="Noise (in electron) to generate a 2D bias residual frame.",
)
Definition at line 132 of file isrMockLSST.py.
◆ nRecalc
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
default=10000,
doc="Number of electrons to accumulate before recalculating pixel shapes.",
)
Definition at line 117 of file isrMockLSST.py.
◆ overscanScale
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=100.0,
doc="Amplitude of the ramp function to add to overscan data in "
"adu (IsrTask) or electron (IsrTaskLSST)",
)
Definition at line 133 of file isrMock.py.
◆ plateScale
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=20.0,
doc="Plate scale used in constructing mock camera.",
)
Definition at line 63 of file isrMock.py.
◆ radialDistortion
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=0.925,
doc="Radial distortion term used in constructing mock camera.",
)
Definition at line 68 of file isrMock.py.
◆ readNoise
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=5.0,
doc="Read noise of the detector in electron.",
)
Definition at line 94 of file isrMock.py.
◆ rngSeed
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=int,
default=20000913,
doc="Seed for random number generator used to add noise.",
)
Definition at line 83 of file isrMock.py.
◆ skyLevel
|
staticinherited |
Initial value:
= pexConfig.Field(
dtype=float,
default=1000.0,
doc="Background contribution to be generated from 'the sky' in "
"adu (IsrTask) or electron (IsrTaskLSST).",
)
Definition at line 106 of file isrMock.py.
◆ sourceAmp
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=int,
default=[0],
doc="Amplifier to place simulated 'astronomical sources'.",
)
Definition at line 118 of file isrMock.py.
◆ sourceFlux
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=float,
default=[45000.0],
doc="Peak flux level of simulated 'astronomical sources' in "
"adu (IsrTask) or electron (IsrTaskLSST).",
)
Definition at line 112 of file isrMock.py.
◆ sourceX
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=float,
default=[50.0],
doc="Peak position (in amplifier coordinates) of simulated 'astronomical sources'.",
)
Definition at line 123 of file isrMock.py.
◆ sourceY
|
staticinherited |
Initial value:
= pexConfig.ListField(
dtype=float,
default=[25.0],
doc="Peak position (in amplifier coordinates) of simulated 'astronomical sources'.",
)
Definition at line 128 of file isrMock.py.
The documentation for this class was generated from the following file:
- python/lsst/ip/isr/isrMockLSST.py
Generated on Fri Apr 24 2026 08:28:19 for lsst.ip.isr by
1.13.2