Inheritance diagram for lsst.ip.isr.isrMock.RawDictMock:

Public Member Functions
	__init__ (self, **kwargs)

	run (self)

	makeData (self)

	makeBfKernel (self)

	makeElectrostaticBf (self)

	makeDeferredChargeCalib (self)

	makeDefectList (self)

	makeCrosstalkCoeff (self)

	makeTransmissionCurve (self)

	makeLinearity (self)

	makeImage (self)

	getCamera (self, isForAssembly=False)

	getExposure (self, isTrimmed=None)

	getWcs (self)

	localCoordToExpCoord (self, ampData, x, y)

	amplifierAddNoise (self, ampData, mean, sigma, rng=None)

	amplifierAddYGradient (self, ampData, start, end)

	amplifierAddSource (self, ampData, scale, x0, y0)

	amplifierAddFringe (self, amp, ampData, scale, x0=100, y0=0)

	amplifierMultiplyFlat (self, amp, ampData, fracDrop, u0=100.0, v0=100.0)

Public Attributes
	rng = np.random.RandomState(self.config.rngSeed)

	crosstalkCoeffs

float	bfKernel

int	aN

int	aE

int	aS = self.aN

int	aW = self.aE

tuple	aVector = (self.aN, self.aS, self.aE, self.aW)

Static Public Attributes
	ConfigClass = IsrMockConfig

Protected Attributes
	_display

Static Protected Attributes
str	_DefaultName = "isrMock"

Detailed Description

Generate a raw exposure dict suitable for ISR.

Definition at line 989 of file isrMock.py.

Constructor & Destructor Documentation

◆ init()

lsst.ip.isr.isrMock.RawDictMock.__init__	(		self,
		**	kwargs )

Definition at line 992 of file isrMock.py.

Member Function Documentation

◆ amplifierAddFringe()

lsst.ip.isr.isrMock.IsrMock.amplifierAddFringe	(	self,
		amp,
		ampData,
		scale,
		x0 = 100,
		y0 = 0 )

inherited

Add a fringe-like ripple pattern to an amplifier's image data.

Parameters
----------
amp : `~lsst.afw.ampInfo.AmpInfoRecord`
    Amplifier to operate on. Needed for amp<->exp coordinate
    transforms.
ampData : `lsst.afw.image.ImageF`
    Amplifier image to operate on.
scale : `numpy.array` or `float`
    Peak intensity scaling for the ripple.
x0 : `numpy.array` or `float`, optional
    Fringe center
y0 : `numpy.array` or `float`, optional
    Fringe center

Notes
-----
This uses an offset sinc function to generate a ripple
pattern. True fringes have much finer structure, but this
pattern should be visually identifiable. The (x, y)
coordinates are in the frame of the amplifier, and (u, v) in
the frame of the full trimmed image.

Definition at line 875 of file isrMock.py.

◆ amplifierAddNoise()

lsst.ip.isr.isrMock.IsrMock.amplifierAddNoise	(	self,
		ampData,
		mean,
		sigma,
		rng = None )

inherited

Add Gaussian noise to an amplifier's image data.

 This method operates in the amplifier coordinate frame.

Parameters
----------
ampData : `lsst.afw.image.ImageF`
    Amplifier image to operate on.
mean : `float`
    Mean value of the Gaussian noise.
sigma : `float`
    Sigma of the Gaussian noise.
rng : `np.random.RandomState`, optional
    Random state to use instead of self.rng.

Definition at line 809 of file isrMock.py.

◆ amplifierAddSource()

lsst.ip.isr.isrMock.IsrMock.amplifierAddSource	(	self,
		ampData,
		scale,
		x0,
		y0 )

inherited

Add a single Gaussian source to an amplifier.

 This method operates in the amplifier coordinate frame.

Parameters
----------
ampData : `lsst.afw.image.ImageF`
    Amplifier image to operate on.
scale : `float`
    Peak flux of the source to add.
x0 : `float`
    X-coordinate of the source peak.
y0 : `float`
    Y-coordinate of the source peak.

Definition at line 853 of file isrMock.py.

◆ amplifierAddYGradient()

lsst.ip.isr.isrMock.IsrMock.amplifierAddYGradient	(	self,
		ampData,
		start,
		end )

