lsst.ip.isr gb23b769143+23540ee355
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Static Protected Attributes | List of all members
lsst.ip.isr.isrMockLSST.IsrMockLSST Class Reference
Inheritance diagram for lsst.ip.isr.isrMockLSST.IsrMockLSST:
lsst.ip.isr.isrMock.IsrMock lsst.ip.isr.isrMockLSST.BfKernelMockLSST lsst.ip.isr.isrMockLSST.CrosstalkCoeffMockLSST lsst.ip.isr.isrMockLSST.DefectMockLSST lsst.ip.isr.isrMockLSST.RawMockLSST lsst.ip.isr.isrMockLSST.ReferenceMockLSST lsst.ip.isr.isrMockLSST.TransmissionMockLSST lsst.ip.isr.isrMockLSST.CalibratedRawMockLSST lsst.ip.isr.isrMockLSST.TrimmedRawMockLSST lsst.ip.isr.isrMockLSST.BiasMockLSST lsst.ip.isr.isrMockLSST.DarkMockLSST lsst.ip.isr.isrMockLSST.FlatMockLSST lsst.ip.isr.isrMockLSST.FringeMockLSST

Public Member Functions

 __init__ (self, **kwargs)
 
 run (self)
 
 makeImage (self)
 
 applyGain (self, ampData, gain)
 
 amplifierAddXGradient (self, ampData, start, end)
 

Static Public Attributes

 ConfigClass = IsrMockLSSTConfig
 

Static Protected Attributes

str _DefaultName = "isrMockLSST"
 

Detailed Description

Class to generate consistent mock images for ISR testing.

ISR testing currently relies on one-off fake images that do not
accurately mimic the full set of detector effects. This class
uses the test camera/detector/amplifier structure defined in
`lsst.afw.cameraGeom.testUtils` to avoid making the test data
dependent on any of the actual obs package formats.

Definition at line 72 of file isrMockLSST.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.ip.isr.isrMockLSST.IsrMockLSST.__init__ ( self,
** kwargs )

Member Function Documentation

◆ amplifierAddXGradient()

lsst.ip.isr.isrMockLSST.IsrMockLSST.amplifierAddXGradient ( self,
ampData,
start,
end )
Add a x-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 290 of file isrMockLSST.py.

◆ applyGain()

lsst.ip.isr.isrMockLSST.IsrMockLSST.applyGain ( self,
ampData,
gain )
Apply gain to the amplifier's data.
This method divides the data by the gain
because the mocks need to convert the data in electron to ADU,
so it does the inverse operation to applyGains in isrFunctions.

Parameters
----------
ampData : `lsst.afw.image.ImageF`
    Amplifier image to operate on.
gain : `float`
    Gain value in e^-/DN.

Definition at line 274 of file isrMockLSST.py.

◆ makeImage()

lsst.ip.isr.isrMockLSST.IsrMockLSST.makeImage ( self)
Generate a simulated ISR LSST image.

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

Notes
-----
This method constructs a "raw" data image.

Reimplemented from lsst.ip.isr.isrMock.IsrMock.

Definition at line 114 of file isrMockLSST.py.

◆ run()

lsst.ip.isr.isrMockLSST.IsrMockLSST.run ( self)
Generate a mock ISR product following LSSTCam ISR, 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 from lsst.ip.isr.isrMock.IsrMock.

Definition at line 88 of file isrMockLSST.py.

Member Data Documentation

◆ _DefaultName

str lsst.ip.isr.isrMockLSST.IsrMockLSST._DefaultName = "isrMockLSST"
staticprotected

Definition at line 82 of file isrMockLSST.py.

◆ ConfigClass

lsst.ip.isr.isrMockLSST.IsrMockLSST.ConfigClass = IsrMockLSSTConfig
static

Definition at line 81 of file isrMockLSST.py.


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