bssunfold Documentation

bssunfold is a Python package for neutron spectrum unfolding using various algorithms.

Contents:

• Detector Class
  • Detector
• Unfold Methods
  • unfold_cvxpy()
  • unfold_landweber()
  • unfold_mlem()
  • unfold_qpsolvers()
  • unfold_doroshenko()
  • unfold_kaczmarz()
  • unfold_lmfit()
  • unfold_mlem_odl()
  • unfold_combined()
  • unfold_gravel()
  • unfold_maxed()
  • unfold_tikhonov_legendre()
  • unfold_bayes()
  • unfold_bayes_spline_regularization()
  • unfold_statreg()
  • unfold_scipy_direct_method()
  • unfold_tsvd()
• Core Functions
  • solve_cvxpy()
  • solve_landweber()
  • solve_mlem()
  • solve_qpsolvers()
  • solve_doroshenko()
  • solve_kaczmarz()
  • solve_lmfit()
  • solve_gravel()
  • solve_maxed()
  • solve_tikhonov_legendre()
  • solve_bayes()
  • solve_bayes_spline()
  • solve_statreg()
  • solve_scipy_direct()
  • solve_tsvd()
• Regularization Selection
  • select_regularization_parameter()
  • lcurve_selection()
  • gcv_selection()
  • discrepancy_principle_selection()
  • cosine_similarity_selection()
• Examples
  • Basic Usage

Indices and tables

• Index

• Module Index

• Search Page

Overview

BSSUnfold is a Python package for neutron spectrum unfolding from measurements obtained with Bonner Sphere Spectrometers (BSS). The package implements several mathematical algorithms for solving the inverse problem of unfolding neutron energy spectra from detector readings, with applications in radiation protection, nuclear physics research, and accelerator facilities.

Features

• Multiple Unfolding Algorithms (17 methods): - Tikhonov-type: CVXPY, qpsolvers (L1/L2/smoothness), Legendre basis, TSVD - Iterative: Landweber, MLEM (pure NumPy + ODL), GRAVEL, Doroshenko, Kaczmarz - Bayesian: D’Agostini (Bayes), Bayes with spline regularisation - Maximum Entropy: MAXED (primal log-space dual minimisation) - Statistical Regularisation: Turchin’s method (StatReg) - Optimisation-based: lmfit (L1/L2/Elastic Net), Scipy direct (CG, GMRES, LSQR) - Pipeline: Combined approach for chaining multiple methods

• Radiation Dose Calculations: - ICRP-116 conversion coefficients for effective dose

• Comprehensive Data Management: - Automatic response function processing - Uncertainty quantification via Monte Carlo methods

• Advanced Visualization: - Spectrum plotting with uncertainty bands - Detector reading comparisons