lsst.ip.isr g16a4483606+e66ee75e0a
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.ip.isr.deferredCharge.DeferredChargeCalib Class Reference
Inheritance diagram for lsst.ip.isr.deferredCharge.DeferredChargeCalib:
lsst.ip.isr.calibType.IsrCalib

Public Member Functions

def __init__ (self, **kwargs)
 
def fromDetector (self, detector)
 
def fromDict (cls, dictionary)
 
def toDict (self)
 
def fromTable (cls, tableList)
 
def toTable (self)
 

Public Attributes

 driftScale
 
 decayTime
 
 globalCti
 
 serialTraps
 

Detailed Description

Calibration containing deferred charge/CTI parameters.

Parameters
----------
**kwargs :
    Additional parameters to pass to parent constructor.

Notes
-----
The charge transfer inefficiency attributes stored are:

driftScale : `dict` [`str`, `float`]
    A dictionary, keyed by amplifier name, of the local electronic
    offset drift scale parameter, A_L in Snyder+2021.
decayTime : `dict` [`str`, `float`]
    A dictionary, keyed by amplifier name, of the local electronic
    offset decay time, \tau_L in Snyder+2021.
globalCti : `dict` [`str`, `float`]
    A dictionary, keyed by amplifier name, of the mean global CTI
    paramter, b in Snyder+2021.
serialTraps : `dict` [`str`, `lsst.ip.isr.SerialTrap`]
    A dictionary, keyed by amplifier name, containing a single
    serial trap for each amplifier.

Definition at line 206 of file deferredCharge.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.ip.isr.deferredCharge.DeferredChargeCalib.__init__ (   self,
**  kwargs 
)

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 235 of file deferredCharge.py.

Member Function Documentation

◆ fromDetector()

def lsst.ip.isr.deferredCharge.DeferredChargeCalib.fromDetector (   self,
  detector 
)
Read metadata parameters from a detector.

Parameters
----------
detector : `lsst.afw.cameraGeom.detector`
    Input detector with parameters to use.

Returns
-------
calib : `lsst.ip.isr.Linearizer`
    The calibration constructed from the detector.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 244 of file deferredCharge.py.

◆ fromDict()

def lsst.ip.isr.deferredCharge.DeferredChargeCalib.fromDict (   cls,
  dictionary 
)
Construct a calibration from a dictionary of properties.

Parameters
----------
dictionary : `dict`
    Dictionary of properties.

Returns
-------
calib : `lsst.ip.isr.CalibType`
    Constructed calibration.

Raises
------
RuntimeError
    Raised if the supplied dictionary is for a different
    calibration.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 261 of file deferredCharge.py.

◆ fromTable()

def lsst.ip.isr.deferredCharge.DeferredChargeCalib.fromTable (   cls,
  tableList 
)
Construct calibration from a list of tables.

This method uses the ``fromDict`` method to create the
calibration, after constructing an appropriate dictionary from
the input tables.

Parameters
----------
tableList : `list` [`lsst.afw.table.Table`]
    List of tables to use to construct the crosstalk
    calibration.  Two tables are expected in this list, the
    first containing the per-amplifier CTI parameters, and the
    second containing the parameters for serial traps.

Returns
-------
calib : `lsst.ip.isr.DeferredChargeCalib`
    The calibration defined in the tables.

Raises
------
ValueError
    Raised if the trap type or trap coefficients are not
    defined properly.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 330 of file deferredCharge.py.

◆ toDict()

def lsst.ip.isr.deferredCharge.DeferredChargeCalib.toDict (   self)
Return a dictionary containing the calibration properties.
The dictionary should be able to be round-tripped through
``fromDict``.

Returns
-------
dictionary : `dict`
    Dictionary of properties.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 300 of file deferredCharge.py.

◆ toTable()

def lsst.ip.isr.deferredCharge.DeferredChargeCalib.toTable (   self)
Construct a list of tables containing the information in this
calibration.

The list of tables should create an identical calibration
after being passed to this class's fromTable method.

Returns
-------
tableList : `list` [`lsst.afw.table.Table`]
    List of tables containing the crosstalk calibration
    information.  Two tables are generated for this list, the
    first containing the per-amplifier CTI parameters, and the
    second containing the parameters for serial traps.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 425 of file deferredCharge.py.

Member Data Documentation

◆ decayTime

lsst.ip.isr.deferredCharge.DeferredChargeCalib.decayTime

Definition at line 237 of file deferredCharge.py.

◆ driftScale

lsst.ip.isr.deferredCharge.DeferredChargeCalib.driftScale

Definition at line 236 of file deferredCharge.py.

◆ globalCti

lsst.ip.isr.deferredCharge.DeferredChargeCalib.globalCti

Definition at line 238 of file deferredCharge.py.

◆ serialTraps

lsst.ip.isr.deferredCharge.DeferredChargeCalib.serialTraps

Definition at line 239 of file deferredCharge.py.


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