Public Member Functions
	__init__ (self, size, emission_time, pixel, trap_type, coeffs)

	__eq__ (self, other)

	trap_array (self)

	trapped_charge (self)

	initialize (self, ny, nx, prescan_width)

	release_charge (self)

	trap_charge (self, free_charge)

	capture (self, pixel_signals)

Public Attributes
	size = size

	emission_time = emission_time

	pixel = int(pixel)

str	trap_type = trap_type

	coeffs = coeffs

	interp

Protected Attributes
	_trap_array = None

	_trapped_charge = None

Detailed Description

Represents a serial register trap.

Parameters
----------
size : `float`
    Size of the charge trap, in electrons.
emission_time : `float`
    Trap emission time constant, in inverse transfers.
pixel : `int`
    Serial pixel location of the trap, including the prescan.
trap_type : `str`
    Type of trap capture to use.  Should be one of ``linear``,
    ``logistic``, or ``spline``.
coeffs : `list` [`float`]
    Coefficients for the capture process.  Linear traps need one
    coefficient, logistic traps need two, and spline based traps
    need to have an even number of coefficients that can be split
    into their spline locations and values.

Raises
------
ValueError
    Raised if the specified parameters are out of expected range.

Definition at line 47 of file deferredCharge.py.

Constructor & Destructor Documentation

◆ init()

lsst.ip.isr.deferredCharge.SerialTrap.__init__	(	self,
		size,
		emission_time,
		pixel,
		trap_type,
		coeffs )

Definition at line 73 of file deferredCharge.py.

Member Function Documentation

◆ eq()

lsst.ip.isr.deferredCharge.SerialTrap.__eq__	(		self,
			other )

Definition at line 113 of file deferredCharge.py.

◆ capture()

lsst.ip.isr.deferredCharge.SerialTrap.capture	(		self,
			pixel_signals )

Trap capture function.

Parameters
----------
pixel_signals : `list` [`float`]
    Input pixel values.

Returns
-------
captured_charge : `list` [`float`]
    Amount of charge captured from each pixel.

Raises
------
RuntimeError
    Raised if the trap type is invalid.

Definition at line 194 of file deferredCharge.py.

◆ initialize()

lsst.ip.isr.deferredCharge.SerialTrap.initialize	(	self,
		ny,
		nx,
		prescan_width )

Initialize trapping arrays for simulated readout.

Parameters
----------
ny : `int`
    Number of rows to simulate.
nx : `int`
    Number of columns to simulate.
prescan_width : `int`
    Additional transfers due to prescan.

Raises
------
ValueError
    Raised if the trap falls outside of the image.

Definition at line 137 of file deferredCharge.py.

◆ release_charge()

lsst.ip.isr.deferredCharge.SerialTrap.release_charge ( self )

Release charge through exponential decay.

Returns
-------
released_charge : `float`
    Charge released.

Definition at line 162 of file deferredCharge.py.

◆ trap_array()

lsst.ip.isr.deferredCharge.SerialTrap.trap_array ( self )

Definition at line 130 of file deferredCharge.py.

◆ trap_charge()

lsst.ip.isr.deferredCharge.SerialTrap.trap_charge	(		self,
			free_charge )

Perform charge capture using a logistic function.

Parameters
----------
free_charge : `float`
    Charge available to be trapped.

Returns
-------
captured_charge : `float`
    Amount of charge actually trapped.

Definition at line 175 of file deferredCharge.py.

◆ trapped_charge()

lsst.ip.isr.deferredCharge.SerialTrap.trapped_charge ( self )

Definition at line 134 of file deferredCharge.py.

Member Data Documentation

◆ _trap_array

lsst.ip.isr.deferredCharge.SerialTrap._trap_array = None

protected

Definition at line 110 of file deferredCharge.py.

◆ _trapped_charge

lsst.ip.isr.deferredCharge.SerialTrap._trapped_charge = None

protected

Definition at line 111 of file deferredCharge.py.

◆ coeffs

lsst.ip.isr.deferredCharge.SerialTrap.coeffs = coeffs

Definition at line 89 of file deferredCharge.py.

◆ emission_time

lsst.ip.isr.deferredCharge.SerialTrap.emission_time = emission_time

Definition at line 82 of file deferredCharge.py.

◆ interp

lsst.ip.isr.deferredCharge.SerialTrap.interp

Initial value:

=  interp.interp1d(
                centers,
                values,
                bounds_error=False,
                fill_value=(values[0], values[-1]),
            )

Definition at line 103 of file deferredCharge.py.

◆ pixel

lsst.ip.isr.deferredCharge.SerialTrap.pixel = int(pixel)

Definition at line 86 of file deferredCharge.py.

◆ size

lsst.ip.isr.deferredCharge.SerialTrap.size = size

Definition at line 76 of file deferredCharge.py.

◆ trap_type

lsst.ip.isr.deferredCharge.SerialTrap.trap_type = trap_type

Definition at line 88 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

Protected Attributes