lsst.ip.isr g4b253454a0+03248f5ea1
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.ip.isr.deferredCharge.SerialTrap Class Reference

Public Member Functions

def __init__ (self, size, emission_time, pixel, trap_type, coeffs)
 
def __eq__ (self, other)
 
def trap_array (self)
 
def trapped_charge (self)
 
def initialize (self, ny, nx, prescan_width)
 
def release_charge (self)
 
def trap_charge (self, free_charge)
 
def capture (self, pixel_signals)
 

Public Attributes

 size
 
 emission_time
 
 pixel
 
 trap_type
 
 coeffs
 
 interp
 

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 36 of file deferredCharge.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 62 of file deferredCharge.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 95 of file deferredCharge.py.

◆ capture()

def 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 176 of file deferredCharge.py.

◆ initialize()

def 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 119 of file deferredCharge.py.

◆ release_charge()

def lsst.ip.isr.deferredCharge.SerialTrap.release_charge (   self)
Release charge through exponential decay.

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

Definition at line 144 of file deferredCharge.py.

◆ trap_array()

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

Definition at line 112 of file deferredCharge.py.

◆ trap_charge()

def 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 157 of file deferredCharge.py.

◆ trapped_charge()

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

Definition at line 116 of file deferredCharge.py.

Member Data Documentation

◆ coeffs

lsst.ip.isr.deferredCharge.SerialTrap.coeffs

Definition at line 78 of file deferredCharge.py.

◆ emission_time

lsst.ip.isr.deferredCharge.SerialTrap.emission_time

Definition at line 71 of file deferredCharge.py.

◆ interp

lsst.ip.isr.deferredCharge.SerialTrap.interp

Definition at line 90 of file deferredCharge.py.

◆ pixel

lsst.ip.isr.deferredCharge.SerialTrap.pixel

Definition at line 75 of file deferredCharge.py.

◆ size

lsst.ip.isr.deferredCharge.SerialTrap.size

Definition at line 65 of file deferredCharge.py.

◆ trap_type

lsst.ip.isr.deferredCharge.SerialTrap.trap_type

Definition at line 77 of file deferredCharge.py.


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