inherited

Add a y-axis linear gradient to an amplifier's image data.

 This method operates in the amplifier coordinate frame.

Parameters
----------
ampData : `lsst.afw.image.ImageF`
    Amplifier image to operate on.
start : `float`
    Start value of the gradient (at y=0).
end : `float`
    End value of the gradient (at y=ymax).

Definition at line 834 of file isrMock.py.

◆ amplifierMultiplyFlat()

lsst.ip.isr.isrMock.IsrMock.amplifierMultiplyFlat	(	self,
		amp,
		ampData,
		fracDrop,
		u0 = 100.0,
		v0 = 100.0 )

inherited

Multiply an amplifier's image data by a flat-like pattern.

Parameters
----------
amp : `lsst.afw.ampInfo.AmpInfoRecord`
    Amplifier to operate on. Needed for amp<->exp coordinate
    transforms.
ampData : `lsst.afw.image.ImageF`
    Amplifier image to operate on.
fracDrop : `float`
    Fractional drop from center to edge of detector along x-axis.
u0 : `float`
    Peak location in detector coordinates.
v0 : `float`
    Peak location in detector coordinates.

Notes
-----
This uses a 2-d Gaussian to simulate an illumination pattern
that falls off towards the edge of the detector. The (x, y)
coordinates are in the frame of the amplifier, and (u, v) in
the frame of the full trimmed image.

Reimplemented in lsst.ip.isr.isrMockLSST.IsrMockLSST.

Definition at line 907 of file isrMock.py.

◆ getCamera()

lsst.ip.isr.isrMock.IsrMock.getCamera	(		self,
			isForAssembly = False )

inherited

Construct a test camera object.

