lsst.ip.isr.deferredCharge.SimulatedModel Class Reference

Inheritance diagram for lsst.ip.isr.deferredCharge.SimulatedModel:

Public Member Functions
	loglikelihood (self, params, signal, data, error, *args, **kwargs)
	negative_loglikelihood (self, params, signal, data, error, *args, **kwargs)
	rms_error (self, params, signal, data, error, *args, **kwargs)
	difference (self, params, signal, data, error, *args, **kwargs)

Static Public Member Functions
	model_results (params, signal, num_transfers, amp, start=1, stop=10, trap_type=None)

Detailed Description

Simulated overscan model.

Definition at line 434 of file deferredCharge.py.

Member Function Documentation

difference()

lsst.ip.isr.deferredCharge.OverscanModel.difference ( self, params, signal, data, error, * args, ** kwargs )

inherited

Calculate the flattened difference array between model and data.

Parameters
----------
params : `lmfit.Parameters`
    Object containing the model parameters.
signal : `np.ndarray`, (nMeasurements)
    Array of image means.
data : `np.ndarray`, (nMeasurements, nCols)
    Array of overscan column means from each measurement.
error : `float`
    Fixed error value.
*args :
    Additional position arguments.
**kwargs :
    Additional keyword arguments.

Returns
-------
difference : `np.ndarray`, (nMeasurements*nCols)
    The rms error between the model and input data.

Definition at line 348 of file deferredCharge.py.

loglikelihood()

lsst.ip.isr.deferredCharge.OverscanModel.loglikelihood ( self, params, signal, data, error, * args, ** kwargs )

inherited

Calculate log likelihood of the model.

Parameters
----------
params : `lmfit.Parameters`
    Object containing the model parameters.
signal : `np.ndarray`, (nMeasurements)
    Array of image means.
data : `np.ndarray`, (nMeasurements, nCols)
    Array of overscan column means from each measurement.
error : `float`
    Fixed error value.
*args :
    Additional position arguments.
**kwargs :
    Additional keyword arguments.

Returns
-------
logL : `float`
    The log-likelihood of the observed data given the model
    parameters.

Definition at line 259 of file deferredCharge.py.

model_results()

lsst.ip.isr.deferredCharge.SimulatedModel.model_results ( params, signal, num_transfers, amp, start = 1, stop = 10, trap_type = None )

static

Generate a realization of the overscan model, using the specified
fit parameters and input signal.

Parameters
----------
params : `lmfit.Parameters`
    Object containing the model parameters.
signal : `np.ndarray`, (nMeasurements)
    Array of image means.
num_transfers : `int`
    Number of serial transfers that the charge undergoes.
amp : `lsst.afw.cameraGeom.Amplifier`
    Amplifier to use for geometry information.
start : `int`, optional
    First overscan column to fit. This number includes the
    last imaging column, and needs to be adjusted by one when
    using the overscan bounding box.
stop : `int`, optional
    Last overscan column to fit. This number includes the
    last imaging column, and needs to be adjusted by one when
    using the overscan bounding box.
trap_type : `str`, optional
    Type of trap model to use.

Returns
-------
results : `np.ndarray`, (nMeasurements, nCols)
    Model results.

Reimplemented from lsst.ip.isr.deferredCharge.OverscanModel.

Definition at line 438 of file deferredCharge.py.

negative_loglikelihood()

lsst.ip.isr.deferredCharge.OverscanModel.negative_loglikelihood ( self, params, signal, data, error, * args, ** kwargs )

inherited

Calculate negative log likelihood of the model.

Parameters
----------
params : `lmfit.Parameters`
    Object containing the model parameters.
signal : `np.ndarray`, (nMeasurements)
    Array of image means.
data : `np.ndarray`, (nMeasurements, nCols)
    Array of overscan column means from each measurement.
error : `float`
    Fixed error value.
*args :
    Additional position arguments.
**kwargs :
    Additional keyword arguments.

Returns
-------
negativelogL : `float`
    The negative log-likelihood of the observed data given the
    model parameters.

Definition at line 290 of file deferredCharge.py.

rms_error()

lsst.ip.isr.deferredCharge.OverscanModel.rms_error ( self, params, signal, data, error, * args, ** kwargs )

inherited

Calculate RMS error between model and data.

Parameters
----------
params : `lmfit.Parameters`
    Object containing the model parameters.
signal : `np.ndarray`, (nMeasurements)
    Array of image means.
data : `np.ndarray`, (nMeasurements, nCols)
    Array of overscan column means from each measurement.
error : `float`
    Fixed error value.
*args :
    Additional position arguments.
**kwargs :
    Additional keyword arguments.

Returns
-------
rms : `float`
    The rms error between the model and input data.

Definition at line 318 of file deferredCharge.py.

---

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

• python/lsst/ip/isr/deferredCharge.py