lsst.ip.isr  18.0.0-8-g697fdba+4
Static Public Attributes | List of all members
lsst.ip.isr.isrMock.IsrMockConfig Class Reference
Inheritance diagram for lsst.ip.isr.isrMock.IsrMockConfig:

Static Public Attributes

 isLsstLike
 
 isTrimmed
 
 detectorIndex
 
 rngSeed
 
 gain
 
 readNoise
 
 expTime
 
 skyLevel
 
 sourceFlux
 
 sourceAmp
 
 sourceX
 
 sourceY
 
 overscanScale
 
 biasLevel
 
 darkRate
 
 darkTime
 
 flatDrop
 
 fringeScale
 
 fringeX0
 
 fringeY0
 
 doAddSky
 
 doAddSource
 
 doAddCrosstalk
 
 doAddOverscan
 
 doAddBias
 
 doAddDark
 
 doAddFlat
 
 doAddFringe
 
 doTransmissionCurve
 
 doDefects
 
 doBrighterFatter
 
 doCrosstalkCoeffs
 
 doDataRef
 
 doGenerateImage
 
 doGenerateData
 
 doGenerateAmpDict
 

Detailed Description

Configuration parameters for isrMock.

These parameters produce generic fixed position signals from
various sources, and combine them in a way that matches how those
signals are combined to create real data. The camera used is the
test camera defined by the afwUtils code.

Definition at line 43 of file isrMock.py.

Member Data Documentation

◆ biasLevel

lsst.ip.isr.isrMock.IsrMockConfig.biasLevel
static
Initial value:
= pexConfig.Field(
dtype=float,
default=8000.0,
doc="Background contribution to be generated from the bias offset in DN.",
)

Definition at line 120 of file isrMock.py.

◆ darkRate

lsst.ip.isr.isrMock.IsrMockConfig.darkRate
static
Initial value:
= pexConfig.Field(
dtype=float,
default=5.0,
doc="Background level contribution (in e-/s) to be generated from dark current.",
)

Definition at line 125 of file isrMock.py.

◆ darkTime

lsst.ip.isr.isrMock.IsrMockConfig.darkTime
static
Initial value:
= pexConfig.Field(
dtype=float,
default=5.0,
doc="Exposure time for the dark current contribution.",
)

Definition at line 130 of file isrMock.py.

◆ detectorIndex

lsst.ip.isr.isrMock.IsrMockConfig.detectorIndex
static
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 62 of file isrMock.py.

◆ doAddBias

lsst.ip.isr.isrMock.IsrMockConfig.doAddBias
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add bias signal to data.",
)

Definition at line 178 of file isrMock.py.

◆ doAddCrosstalk

lsst.ip.isr.isrMock.IsrMockConfig.doAddCrosstalk
static
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 167 of file isrMock.py.

◆ doAddDark

lsst.ip.isr.isrMock.IsrMockConfig.doAddDark
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add dark signal to data.",
)

Definition at line 183 of file isrMock.py.

◆ doAddFlat

lsst.ip.isr.isrMock.IsrMockConfig.doAddFlat
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add flat signal to data.",
)

Definition at line 188 of file isrMock.py.

◆ doAddFringe

lsst.ip.isr.isrMock.IsrMockConfig.doAddFringe
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add fringe signal to data.",
)

Definition at line 193 of file isrMock.py.

◆ doAddOverscan

lsst.ip.isr.isrMock.IsrMockConfig.doAddOverscan
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="If untrimmed, add overscan ramp to overscan and data regions.",
)

Definition at line 173 of file isrMock.py.

◆ doAddSky

lsst.ip.isr.isrMock.IsrMockConfig.doAddSky
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Apply 'sky' signal to output image.",
)

Definition at line 157 of file isrMock.py.

◆ doAddSource

lsst.ip.isr.isrMock.IsrMockConfig.doAddSource
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Add simulated source to output image.",
)

Definition at line 162 of file isrMock.py.

◆ doBrighterFatter

lsst.ip.isr.isrMock.IsrMockConfig.doBrighterFatter
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated brighter-fatter kernel.",
)

Definition at line 210 of file isrMock.py.

◆ doCrosstalkCoeffs

lsst.ip.isr.isrMock.IsrMockConfig.doCrosstalkCoeffs
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return the matrix of crosstalk coefficients.",
)

Definition at line 215 of file isrMock.py.

◆ doDataRef

lsst.ip.isr.isrMock.IsrMockConfig.doDataRef
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated gen2 butler dataRef.",
)

Definition at line 220 of file isrMock.py.

◆ doDefects

lsst.ip.isr.isrMock.IsrMockConfig.doDefects
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated defect list.",
)

Definition at line 205 of file isrMock.py.

◆ doGenerateAmpDict

lsst.ip.isr.isrMock.IsrMockConfig.doGenerateAmpDict
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a dict of exposure amplifiers instead of an afwImage.Exposure.",
)

