pyfli.solver.forward_model#
Evaluate exponential decay kernels and convolved NumPy forward models.
This module belongs to pyfli.cm_funcs and is the single forward model shared by the
PyFLI solver, reconstruction, Laguerre, simulator and phasor packages. Public API includes
functions gate_integrated_kernel(), decay_kernel() and
model_numpy().
The decay is modelled as it is measured: photon counts per time gate. For a decay with
onset h_shift (ns), the expected counts in the gate [a, b) are the integral of
the normalized exponential over that gate,
mono: S * [exp(-(max(a, h) - h) / tau) - exp(-(max(b, h) - h) / tau)] bi: S * a1 * […tau1…] + S * (1 - a1) * […tau2…]
which is zero before the onset, continuous (piecewise smooth) in h_shift so a
sub-gate delay can be fitted with gradient-based optimizers, and sums to S over all
gates – S is the total number of photons of the decay (photon_count_map).
shift_method selects the convolution: "zero_pad" (default) convolves linearly,
with the decay zero before the onset and after the window; "circular" is the
steady-state periodic model for a window equal to one laser period (TCSPC/SPAD), where
earlier pulses’ tails wrap around
(pyfli.reconstruction.common_reconstruct.periodic_gate_integral() convolved by
pyfli.reconstruction.common_reconstruct.circular_convolve()).
excitation places the excitation of each IRF gate: "bin_start" (default) at the
gate start, as pyfli’s simulators do; "uniform" spread uniformly over the gate
[h, h + dt), as in a real instrument, i.e. the gate integral averaged over the onset.
gate_width (default dt) is the width of the detection gates that start every
dt; set it only when the IRF was not itself recorded through the same gate (a gated
IRF already contains the gate), e.g. for overlapping ICCD gates with a laser-pulse IRF.
Functions
|
Fraction of a unit-area exponential with onset h_shift inside |
|
|
|
|
|
|
|
|
|
Fraction of a unit-area exponential inside |
|
Steady-state periodic counterpart of |
|
|
|
Return (kernel, v_shift) on the gates starting at t. |
|
Fraction of the photons of a unit-area exponential (lifetime tau, onset h_shift) in the gate |
|
Expected counts per gate of the un-convolved decay, integrated over each gate. |
|
Evaluate the NumPy FLI forward model: the gate-integrated decay (onset |
|
Number of gates before |
|
Check excitation is one of |
|
Check gate_width is |
|
Check model_type is one of |
|
Check shift_method is in |