lsst.ip.isr g42cc332696+00e9feead4
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.ip.isr.isrStatistics.IsrStatisticsTask Class Reference
Inheritance diagram for lsst.ip.isr.isrStatistics.IsrStatisticsTask:

Public Member Functions

def __init__ (self, statControl=None, **kwargs)
 
def run (self, inputExp, ptc=None, overscanResults=None, **kwargs)
 
def measureCti (self, inputExp, overscans, gains)
 
def measureBanding (self, inputExp, overscans)
 
def measureProjectionStatistics (self, inputExp, overscans)
 

Static Public Member Functions

def makeKernel (kernelSize)
 

Public Attributes

 statControl
 
 statType
 

Static Public Attributes

 ConfigClass = IsrStatisticsTaskConfig
 

Detailed Description

Task to measure arbitrary statistics on ISR processed exposures.

The goal is to wrap a number of optional measurements that are
useful for calibration production and detector stability.

Definition at line 124 of file isrStatistics.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.ip.isr.isrStatistics.IsrStatisticsTask.__init__ (   self,
  statControl = None,
**  kwargs 
)

Definition at line 133 of file isrStatistics.py.

Member Function Documentation

◆ makeKernel()

def lsst.ip.isr.isrStatistics.IsrStatisticsTask.makeKernel (   kernelSize)
static
Make a boxcar smoothing kernel.

Parameters
----------
kernelSize : `int`
    Size of the kernel in pixels.

Returns
-------
kernel : `np.array`
    Kernel for boxcar smoothing.

Definition at line 302 of file isrStatistics.py.

◆ measureBanding()

def lsst.ip.isr.isrStatistics.IsrStatisticsTask.measureBanding (   self,
  inputExp,
  overscans 
)
Task to measure banding statistics.

Parameters
----------
inputExp : `lsst.afw.image.Exposure`
    Exposure to measure.
overscans : `list` [`lsst.pipe.base.Struct`]
    List of overscan results.  Expected fields are:

    ``imageFit``
        Value or fit subtracted from the amplifier image data
        (scalar or `lsst.afw.image.Image`).
    ``overscanFit``
        Value or fit subtracted from the overscan image data
        (scalar or `lsst.afw.image.Image`).
    ``overscanImage``
        Image of the overscan region with the overscan
        correction applied (`lsst.afw.image.Image`). This
        quantity is used to estimate the amplifier read noise
        empirically.

Returns
-------
outputStats : `dict` [`str`, [`dict` [`str`,`float]]
    Dictionary of measurements, keyed by amplifier name and
    statistics segment.

Definition at line 321 of file isrStatistics.py.

◆ measureCti()

def lsst.ip.isr.isrStatistics.IsrStatisticsTask.measureCti (   self,
  inputExp,
  overscans,
  gains 
)
Task to measure CTI statistics.

Parameters
----------
inputExp : `lsst.afw.image.Exposure`
    Exposure to measure.
overscans : `list` [`lsst.pipe.base.Struct`]
    List of overscan results.  Expected fields are:

    ``imageFit``
        Value or fit subtracted from the amplifier image data
        (scalar or `lsst.afw.image.Image`).
    ``overscanFit``
        Value or fit subtracted from the overscan image data
        (scalar or `lsst.afw.image.Image`).
    ``overscanImage``
        Image of the overscan region with the overscan
        correction applied (`lsst.afw.image.Image`). This
        quantity is used to estimate the amplifier read noise
        empirically.
gains : `dict` [`str` `float`]
    Dictionary of per-amplifier gains, indexed by amplifier name.

Returns
-------
outputStats : `dict` [`str`, [`dict` [`str`,`float]]
    Dictionary of measurements, keyed by amplifier name and
    statistics segment.

Definition at line 205 of file isrStatistics.py.

◆ measureProjectionStatistics()

def lsst.ip.isr.isrStatistics.IsrStatisticsTask.measureProjectionStatistics (   self,
  inputExp,
  overscans 
)
Task to measure metrics from image slicing.

Parameters
----------
inputExp : `lsst.afw.image.Exposure`
    Exposure to measure.
overscans : `list` [`lsst.pipe.base.Struct`]
    List of overscan results.  Expected fields are:

    ``imageFit``
        Value or fit subtracted from the amplifier image data
        (scalar or `lsst.afw.image.Image`).
    ``overscanFit``
        Value or fit subtracted from the overscan image data
        (scalar or `lsst.afw.image.Image`).
    ``overscanImage``
        Image of the overscan region with the overscan
        correction applied (`lsst.afw.image.Image`). This
        quantity is used to estimate the amplifier read noise
        empirically.

Returns
-------
outputStats : `dict` [`str`, [`dict` [`str`,`float]]
    Dictionary of measurements, keyed by amplifier name and
    statistics segment.

Definition at line 374 of file isrStatistics.py.

◆ run()

def lsst.ip.isr.isrStatistics.IsrStatisticsTask.run (   self,
  inputExp,
  ptc = None,
  overscanResults = None,
**  kwargs 
)
Task to run arbitrary statistics.

The statistics should be measured by individual methods, and
add to the dictionary in the return struct.

Parameters
----------
inputExp : `lsst.afw.image.Exposure`
    The exposure to measure.
ptc : `lsst.ip.isr.PtcDataset`, optional
    A PTC object containing gains to use.
overscanResults : `list` [`lsst.pipe.base.Struct`], optional
    List of overscan results.  Expected fields are:

    ``imageFit``
        Value or fit subtracted from the amplifier image data
        (scalar or `lsst.afw.image.Image`).
    ``overscanFit``
        Value or fit subtracted from the overscan image data
        (scalar or `lsst.afw.image.Image`).
    ``overscanImage``
        Image of the overscan region with the overscan
        correction applied (`lsst.afw.image.Image`). This
        quantity is used to estimate the amplifier read noise
        empirically.

Returns
-------
resultStruct : `lsst.pipe.base.Struct`
    Contains the measured statistics as a dict stored in a
    field named ``results``.

Raises
------
RuntimeError
    Raised if the amplifier gains could not be found.

Definition at line 139 of file isrStatistics.py.

Member Data Documentation

◆ ConfigClass

lsst.ip.isr.isrStatistics.IsrStatisticsTask.ConfigClass = IsrStatisticsTaskConfig
static

Definition at line 130 of file isrStatistics.py.

◆ statControl

lsst.ip.isr.isrStatistics.IsrStatisticsTask.statControl

Definition at line 135 of file isrStatistics.py.

◆ statType

lsst.ip.isr.isrStatistics.IsrStatisticsTask.statType

Definition at line 137 of file isrStatistics.py.


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