lsst.cp.pipe  20.0.0-16-g6fe20a1+a77778c47d
Public Member Functions | List of all members
lsst.cp.pipe.ptc.PhotonTransferCurveDataset Class Reference

Public Member Functions

def __init__ (self, ampNames, ptcFitType)
 
def __setattr__ (self, attribute, value)
 
def getExpIdsUsed (self, ampName)
 
def getGoodAmps (self)
 

Detailed Description

A simple class to hold the output data from the PTC task.

The dataset is made up of a dictionary for each item, keyed by the
amplifiers' names, which much be supplied at construction time.

New items cannot be added to the class to save accidentally saving to the
wrong property, and the class can be frozen if desired.

inputExpIdPairs records the exposures used to produce the data.
When fitPtc() or fitCovariancesAstier() is run, a mask is built up, which is by definition
always the same length as inputExpIdPairs, rawExpTimes, rawMeans
and rawVars, and is a list of bools, which are incrementally set to False
as points are discarded from the fits.

PTC fit parameters for polynomials are stored in a list in ascending order
of polynomial term, i.e. par[0]*x^0 + par[1]*x + par[2]*x^2 etc
with the length of the list corresponding to the order of the polynomial
plus one.

Parameters
----------
ampNames : `list`
    List with the names of the amplifiers of the detector at hand.

ptcFitType : `str`
    Type of model fitted to the PTC: "POLYNOMIAL", "EXPAPPROXIMATION", or "FULLCOVARIANCE".

Returns
-------
`lsst.cp.pipe.ptc.PhotonTransferCurveDataset`
    Output dataset from MeasurePhotonTransferCurveTask.

Definition at line 180 of file ptc.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.cp.pipe.ptc.PhotonTransferCurveDataset.__init__ (   self,
  ampNames,
  ptcFitType 
)

Definition at line 214 of file ptc.py.

Member Function Documentation

◆ __setattr__()

def lsst.cp.pipe.ptc.PhotonTransferCurveDataset.__setattr__ (   self,
  attribute,
  value 
)
Protect class attributes

Definition at line 260 of file ptc.py.

◆ getExpIdsUsed()

def lsst.cp.pipe.ptc.PhotonTransferCurveDataset.getExpIdsUsed (   self,
  ampName 
)
Get the exposures used, i.e. not discarded, for a given amp.

If no mask has been created yet, all exposures are returned.

Definition at line 268 of file ptc.py.

◆ getGoodAmps()

def lsst.cp.pipe.ptc.PhotonTransferCurveDataset.getGoodAmps (   self)

Definition at line 284 of file ptc.py.


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