Parameters
-------
isForAssembly : `bool`
    If True, construct a camera with "super raw"
    orientation (all amplifiers have LL readout
    corner but still contains the necessary flip
    and offset info needed for assembly. This is
    needed if isLsstLike is True. If False, return
    a camera with bboxes flipped and offset to the
    correct orientation given the readout corner.

Returns
-------
camera : `lsst.afw.cameraGeom.camera`
    Test camera.

Definition at line 596 of file isrMock.py.

◆ getExposure()

lsst.ip.isr.isrMock.IsrMock.getExposure	(		self,
			isTrimmed = None )

inherited

Construct a test exposure.

The test exposure has a simple WCS set, as well as a list of
unlikely header keywords that can be removed during ISR
processing to exercise that code.

Parameters
----------
isTrimmed : `bool` or `None`, optional
    Override the configuration isTrimmed?

Returns
-------
exposure : `lsst.afw.exposure.Exposure`
    Construct exposure containing masked image of the
    appropriate size.

Definition at line 623 of file isrMock.py.

◆ getWcs()

lsst.ip.isr.isrMock.IsrMock.getWcs ( self )

inherited

Construct a dummy WCS object.

Taken from the deprecated ip_isr/examples/exampleUtils.py.

This is not guaranteed, given the distortion and pixel scale
listed in the afwTestUtils camera definition.

Returns
-------
wcs : `lsst.afw.geom.SkyWcs`
    Test WCS transform.

Definition at line 761 of file isrMock.py.

◆ localCoordToExpCoord()

lsst.ip.isr.isrMock.IsrMock.localCoordToExpCoord	(	self,
		ampData,
		x,
		y )

inherited

Convert between a local amplifier coordinate and the full
exposure coordinate.

Parameters
----------
ampData : `lsst.afw.image.ImageF`
    Amplifier image to use for conversions.
x : `int`
    X-coordinate of the point to transform.
y : `int`
    Y-coordinate of the point to transform.

Returns
-------
u : `int`
    Transformed x-coordinate.
v : `int`
    Transformed y-coordinate.

Notes
-----
The output is transposed intentionally here, to match the
internal transpose between numpy and afw.image coordinates.

Definition at line 778 of file isrMock.py.

◆ makeBfKernel()

lsst.ip.isr.isrMock.IsrMock.makeBfKernel ( self )

inherited

Generate a simple Gaussian brighter-fatter kernel.

Returns
-------
kernel : `numpy.ndarray`
    Simulated brighter-fatter kernel.

Reimplemented in lsst.ip.isr.isrMockLSST.IsrMockLSST.

Definition at line 401 of file isrMock.py.

◆ makeCrosstalkCoeff()

lsst.ip.isr.isrMock.IsrMock.makeCrosstalkCoeff ( self )

inherited

Generate the simulated crosstalk coefficients.

Returns
-------
coeffs : `numpy.ndarray`
    Simulated crosstalk coefficients.

Definition at line 438 of file isrMock.py.

◆ makeData()

lsst.ip.isr.isrMock.IsrMock.makeData ( self )

inherited

Generate simulated ISR data.

Currently, only the class defined crosstalk coefficient
matrix, brighter-fatter kernel, a constant unity transmission
curve, or a simple single-entry defect list can be generated.

Returns
-------
dataProduct :
    Simulated ISR data product.

Definition at line 361 of file isrMock.py.

◆ makeDefectList()

lsst.ip.isr.isrMock.IsrMock.makeDefectList ( self )

inherited

Generate a simple single-entry defect list.

Returns
-------
defectList : `lsst.meas.algorithms.Defects`
    Simulated defect list

Reimplemented in lsst.ip.isr.isrMockLSST.IsrMockLSST.

Definition at line 427 of file isrMock.py.

◆ makeDeferredChargeCalib()

lsst.ip.isr.isrMock.IsrMock.makeDeferredChargeCalib ( self )

inherited

Generate a CTI calibration.

Reimplemented in lsst.ip.isr.isrMockLSST.IsrMockLSST.

Definition at line 421 of file isrMock.py.

◆ makeElectrostaticBf()

lsst.ip.isr.isrMock.IsrMock.makeElectrostaticBf ( self )

inherited

Generate a simple Gaussian brighter-fatter kernel.

Returns
-------
kernel : `numpy.ndarray`
    Simulated brighter-fatter kernel.

Reimplemented in lsst.ip.isr.isrMockLSST.IsrMockLSST.

Definition at line 411 of file isrMock.py.

◆ makeImage()

lsst.ip.isr.isrMock.IsrMock.makeImage ( self )

inherited

Generate a simulated ISR image.

Returns
-------
exposure : `lsst.afw.image.Exposure` or `dict`
    Simulated ISR image data.

Notes
-----
This method currently constructs a "raw" data image by:

* Generating a simulated sky with noise
* Adding a single Gaussian "star"
* Adding the fringe signal
* Multiplying the frame by the simulated flat
* Adding dark current (and noise)
* Adding a bias offset (and noise)
* Adding an overscan gradient parallel to the pixel y-axis
* Simulating crosstalk by adding a scaled version of each
  amplifier to each other amplifier.

The exposure with image data constructed this way is in one of
three formats.

* A single image, with overscan and prescan regions retained
* A single image, with overscan and prescan regions trimmed
* A `dict`, containing the amplifer data indexed by the
  amplifier name.

The nonlinearity, CTE, and brighter fatter are currently not
implemented.

Note that this method generates an image in the reverse
direction as the ISR processing, as the output image here has
had a series of instrument effects added to an idealized
exposure.

Reimplemented in lsst.ip.isr.isrMockLSST.IsrMockLSST.

Definition at line 469 of file isrMock.py.

◆ makeLinearity()

lsst.ip.isr.isrMock.IsrMock.makeLinearity ( self )

inherited

Generate a linearity dataset.

Returns
-------
linearizer : `lsst.ip.isr.Linearizer`

Definition at line 460 of file isrMock.py.

◆ makeTransmissionCurve()

lsst.ip.isr.isrMock.IsrMock.makeTransmissionCurve ( self )

inherited

Generate a simulated flat transmission curve.

Returns
-------
transmission : `lsst.afw.image.TransmissionCurve`
    Simulated transmission curve.

Definition at line 449 of file isrMock.py.

◆ run()

lsst.ip.isr.isrMock.IsrMock.run ( self )

inherited

Generate a mock ISR product, and return it.

Returns
-------
image : `lsst.afw.image.Exposure`
    Simulated ISR image with signals added.
dataProduct :
    Simulated ISR data products.
None :
    Returned if no valid configuration was found.

Raises
------
RuntimeError
    Raised if both doGenerateImage and doGenerateData are specified.

Reimplemented in lsst.ip.isr.isrMockLSST.IsrMockLSST.

Definition at line 335 of file isrMock.py.

Member Data Documentation

◆ _DefaultName

str lsst.ip.isr.isrMock.IsrMock._DefaultName = "isrMock"

staticprotectedinherited

Definition at line 292 of file isrMock.py.

◆ _display

lsst.ip.isr.isrMock.IsrMock._display

protectedinherited

Definition at line 307 of file isrMock.py.

◆ aE

int lsst.ip.isr.isrMock.IsrMock.aE

inherited

Initial value:

=  np.array([[1., 0.5, 0.0125, 0., 0.],
                            [0.5, 0.010, 0., 0., 0.],
                            [0.0125, 0., 0., 0., 0.],
                            [0, 0., 0., 0., 0.]]) * -1e-7

Definition at line 327 of file isrMock.py.

◆ aN

int lsst.ip.isr.isrMock.IsrMock.aN

inherited

Initial value:

=  np.array([[1., 0.5, 0.0125, 0., 0.],
                            [0.5, 0.010, 0., 0., 0.],
                            [0.0125, 0., 0., 0., 0.],
                            [0, 0., 0., 0., 0.]]) * -1e-7

Definition at line 323 of file isrMock.py.

◆ aS

int lsst.ip.isr.isrMock.IsrMock.aS = self.aN

inherited

Definition at line 331 of file isrMock.py.

◆ aVector

tuple lsst.ip.isr.isrMock.IsrMock.aVector = (self.aN, self.aS, self.aE, self.aW)

inherited

Definition at line 333 of file isrMock.py.

◆ aW

int lsst.ip.isr.isrMock.IsrMock.aW = self.aE

inherited

Definition at line 332 of file isrMock.py.

◆ bfKernel

float lsst.ip.isr.isrMock.IsrMock.bfKernel

inherited

Initial value:

=  np.array([[1., 4., 7., 4., 1.],
                                  [4., 16., 26., 16., 4.],
                                  [7., 26., 41., 26., 7.],
                                  [4., 16., 26., 16., 4.],
                                  [1., 4., 7., 4., 1.]]) / 273.0

Definition at line 317 of file isrMock.py.

◆ ConfigClass

lsst.ip.isr.isrMock.IsrMock.ConfigClass = IsrMockConfig

staticinherited

Definition at line 291 of file isrMock.py.

◆ crosstalkCoeffs

lsst.ip.isr.isrMock.IsrMock.crosstalkCoeffs

inherited

Initial value:

=  np.array([[0.0, 0.0, 0.0, 0.0, 0.0, -1e-3, 0.0, 0.0],
                                         [1e-2, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
                                         [1e-2, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
                                         [1e-2, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
                                         [1e-2, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
                                         [1e-2, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
                                         [1e-2, 0.0, 0.0, 2.2e-2, 0.0, 0.0, 0.0, 0.0],
                                         [1e-2, 5e-3, 5e-4, 3e-3, 4e-2, 5e-3, 5e-3, 0.0]])

Definition at line 299 of file isrMock.py.

◆ rng

lsst.ip.isr.isrMock.IsrMock.rng = np.random.RandomState(self.config.rngSeed)

inherited

Definition at line 296 of file isrMock.py.

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

python/lsst/ip/isr/isrMock.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ amplifierAddFringe()

◆ amplifierAddNoise()

◆ amplifierAddSource()

◆ amplifierAddYGradient()

◆ amplifierMultiplyFlat()

◆ getCamera()

◆ getExposure()

◆ getWcs()

◆ localCoordToExpCoord()

◆ makeBfKernel()

◆ makeCrosstalkCoeff()

◆ makeData()

◆ makeDefectList()

◆ makeDeferredChargeCalib()

◆ makeElectrostaticBf()

◆ makeImage()

◆ makeLinearity()

◆ makeTransmissionCurve()

◆ run()

Member Data Documentation

◆ _DefaultName

◆ _display

◆ aE

◆ aN

◆ aS

◆ aVector

◆ aW

◆ bfKernel

◆ ConfigClass

◆ crosstalkCoeffs

◆ rng

◆ init()