update readme

update readme

Author: dpscience

README.md

@@ -1,5 +1,5 @@
 # DLTReconvolution
-Copyright (c) 2016-2018 Danny Petschke ([email protected]). All rights reserved.<br><br>
+Copyright (c) 2017-2019 Danny Petschke ([email protected]). All rights reserved.<br><br>
 DLTReconvolution - A Python based Software for the Analysis of Lifetime Spectra using the iterative least-square Reconvolution Method
 
 # Short Introduction
@@ -19,14 +19,13 @@ DLTReconvolution - A Python based Software for the Analysis of Lifetime Spectra
 ```python
 #save output as *.txt file after success?
 __saveReconvolutionSpectrum             = False
-__saveReconvolutionSpectrumPath         = 'testData/recovolutionSpectrumOutput.txt'
-__saveReconvolutionSpectrumResidualPath = 'testData/recovolutionSpectrumResidualsOutput.txt'
+__saveReconvolutionSpectrumPath         = 'output/...*txt'
+__saveReconvolutionSpectrumResidualPath = 'output/...*txt'
 
 #!note: IRF output is only saved if the model function is used, meaning--> (__bUsingModel = True)
 __saveReconvolutionIRF                  = False
-__saveReconvolutionIRFPath              = 'testData/recovolutionIRFOutput.txt'
-__saveReconvolutionIRFResidualPath      = 'testData/recovolutionIRFResidualsOutput.txt'
-
+__saveReconvolutionIRFPath              = 'output/...*txt'
+__saveReconvolutionIRFResidualPath      = 'output/...*txt'
 
 #channel/bin resolution [ps]
 __channelResolutionInPs = 5.0
@@ -35,13 +34,13 @@ __channelResolutionInPs = 5.0
 __binningFactor = 1;
 
 #expected number of components (number of exponential decay functions - LIMITED to MAX: 4):
-__numberOfExpDec = 2
+__numberOfExpDec = 3
 
 #expected lifetimes (tau) -> start values in [ps] (required for the levenberg marquardt fit using lmfit library)
 #note: only the first '__numberOfExpDec' related values are considered (e.g.: for __numberOfExpDec = 2 --> __expectedTau_1_in_ps AND __expectedTau_2_in_ps)
-__expectedTau_1_in_ps = 240.0;
-__expectedTau_2_in_ps = 1200.0;
-__expectedTau_3_in_ps = 2800.0;
+__expectedTau_1_in_ps = 190.0;
+__expectedTau_2_in_ps = 385.0;
+__expectedTau_3_in_ps = 1200.0;
 __expectedTau_4_in_ps = 160.0;
 
 #background estimation (right side of spectrum data):
@@ -51,19 +50,27 @@ __bkgrd_count = 999;
 #fixed background? (value of estimated background is used)
 __bkgrdFixed = False;
 
+#NOTE: Spectrum and IRF (or mono-exponential decay spectrum) data vectors require equal length!!!
 
-#NOTE: Spectrum and IRF data vectors require equal length!!!
+#define the number of rows which should be skipped during the import:
+__skipRows = 5;
 
 #file path which contains the SPECTRUM data:
-__filePathSpec = 'testData/spectrum_5ps.dat'
+__filePathSpec = 'testData/bi207_ref/sn_5ps.dat'
 __specDataDelimiter = '\t'
 
 #file path which contains the IRF data:
-__filePathIRF = 'testData/irf_5ps.dat'
+__filePathIRF = 'path to irf data'
 __irfDataDelimiter = '\t'
 
-#define the number of rows which should be skipped during the import:
-__skipRows = 0;
+
+#set TRUE if the irf is retrieved from a mono-exponential decay spectrum such as well annealed metals or 207-Bi (in this case, the IRF data will be ignored):
+__bUsingMonoDecaySpecForIRF = True
+
+__tau_monoDecaySpec_in_ps = 182.0 #[ps] 207-Bi
+
+__filePathMonoDecaySpec = 'testData/bi207_ref/bi207_5ps.dat'
+__monoDecaySpecDataDelimiter = '\t'
 
 #using model function for IRF?
 __bUsingModel = False
@@ -94,6 +101,7 @@ You can cite all versions by using the <b>DOI 10.5281/zenodo.1255105</b>. This D
 ## v1.x
 DLTReconvolution v1.0:<br>[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1255106.svg)](https://doi.org/10.5281/zenodo.1255106)<br>
 DLTReconvolution v1.1:<br>[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1414107.svg)](https://doi.org/10.5281/zenodo.1414107)<br>
+DLTReconvolution v1.2:<br><b>not officialy released yet...<br>
 
 # Requirements
 - [LMFIT](https://lmfit.github.io/lmfit-py/model.html) 
@@ -104,7 +112,7 @@ DLTReconvolution v1.1:<br>[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14
 
 # License (BSD-3-Clause)
 
-Copyright (c) 2016-2018 Danny Petschke ([email protected]). All rights reserved.<br><br>
+Copyright (c) 2017-2019 Danny Petschke ([email protected]). All rights reserved.<br><br>
 
 Redistribution and use in source and binary forms, with or without modification,<br> 
 are permitted provided that the following conditions are met:<br><br>
@@ -131,4 +139,4 @@ are permitted provided that the following conditions are met:<br><br>
  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,<br> 
  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.<br>
 
- see also [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause)
+ see also [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause)