ApproxSurvivor¶

class dcprogs.likelihood.ApproxSurvivor(*args, **kwargs)¶

Computes approximate missed-event survivor function.

__init__(*args, **kwargs)¶

Initializes the approximate survivor function.

There are three possible ways to instantiate this object:

>>> ApproxSurvivor(determinant_af, roots_af, determinant_fa, roots_fa)
>>> ApproxSurvivor(matrix, nopen, tau, **kwargs)
>>> ApproxSurvivor(qmatrix, tau, **kwargs)

The parameters between brackets are optional. The last two versions will try and calculate the roots of the determinant equations automatically. A number of parameters can be given to control this process. The keyword arguments are listed below.

Parameters:

Parameters:	determinant_af – A `DeterminantEq` instance, specifically for the af block. roots_af – The roots of the af determinant equation. The should come in the format [(root, multiplicity), (root, multiplicity), ...]. determinant_fa – A `DeterminantEq` instance, specifically for the fa block. It should the transpose of determinant_af. It is required so it need not be recomputed, since it most likely already exists. roots_fa – The roots of the fa determinant equation. The should come in the format [(root, multiplicity), (root, multiplicity), ...]. matrix – An object convertible to a square matrix. nopen (integer) – Number of open states. qmatrix – A `QMatrix` instance. xtol (float) – Tolerance criteria when computing roots using `brentq()`. Defaults to 1e-12. rtol (float) – Tolerance criteria when computing roots using `brentq()`. Defaults to 1e-12. itermax (float) – Maximum number of iterations when computing roots using `brentq()`. Defaults to 100. lower_bound (float) – Lower bound for all roots. Defaults to None, in which the case the lower bound is computed from `find_lower_bound_for_roots()`. upper_bound (float) – Upper bound for all roots. Defaults to None, in which the case the upper bound is computed from `find_upper_bound_for_roots()`.

determinant_af – A DeterminantEq instance, specifically for the af block.
roots_af – The roots of the af determinant equation. The should come in the format [(root, multiplicity), (root, multiplicity), ...].
determinant_fa – A DeterminantEq instance, specifically for the fa block. It should the transpose of determinant_af. It is required so it need not be recomputed, since it most likely already exists.
roots_fa – The roots of the fa determinant equation. The should come in the format [(root, multiplicity), (root, multiplicity), ...].
matrix – An object convertible to a square matrix.
nopen (integer) – Number of open states.
qmatrix – A QMatrix instance.
xtol (float) – Tolerance criteria when computing roots using brentq(). Defaults to 1e-12.
rtol (float) – Tolerance criteria when computing roots using brentq(). Defaults to 1e-12.
itermax (float) – Maximum number of iterations when computing roots using brentq(). Defaults to 100.
lower_bound (float) – Lower bound for all roots. Defaults to None, in which the case the lower bound is computed from find_lower_bound_for_roots().
upper_bound (float) – Upper bound for all roots. Defaults to None, in which the case the upper bound is computed from find_upper_bound_for_roots().

__weakref__¶: list of weak references to the object (if defined)

af(*args)¶: Open to close transitions Open to close transitions

af_components¶: Coefficient and exponents of the exponentials

fa(*args)¶: Closed to open transitions Closed to open transitions

fa_components¶: Coefficient and exponents of the exponentials

DCProgs 0.9 documentation

ApproxSurvivor

ApproxSurvivor¶