SegmentSimulator

class lsst.cp.pipe.SegmentSimulator(*args, **kwargs)

Bases: SegmentSimulator

Deprecated since version v28.0: lsst.cp.pipe.SegmentSimulator will be moved to lsst.ip.isr.deferredCharge.SegmentSimulator in v28.0.

Methods Summary

add_trap(serial_trap)

Add a trap to the serial register.

ramp_exp(signal_list)

Simulate an image with varying flux illumination per row.

readout([serial_overscan_width, ...])

Simulate serial readout of the segment image.

Methods Documentation

add_trap(serial_trap)

Add a trap to the serial register.

Parameters:
serial_traplsst.ip.isr.SerialTrap

The trap to add.

ramp_exp(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_listlist [float]

List of signal levels.

Raises:
ValueError

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

readout(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_widthint, optional

Number of serial overscan columns.

parallel_overscan_widthint, optional

Number of parallel overscan rows.

Returns:
resultnp.ndarray (nx, ny)

Simulated image, including serial prescan, serial overscan, and parallel overscan regions. Result in electrons.