Definition at line 235 of file isrMock.py.

◆ doGenerateData

lsst.ip.isr.isrMock.IsrMockConfig.doGenerateData
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a non-image data structure if True.",
)

Definition at line 230 of file isrMock.py.

◆ doGenerateImage

lsst.ip.isr.isrMock.IsrMockConfig.doGenerateImage
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return the generated output image if True.",
)

Definition at line 225 of file isrMock.py.

◆ doTransmissionCurve

lsst.ip.isr.isrMock.IsrMockConfig.doTransmissionCurve
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Return a simulated transmission curve.",
)

Definition at line 200 of file isrMock.py.

◆ expTime

lsst.ip.isr.isrMock.IsrMockConfig.expTime
static
Initial value:
= pexConfig.Field(
dtype=float,
default=5.0,
doc="Exposure time for simulated data.",
)

Definition at line 83 of file isrMock.py.

◆ flatDrop

lsst.ip.isr.isrMock.IsrMockConfig.flatDrop
static
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 135 of file isrMock.py.

◆ fringeScale

lsst.ip.isr.isrMock.IsrMockConfig.fringeScale
static
Initial value:
= pexConfig.ListField(
dtype=float,
default=[200.0],
doc="Peak fluxes for the components of the fringe ripple in DN.",
)

Definition at line 140 of file isrMock.py.

◆ fringeX0

lsst.ip.isr.isrMock.IsrMockConfig.fringeX0
static
Initial value:
= pexConfig.ListField(
dtype=float,
default=[-100],
doc="Center position for the fringe ripples.",
)

Definition at line 145 of file isrMock.py.

◆ fringeY0

lsst.ip.isr.isrMock.IsrMockConfig.fringeY0
static
Initial value:
= pexConfig.ListField(
dtype=float,
default=[-0],
doc="Center position for the fringe ripples.",
)

Definition at line 150 of file isrMock.py.

◆ gain

lsst.ip.isr.isrMock.IsrMockConfig.gain
static
Initial value:
= pexConfig.Field(
dtype=float,
default=1.0,
doc="Gain for simulated data in e^-/DN.",
)

Definition at line 73 of file isrMock.py.

◆ isLsstLike

lsst.ip.isr.isrMock.IsrMockConfig.isLsstLike
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="If True, products have one raw image per amplifier, otherwise, one raw image per detector.",
)

Definition at line 52 of file isrMock.py.

◆ isTrimmed

lsst.ip.isr.isrMock.IsrMockConfig.isTrimmed
static
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 57 of file isrMock.py.

◆ overscanScale

lsst.ip.isr.isrMock.IsrMockConfig.overscanScale
static
Initial value:
= pexConfig.Field(
dtype=float,
default=100.0,
doc="Amplitude (in DN) of the ramp function to add to overscan data.",
)

Definition at line 115 of file isrMock.py.

◆ readNoise

lsst.ip.isr.isrMock.IsrMockConfig.readNoise
static
Initial value:
= pexConfig.Field(
dtype=float,
default=5.0,
doc="Read noise of the detector in e-.",
)

Definition at line 78 of file isrMock.py.

◆ rngSeed

lsst.ip.isr.isrMock.IsrMockConfig.rngSeed
static
Initial value:
= pexConfig.Field(
dtype=int,
default=20000913,
doc="Seed for random number generator used to add noise.",
)

Definition at line 67 of file isrMock.py.

◆ skyLevel

lsst.ip.isr.isrMock.IsrMockConfig.skyLevel
static
Initial value:
= pexConfig.Field(
dtype=float,
default=1000.0,
doc="Background contribution to be generated from 'the sky' in DN.",
)

Definition at line 90 of file isrMock.py.

◆ sourceAmp

lsst.ip.isr.isrMock.IsrMockConfig.sourceAmp
static
Initial value:
= pexConfig.ListField(
dtype=int,
default=[0],
doc="Amplifier to place simulated 'astronomical sources'.",
)

Definition at line 100 of file isrMock.py.

◆ sourceFlux

lsst.ip.isr.isrMock.IsrMockConfig.sourceFlux
static
Initial value:
= pexConfig.ListField(
dtype=float,
default=[45000.0],
doc="Peak flux level (in DN) of simulated 'astronomical sources'.",
)

Definition at line 95 of file isrMock.py.

◆ sourceX

lsst.ip.isr.isrMock.IsrMockConfig.sourceX
static
Initial value:
= pexConfig.ListField(
dtype=float,
default=[50.0],
doc="Peak position (in amplifier coordinates) of simulated 'astronomical sources'.",
)

Definition at line 105 of file isrMock.py.

◆ sourceY

lsst.ip.isr.isrMock.IsrMockConfig.sourceY
static
Initial value:
= pexConfig.ListField(
dtype=float,
default=[25.0],
doc="Peak position (in amplifier coordinates) of simulated 'astronomical sources'.",
)

Definition at line 110 of file isrMock.py.


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