Skip to content

Configuration Reference

github-actions[bot] edited this page Jul 20, 2026 · 1 revision

Configuration Reference

All defaults live in flimkit/configs.py and can be overridden via CLI args or the GUI.

Fitting Defaults

Parameter Default Description
Tau_min 0.145 ns Lower lifetime bound
Tau_max 45.0 ns Upper lifetime bound
n_exp 3 Number of exponential components
D_mode 'both' Fitting mode: 'summed', 'perPixel', or 'both'
binning_factor 1 Spatial binning for per-pixel fitting
Optimizer 'de' 'de' (Differential Evolution) or 'lm_multistart'
MIN_PHOTONS_PERPIX 10 Minimum photons for per-pixel fitting
OUT_NAME 'flim_out' Default output prefix

Phasor Filtering Defaults

Parameter Default Description
PHASOR_FILTER None Filter method: 'gaussian', 'median', 'wavelet', or None
PHASOR_FILTER_SIGMA 1.0 Gaussian σ in pixels
PHASOR_FILTER_SIZE 3 Median filter kernel size (pixels)
PHASOR_FILTER_WAVELET 'db4' Wavelet family for wavelet denoising
PHASOR_FILTER_LEVEL 1 Wavelet decomposition level

Optimiser Settings

Parameter Default Description
lm_restarts 8 Levenberg-Marquardt multi-start restarts
de_population 30 DE population size
de_maxiter 5000 DE maximum iterations
n_workers -1 (source) / 1 (compiled) CPU cores for DE; capped at 1 in the compiled app to avoid multiprocessing issues

Display Range Settings

Pixel values outside the range are clamped to the boundary, not zeroed.

Parameter Default Description
TAU_DISPLAY_MIN None Min lifetime (ns) for tau images
TAU_DISPLAY_MAX None Max lifetime (ns) for tau images
INTENSITY_DISPLAY_MIN None Min photon count for intensity images
INTENSITY_DISPLAY_MAX None Max photon count for intensity images

Machine IRF Settings

Parameter Default Description
MACHINE_IRF_DIR flimkit/machine_irf (source) / ~/.flimkit/machine_irf (compiled) Storage directory
MACHINE_IRF_DEFAULT_PATH User copy if present, else bundled default Resolved at startup
MACHINE_IRF_ALIGN_ANCHOR 'peak' Alignment landmark during IRF construction
MACHINE_IRF_REDUCER 'median' Aggregation method across paired IRFs
MACHINE_IRF_FIT_STRATEGY 'fixed' Runtime fitting strategy
MACHINE_IRF_FIT_BG True Fit background offset
MACHINE_IRF_FIT_SIGMA False Fit Gaussian broadening
MACHINE_IRF_FIT_TAIL False Fit exponential tail

Cost Functions

Function Description
poisson Poisson deviance (C-statistic). Recommended
chi2 Neyman chi-squared (legacy)

Clone this wiki locally