TDCRPy 1.8.14__py3-none-any.whl → 1.8.15__py3-none-any.whl

{TDCRPy-1.8.14.dist-info → TDCRPy-1.8.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: TDCRPy
-Version: 1.8.14
+Version: 1.8.15
 Summary: TDCR model
 Home-page: https://pypi.org/project/TDCRPy/
 Author: RomainCoulon (Romain Coulon)
@@ -30,7 +30,7 @@ Requires-Dist: matplotlib
 
 # TDCRPy
 
-`TDCRPy` is a Python code to calculate detection efficiency of a liquide scintillation counter using 3-photomultiplier tubes.
+`TDCRPy` is a Python code to calculate detection efficiency of a liquid scintillation counter using 3-photomultiplier tubes.
 The calculation is based on the photo-physical model called of the Triple-to-Double-Coincidence-Ratio method (TDCR) and a Monte-Carlo sampling allowing to adress complexe decay schemes and radionuclide mixtures.
 
 The code is developped and maintained by the BIPM (MIT license).
@@ -88,111 +88,6 @@ At first, the TDCRPy module must be imported.
 ```python
 import tdcrpy
 ```
-
-### TDCRoptimize.eff()
-
-In practice, `TDCRoptimize.eff()` is the fonction used to estimate the counting efficiency of a TDCR system. It approximates the free parameter(s) `L` in order to minimize the residual estimated by `TDCRPy()` for a given set of measurement data. In `mode2 = "sym"`, the *golden section search technique* is applied with a maximum number of iterations of 20. In `mode2 = "asym"`, the *Nelder-Mead technique* is applied with a maximum number of iterations of 20.
-
-`TDCRoptimize.eff()` is parametrised by the following parameters:
-*  `TD` (type `float`) is the quotient of the triple coincidence count rate divided by the logic sum of the double coincidence count rate.
-*  `TAB` (type `float`) is the quotient of the triple coincidence count rate divided by the double coincidence count rate between the channel A and B.
-*  `TBC` (type `float`) is the quotient of the triple coincidence count rate divided by the double coincidence count rate between the channel B and C.
-*  `TAC` (type `float`) is the quotient of the triple coincidence count rate divided by the double coincidence count rate between the channel A and C.
-*  `rad` (type `string`) is the list of radionuclides contained in the solution, e.g. `"H-3"`, `"H-3, Co-60"`.
-*  `pmf_1` (type `string`) is the probability of each radionuclide contained in `rad`. If `rad = "H-3, Co-60"` and `pmf_1="0.8, 0.2"`, the solution contains 80 % of tritium and 20 % of cobalt 60.
-*  `kB` (type `float`) is the Birks constant caracterizing the scintillator. It is espressed in cm/keV.
-*  `V` (type `float`) is the volume in ml of the scintillator.
-*  `mode2` sets whether the TDCR system has to be considered symetrical `mode2="sym"` or not symetrical `mode2="asym"`.
-*  `N` (type `integer`) is the number of Monte-Carlo trials corresponding each, to a simulated nuclear decay in the scintillator. Monte-Carlo calculation is not used in the case of pure beta emitting radionuclides where the analytical model is implemented. It is an optional parameter set by default at `N = 10000`.
-*  `L` (type `float`) initial guess of the free parameter(s) in keV^-1^. It represents the number of photoelectrons produced by the PMTs per unit of ionisation energy released in the scintillator during a decay and in the abscence of scintillation quenching. It is set by default at `L = 1`.
-
-`TDCRoptimize.eff()` returns:
-*  the global free parameter *L*,
-*  the free parameters related to each channel (*L<sub>A</sub>*, *L<sub>B</sub>*, *L<sub>C</sub>*),
-*  the estimation of the counting efficiency of single events *S*,
-*  the standard uncertainty of the estimation of *S*,
-*  the estimation of the counting efficiency of double coincidences *D*,
-*  the standard uncertainty of the estimation of *D*,
-*  the estimation of the counting efficiency of triple coincidences *T*,
-*  the standard uncertainty of the estimation of *T*.
-
-Example with `mode2 = "sym"`: 
-
-```python
-import tdcrpy
-
-TD = 0.977667386529166
-TAB = 0.992232838598821
-TBC = 0.992343419459002
-TAC = 0.99275350064608
-Rad="Co-60"
-pmf_1="1"
-N = 250
-kB =1.0e-5
-V = 10
-mode2 = "sym"
-
-result = tdcrpy.TDCRoptimize.eff(TD, TAB, TBC, TAC, Rad, pmf_1, kB, V, mode2, N=N)
-
-print("Global free parameter = \t", round(result[0],4), " keV-1")
-print("Free parameter (PMT A) = \t", round(result[1][0],4) , " keV-1")
-print("Free parameter (PMT B) = \t", round(result[1][1],4) , " keV-1")
-print("Free parameter (PMT C) = \t", round(result[1][2],4) , " keV-1")
-print("efficiency S = \t", round(result[2],4), "+/-", round(result[3],4))
-print("efficiency D = \t", round(result[4],4), "+/-", round(result[5],4))
-print("efficiency T = \t", round(result[6],4), "+/-", round(result[7],4))
-```
-
-```Console
-Global free parameter = 	 1.3061  keV-1
-Free parameter (PMT A) = 	 1.3061  keV-1
-Free parameter (PMT B) = 	 1.3061  keV-1
-Free parameter (PMT C) = 	 1.3061  keV-1
-efficiency S = 	 0.979 +/- 0.0067
-efficiency D = 	 0.9833 +/- 0.0064
-efficiency T = 	 0.963 +/- 0.0096
-```
-
-Example with `mode2 = "asym"`: 
-
-```python
-import tdcrpy
-
-TD = 0.977667386529166
-TAB = 0.992232838598821
-TBC = 0.992343419459002
-TAC = 0.99275350064608
-Rad="Co-60"
-pmf_1="1"
-N = 250
-kB =1.0e-5
-V = 10
-mode2 = "asym"
-
-result = tdcrpy.TDCRoptimize.eff(TD, TAB, TBC, TAC, Rad, pmf_1, kB, V, mode2, N=N)
-
-print("Global free parameter = \t", round(result[0],4), " keV-1")
-print("Free parameter (PMT A) = \t", round(result[1][0],4) , " keV-1")
-print("Free parameter (PMT B) = \t", round(result[1][1],4) , " keV-1")
-print("Free parameter (PMT C) = \t", round(result[1][2],4) , " keV-1")
-print("efficiency S = \t", round(result[2],4), "+/-", round(result[3],4))
-print("efficiency D = \t", round(result[4],4), "+/-", round(result[5],4))
-print("efficiency T = \t", round(result[6],4), "+/-", round(result[7],4))
-```
-
-```Console
-Global free parameter = 	 1.3061  keV-1
-Free parameter (PMT A) = 	 1.3061  keV-1
-Free parameter (PMT B) = 	 1.3061  keV-1
-Free parameter (PMT C) = 	 1.3061  keV-1
-efficiency S = 	 0.979 +/- 0.0067
-efficiency D = 	 0.9833 +/- 0.0064
-efficiency T = 	 0.963 +/- 0.0096
-```
-
-
-
-
 ### TDCRPy()
 
 The main function of the TDCRPy module is `TDCRPy()` in which the Monte-Carlo Triple-to-Double Coincidence Ratio model is implemented. The computation is made for a given solution containing a radionuclide (or a mixture of radionuclides) `rad`, a given volume of scintillator `V` and a given Birks constant `kB`.
@@ -334,4 +229,105 @@ An advanced setting can be configured in the `config.toml` file for functions `T
 and `nE_alpha = 1000`. These values ensure an error on quenched energy estimation from numerical approximation below 10^-3^.
 * By default the calculation is set for Ultima-Gold cocktail mixed with a small amount of aqueous solution. You can adapt for a specific scintillator by changing the `density` (default `density=0.96`), the mean charge number `Z` (default `Z=5.2`) and the mean mass number `A` (default `A=11.04`) of the scintillator.
 * To optimize the speed of the Monte-Carlo calculation, a spline interpolation on precalculated quenched energy is applied. The parameter `depthSpline` (default `depthSpline = 5`) sets the number of bins on each side of the energy point on which the interpolation is applied. The parameter `Einterp` (default `Einterp = 1`) set the energy (in keV) above which the interpolation is applied.
+
+### TDCRoptimize.eff()
+
+An optimization procedure `TDCRoptimize.eff()` is proposed to estimate the counting efficiency of a TDCR system. It approximates the free parameter(s) `L` in order to minimize the residual estimated by `TDCRPy()` for a given set of measurement data. In `mode2 = "sym"`, the *golden section search technique* is applied with a maximum number of iterations of 20. In `mode2 = "asym"`, the *Nelder-Mead technique* is applied with a maximum number of iterations of 20.
+
+`TDCRoptimize.eff()` is parametrised by the following parameters:
+*  `TD` (type `float`) is the quotient of the triple coincidence count rate divided by the logic sum of the double coincidence count rate.
+*  `TAB` (type `float`) is the quotient of the triple coincidence count rate divided by the double coincidence count rate between the channel A and B.
+*  `TBC` (type `float`) is the quotient of the triple coincidence count rate divided by the double coincidence count rate between the channel B and C.
+*  `TAC` (type `float`) is the quotient of the triple coincidence count rate divided by the double coincidence count rate between the channel A and C.
+*  `rad` (type `string`) is the list of radionuclides contained in the solution, e.g. `"H-3"`, `"H-3, Co-60"`.
+*  `pmf_1` (type `string`) is the probability of each radionuclide contained in `rad`. If `rad = "H-3, Co-60"` and `pmf_1="0.8, 0.2"`, the solution contains 80 % of tritium and 20 % of cobalt 60.
+*  `kB` (type `float`) is the Birks constant caracterizing the scintillator. It is espressed in cm/keV.
+*  `V` (type `float`) is the volume in ml of the scintillator.
+*  `mode2` sets whether the TDCR system has to be considered symetrical `mode2="sym"` or not symetrical `mode2="asym"`.
+*  `N` (type `integer`) is the number of Monte-Carlo trials corresponding each, to a simulated nuclear decay in the scintillator. Monte-Carlo calculation is not used in the case of pure beta emitting radionuclides where the analytical model is implemented. It is an optional parameter set by default at `N = 10000`.
+*  `L` (type `float`) initial guess of the free parameter(s) in keV^-1^. It represents the number of photoelectrons produced by the PMTs per unit of ionisation energy released in the scintillator during a decay and in the abscence of scintillation quenching. It is set by default at `L = 1`.
+
+`TDCRoptimize.eff()` returns:
+*  the global free parameter *L*,
+*  the free parameters related to each channel (*L<sub>A</sub>*, *L<sub>B</sub>*, *L<sub>C</sub>*),
+*  the estimation of the counting efficiency of single events *S*,
+*  the standard uncertainty of the estimation of *S*,
+*  the estimation of the counting efficiency of double coincidences *D*,
+*  the standard uncertainty of the estimation of *D*,
+*  the estimation of the counting efficiency of triple coincidences *T*,
+*  the standard uncertainty of the estimation of *T*.
+
+Example with `mode2 = "sym"`: 
+
+```python
+import tdcrpy
+
+TD = 0.977667386529166
+TAB = 0.992232838598821
+TBC = 0.992343419459002
+TAC = 0.99275350064608
+Rad="Co-60"
+pmf_1="1"
+N = 250
+kB =1.0e-5
+V = 10
+mode2 = "sym"
+
+result = tdcrpy.TDCRoptimize.eff(TD, TAB, TBC, TAC, Rad, pmf_1, kB, V, mode2, N=N)
+
+print("Global free parameter = \t", round(result[0],4), " keV-1")
+print("Free parameter (PMT A) = \t", round(result[1][0],4) , " keV-1")
+print("Free parameter (PMT B) = \t", round(result[1][1],4) , " keV-1")
+print("Free parameter (PMT C) = \t", round(result[1][2],4) , " keV-1")
+print("efficiency S = \t", round(result[2],4), "+/-", round(result[3],4))
+print("efficiency D = \t", round(result[4],4), "+/-", round(result[5],4))
+print("efficiency T = \t", round(result[6],4), "+/-", round(result[7],4))
+```
+
+```Console
+Global free parameter = 	 1.3061  keV-1
+Free parameter (PMT A) = 	 1.3061  keV-1
+Free parameter (PMT B) = 	 1.3061  keV-1
+Free parameter (PMT C) = 	 1.3061  keV-1
+efficiency S = 	 0.979 +/- 0.0067
+efficiency D = 	 0.9833 +/- 0.0064
+efficiency T = 	 0.963 +/- 0.0096
+```
+
+Example with `mode2 = "asym"`: 
+
+```python
+import tdcrpy
+
+TD = 0.977667386529166
+TAB = 0.992232838598821
+TBC = 0.992343419459002
+TAC = 0.99275350064608
+Rad="Co-60"
+pmf_1="1"
+N = 250
+kB =1.0e-5
+V = 10
+mode2 = "asym"
+
+result = tdcrpy.TDCRoptimize.eff(TD, TAB, TBC, TAC, Rad, pmf_1, kB, V, mode2, N=N)
+
+print("Global free parameter = \t", round(result[0],4), " keV-1")
+print("Free parameter (PMT A) = \t", round(result[1][0],4) , " keV-1")
+print("Free parameter (PMT B) = \t", round(result[1][1],4) , " keV-1")
+print("Free parameter (PMT C) = \t", round(result[1][2],4) , " keV-1")
+print("efficiency S = \t", round(result[2],4), "+/-", round(result[3],4))
+print("efficiency D = \t", round(result[4],4), "+/-", round(result[5],4))
+print("efficiency T = \t", round(result[6],4), "+/-", round(result[7],4))
+```
+
+```Console
+Global free parameter = 	 1.3061  keV-1
+Free parameter (PMT A) = 	 1.3061  keV-1
+Free parameter (PMT B) = 	 1.3061  keV-1
+Free parameter (PMT C) = 	 1.3061  keV-1
+efficiency S = 	 0.979 +/- 0.0067
+efficiency D = 	 0.9833 +/- 0.0064
+efficiency T = 	 0.963 +/- 0.0096
+```
        

{TDCRPy-1.8.14.dist-info → TDCRPy-1.8.15.dist-info}/RECORD

@@ -1,9 +1,9 @@
 tdcrpy/TDCRPy.py,sha256=XJHHuGwsp_yn422nupus6luRAp4a58vZPT9PO8ilOVE,53211
 tdcrpy/TDCRPy1.py,sha256=QTBZh5B5JWnGB0BQfD-cFmwA9W080OD4sG-aj50-ejo,38106
-tdcrpy/TDCR_model_lib.py,sha256=PE4365_HRBc5lB_4n0W2-UQ32LF9juA0Z_mI4M2cxtI,96132
+tdcrpy/TDCR_model_lib.py,sha256=eVM1CrraMJx6PxFUohGS4d1ht_J7FNfTbeuoOsqzYXg,96252
 tdcrpy/TDCRoptimize.py,sha256=c2XIGveeLdVYYek4Rg6dygMvVA2xIrIkMb3L-_jUucM,6496
 tdcrpy/__init__.py,sha256=vQslGLsoZPIceaitnSHOqN6lUdjEyJ3YhfJ6tYdXt-s,127
-tdcrpy/config.toml,sha256=xPejXoPI4m4FgG8hIYLEyMA-y8MBCF3PaWtv55TqHeQ,1646
+tdcrpy/config.toml,sha256=n6RdM0st4et_hlc7vO7wTcjLK8pnplJ2mLD0NJawl14,1648
 tdcrpy/test2.py,sha256=poLLXJyIaCeqh1VSkwgbi-udvY7lQjxz_YStKjJXGhU,501
 tdcrpy/EfficiencyCurves/Ag-108/EffD_Ag-108_[1]_1e-05.txt,sha256=OUoMuqPTw3fXLu5qaHUFN2iW0dPJ9cRyh99a6mUcEus,43
 tdcrpy/EfficiencyCurves/Ag-108/EffS_Ag-108_[1]_1e-05.txt,sha256=hojCq_MFAw8ONjoDmQfeE9gCXISwhScgAk-N0Pjbg00,45
@@ -1078,8 +1078,8 @@ tdcrpy/docs/_build/html/source/modules.html,sha256=Jf-qxVBId0UgpwyvYuyjtMNG-ezPO
 tdcrpy/docs/_build/html/source/tdcrpy.html,sha256=-38lHMNFB22p1tWJEeN3yDqfDiCYE304vxDamO1-iRc,3779
 tdcrpy/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tdcrpy/test/test_tdcrpy.py,sha256=3b9PeT2ROGGEFM_G4EVlDQMdP4B3ONp4a0kh1bKyVkI,4003
-TDCRPy-1.8.14.dist-info/LICENCE.md,sha256=ZTpWyGU3qv_iwEpgvCijoCuCYpOPpyzJCgOk46WpUKU,1066
-TDCRPy-1.8.14.dist-info/METADATA,sha256=tsr1_9F0SFVSoetVUUZtOPfQGkxQ0UU1LAaFqidjI20,15601
-TDCRPy-1.8.14.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-TDCRPy-1.8.14.dist-info/top_level.txt,sha256=f4vzFFcKSEnonAACs0ZXuRczmroLLqtPTqXFymU_VU0,14
-TDCRPy-1.8.14.dist-info/RECORD,,
+TDCRPy-1.8.15.dist-info/LICENCE.md,sha256=ZTpWyGU3qv_iwEpgvCijoCuCYpOPpyzJCgOk46WpUKU,1066
+TDCRPy-1.8.15.dist-info/METADATA,sha256=K1sUlZPjiGH_knFFaIrDZIexMXvKho6iVJWC8T55sSY,15600
+TDCRPy-1.8.15.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+TDCRPy-1.8.15.dist-info/top_level.txt,sha256=f4vzFFcKSEnonAACs0ZXuRczmroLLqtPTqXFymU_VU0,14
+TDCRPy-1.8.15.dist-info/RECORD,,

{TDCRPy-1.8.14.dist-info → TDCRPy-1.8.15.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tdcrpy/TDCR_model_lib.py

@@ -712,9 +712,11 @@ def readBetaShape(rad,mode,level,z=z_betashape):
             p.append(p0 * (e[k+1])-e[k])
         else:
             p.append(p0 * (e[k]-e[k-1]))
-            
+
+    e=(np.asarray(e[:-1])+np.asarray(e[1:]))/2
+    p.pop(-1)
     p /= sum(np.asarray(p)) # normalization
-    p = list(p)
+    p = list(p); e = list(e)
     return e, p
 
 
@@ -2333,12 +2335,13 @@ def modelAnalytical(L,TD,TAB,TBC,TAC,rad,kB,V,mode,mode2,ne):
     
     """
     
-    # e, p = readBetaShape(rad, 'beta-', 'tot')
-    e, p = readBetaSpectra(rad)
+    e, p = readBetaShape(rad, 'beta-', 'tot')
+    # e, p = readBetaSpectra(rad)
     em=np.empty(len(e))
     for i, ei in enumerate(e):
-        ed = energie_dep_beta(ei)
-        em[i] = E_quench_e(ed*1e3,ed*1e3,kB*1e3,ne)*1e-3
+        # ed = energie_dep_beta2(ei,V)
+        # em[i] = E_quench_e(ei*1e3,ed*1e3,kB*1e3,ne)*1e-3
+        em[i] = Em_e(ei*1e3,ed*1e3,kB*1e3,ne)*1e-3
         
         
     if mode2=="sym":

tdcrpy/config.toml

@@ -42,4 +42,4 @@ tau = 50
 depthSpline = 5
 # energy (in keV) above which interpolation is applied.
 Einterp_a = 100
-Einterp_e = 1
+Einterp_e = 1.5