lsst.ip.isr g06d8191974+de063e15a7
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Protected Attributes | List of all members
lsst.ip.isr.photodiode.PhotodiodeCalib Class Reference
Inheritance diagram for lsst.ip.isr.photodiode.PhotodiodeCalib:
lsst.ip.isr.calibType.IsrCalib

Public Member Functions

 __init__ (self, timeSamples=None, currentSamples=None, **kwargs)
 
 fromDict (cls, dictionary)
 
 toDict (self)
 
 fromTable (cls, tableList)
 
 toTable (self)
 
 readTwoColumnPhotodiodeData (cls, filename)
 
 integrate (self)
 
 integrateDirectSum (self)
 
 integrateTrimmedSum (self)
 
 integrateChargeSum (self)
 

Public Attributes

 timeSamples
 
 currentSamples
 
 integrationMethod
 
 currentScale
 

Static Protected Attributes

str _OBSTYPE = 'PHOTODIODE'
 
str _SCHEMA = 'Photodiode'
 
float _VERSION = 1.0
 

Detailed Description

Independent current measurements from photodiode for linearity
calculations.

Parameters
----------
timeSamples : `list` or `numpy.ndarray`
    List of samples the photodiode was measured at.
currentSamples : `list` or `numpy.ndarray`
    List of current measurements at each time sample.
log : `lsst.log.Log`, optional
    Log to write messages to.
**kwargs :
    Additional parameters. These will be passed to the parent
    constructor with the exception of:

    ``"integrationMethod"``
        Name of the algorithm to use to integrate the current
        samples. Allowed values are ``DIRECT_SUM``,
        ``TRIMMED_SUM``, and ``CHARGE_SUM`` (`str`).
    ``"currentScale"``
        Scale factor to apply to the current samples for the
        ``CHARGE_SUM`` integration method. A typical value
        would be `-1`, to flip the sign of the integrated charge.

Definition at line 33 of file photodiode.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.ip.isr.photodiode.PhotodiodeCalib.__init__ ( self,
timeSamples = None,
currentSamples = None,
** kwargs )

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

Definition at line 63 of file photodiode.py.

Member Function Documentation

◆ fromDict()

lsst.ip.isr.photodiode.PhotodiodeCalib.fromDict ( cls,
dictionary )
Construct a PhotodiodeCalib from a dictionary of properties.

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

Returns
-------
calib : `lsst.ip.isr.PhotodiodeCalib`
    Constructed photodiode data.

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

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

Definition at line 94 of file photodiode.py.

◆ fromTable()

lsst.ip.isr.photodiode.PhotodiodeCalib.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` [`astropy.table.Table`]
    List of tables to use to construct the crosstalk
    calibration.

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

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

Definition at line 152 of file photodiode.py.

◆ integrate()

lsst.ip.isr.photodiode.PhotodiodeCalib.integrate ( self)
Integrate the current.

Raises
------
RuntimeError
    Raised if the integration method is not known.

Definition at line 231 of file photodiode.py.

◆ integrateChargeSum()

lsst.ip.isr.photodiode.PhotodiodeCalib.integrateChargeSum ( self)
For this method, the values in .currentSamples are actually the
integrated charge values as measured by the ammeter for each
sampling interval.  We need to do a baseline subtraction,
based on the charge values when the LED is off, then sum up
the corrected signals.

Returns
-------
sum : `float`
    Total charge measured.

Definition at line 280 of file photodiode.py.

◆ integrateDirectSum()

lsst.ip.isr.photodiode.PhotodiodeCalib.integrateDirectSum ( self)
Integrate points.

This uses numpy's trapezoidal integrator.

Returns
-------
sum : `float`
    Total charge measured.

Definition at line 248 of file photodiode.py.

◆ integrateTrimmedSum()

lsst.ip.isr.photodiode.PhotodiodeCalib.integrateTrimmedSum ( self)
Integrate points with a baseline level subtracted.

This uses numpy's trapezoidal integrator.

Returns
-------
sum : `float`
    Total charge measured.

See Also
--------
lsst.eotask.gen3.eoPtc

Definition at line 260 of file photodiode.py.

◆ readTwoColumnPhotodiodeData()

lsst.ip.isr.photodiode.PhotodiodeCalib.readTwoColumnPhotodiodeData ( cls,
filename )
Construct a PhotodiodeCalib by reading the simple column format.

Parameters
----------
filename : `str`
    File to read samples from.

Returns
-------
calib : `lsst.ip.isr.PhotodiodeCalib`
    The calibration defined in the file.

Definition at line 207 of file photodiode.py.

◆ toDict()

lsst.ip.isr.photodiode.PhotodiodeCalib.toDict ( self)
Return a dictionary containing the photodiode 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 128 of file photodiode.py.

◆ toTable()

lsst.ip.isr.photodiode.PhotodiodeCalib.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` [`astropy.table.Table`]
    List of tables containing the photodiode calibration
    information.

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

Definition at line 182 of file photodiode.py.

Member Data Documentation

◆ _OBSTYPE

str lsst.ip.isr.photodiode.PhotodiodeCalib._OBSTYPE = 'PHOTODIODE'
staticprotected

Definition at line 59 of file photodiode.py.

◆ _SCHEMA

str lsst.ip.isr.photodiode.PhotodiodeCalib._SCHEMA = 'Photodiode'
staticprotected

Definition at line 60 of file photodiode.py.

◆ _VERSION

float lsst.ip.isr.photodiode.PhotodiodeCalib._VERSION = 1.0
staticprotected

Definition at line 61 of file photodiode.py.

◆ currentSamples

lsst.ip.isr.photodiode.PhotodiodeCalib.currentSamples

Definition at line 69 of file photodiode.py.

◆ currentScale

lsst.ip.isr.photodiode.PhotodiodeCalib.currentScale

Definition at line 82 of file photodiode.py.

◆ integrationMethod

lsst.ip.isr.photodiode.PhotodiodeCalib.integrationMethod

Definition at line 77 of file photodiode.py.

◆ timeSamples

lsst.ip.isr.photodiode.PhotodiodeCalib.timeSamples

Definition at line 68 of file photodiode.py.


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