Skip to content

detection_registry.py

Registry of single-particle detection threshold methods.


Constants

Name Value
_BY_ID {}
_ORDER []
DEFAULT_METHOD_ID 'Poisson'

Classes

DetectionMethod

One detection method: metadata plus the numeric hooks the engine calls.

Method Signature Description
__init__ (self, id, label, *, is_manual=False, user_selectable=True, single, ar
single_threshold (self, engine, lambda_bkgd, alpha, sigma) Threshold for a single background value.
array_threshold (self, engine, lambda_bkgd_array, alpha, sigma) Threshold for an array of background values (moving window).
__repr__ (self)

Functions

Function Signature Description
_poisson_single (engine, lam, alpha, sigma) 3-sigma Poisson threshold (unclipped) — the historic else fallback.
_poisson_array_clipped (method, engine, lam_arr, alpha, sigma) 3-sigma Poisson threshold over an array, clipping lambda at 1.
_manual_array (method, engine, lam_arr, alpha, sigma) Manual method over an array — historically routed through the Poisson
_analytic_interp_array (method, engine, lam_arr, alpha, sigma) Interpolated thresholds across the background range for analytic methods.
_cpln_lognormal_single (engine, lam, alpha, sigma) Analytic Compound Poisson Log-Normal threshold.
_cpln_table_single (engine, lam, alpha, sigma) Lookup-table Compound Poisson Log-Normal threshold (uses caller sigma).
register (method) Register a :class:DetectionMethod (returns it, for decorator-style use).
get (name) Return the method for name (a stored or label string).
all_methods () All registered methods in registration order.
selectable_labels () UI labels for the user-selectable methods, in registration order.