Public Member Functions
	__init__ (self, imarr, prescan_width, output_amplifier, cti=0.0, traps=None)

	add_trap (self, serial_trap)

	ramp_exp (self, signal_list)

	readout (self, serial_overscan_width=10, parallel_overscan_width=0)

Public Attributes
]+=ramp	prescan_width = prescan_width

	ny

	nx = imarr.shape

	segarr = np.zeros((self.ny, self.nx+prescan_width))

	output_amplifier = output_amplifier

	cti = cti

list	serial_traps = None

bool	do_trapping = False

Detailed Description

Controls the creation of simulated segment images.

Parameters
----------
imarr : `np.ndarray` (nx, ny)
    Image data array.
prescan_width : `int`
    Number of serial prescan columns.
output_amplifier : `lsst.cp.pipe.FloatingOutputAmplifier`
    An object holding some deferred charge parameters.
cti : `float`
    Global CTI value.
traps : `list` [`lsst.ip.isr.SerialTrap`]
    Serial traps to simulate.

Definition at line 505 of file deferredCharge.py.

Constructor & Destructor Documentation

◆ init()

lsst.ip.isr.deferredCharge.SegmentSimulator.__init__	(	self,
		imarr,
		prescan_width,
		output_amplifier,
		cti = 0.0,
		traps = None )

Definition at line 522 of file deferredCharge.py.

Member Function Documentation

◆ add_trap()

lsst.ip.isr.deferredCharge.SegmentSimulator.add_trap	(		self,
			serial_trap )

Add a trap to the serial register.

Parameters
----------
serial_trap : `lsst.ip.isr.SerialTrap`
    The trap to add.

Definition at line 544 of file deferredCharge.py.

◆ ramp_exp()

lsst.ip.isr.deferredCharge.SegmentSimulator.ramp_exp	(		self,
			signal_list )

Simulate an image with varying flux illumination per row.

This method simulates a segment image where the signal level
increases along the horizontal direction, according to the
provided list of signal levels.

Parameters
----------
signal_list : `list` [`float`]
    List of signal levels.

Raises
------
ValueError
    Raised if the length of the signal list does not equal the
    number of rows.

Definition at line 558 of file deferredCharge.py.

◆ readout()

lsst.ip.isr.deferredCharge.SegmentSimulator.readout	(	self,
		serial_overscan_width = 10,
		parallel_overscan_width = 0 )

Simulate serial readout of the segment image.

This method performs the serial readout of a segment image
given the appropriate SerialRegister object and the properties
of the ReadoutAmplifier.  Additional arguments can be provided
to account for the number of desired overscan transfers. The
result is a simulated final segment image, in ADU.

Parameters
----------
serial_overscan_width : `int`, optional
    Number of serial overscan columns.
parallel_overscan_width : `int`, optional
    Number of parallel overscan rows.

Returns
-------
result : `np.ndarray` (nx, ny)
    Simulated image, including serial prescan, serial
    overscan, and parallel overscan regions. Result in electrons.

Definition at line 582 of file deferredCharge.py.

Member Data Documentation

◆ cti

lsst.ip.isr.deferredCharge.SegmentSimulator.cti = cti

Definition at line 534 of file deferredCharge.py.

◆ do_trapping

bool lsst.ip.isr.deferredCharge.SegmentSimulator.do_trapping = False

Definition at line 537 of file deferredCharge.py.

◆ nx

lsst.ip.isr.deferredCharge.SegmentSimulator.nx = imarr.shape

Definition at line 525 of file deferredCharge.py.

◆ ny

lsst.ip.isr.deferredCharge.SegmentSimulator.ny

Definition at line 525 of file deferredCharge.py.

◆ output_amplifier

lsst.ip.isr.deferredCharge.SegmentSimulator.output_amplifier = output_amplifier

Definition at line 531 of file deferredCharge.py.

◆ prescan_width

lsst.ip.isr.deferredCharge.SegmentSimulator.prescan_width = prescan_width

Definition at line 524 of file deferredCharge.py.

◆ segarr

lsst.ip.isr.deferredCharge.SegmentSimulator.segarr = np.zeros((self.ny, self.nx+prescan_width))

Definition at line 527 of file deferredCharge.py.

◆ serial_traps

list lsst.ip.isr.deferredCharge.SegmentSimulator.serial_traps = None

Definition at line 536 of file deferredCharge.py.

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

python/lsst/ip/isr/deferredCharge.py

Public Member Functions

Public Attributes