Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpscience/dltpulsegenerator
DLTPulseGenerator - A library for the simulation of lifetime spectra based on realistically modelled detector-output pulses
https://github.com/dpscience/dltpulsegenerator
antimatter apd detector digtizer drs4 drs4-evaluation-board flim fluorescence-microscopy-imaging generated-pulses lifetime-spectra lifetime-spectroscopy pals photodiodes photomultiplier positron positron-lifetime-spectra pulse signal-processing simulation simulator
Last synced: about 16 hours ago
JSON representation
DLTPulseGenerator - A library for the simulation of lifetime spectra based on realistically modelled detector-output pulses
- Host: GitHub
- URL: https://github.com/dpscience/dltpulsegenerator
- Owner: dpscience
- License: other
- Created: 2018-02-07T13:12:15.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-10T15:03:29.000Z (about 2 years ago)
- Last Synced: 2024-01-29T08:11:01.835Z (10 months ago)
- Topics: antimatter, apd, detector, digtizer, drs4, drs4-evaluation-board, flim, fluorescence-microscopy-imaging, generated-pulses, lifetime-spectra, lifetime-spectroscopy, pals, photodiodes, photomultiplier, positron, positron-lifetime-spectra, pulse, signal-processing, simulation, simulator
- Language: C++
- Homepage:
- Size: 2.47 MB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Support this project and keep always updated about recent software releases, bug fixes and major improvements by [following on researchgate](https://www.researchgate.net/project/DDRS4PALS-a-software-for-the-acquisition-and-simulation-of-positron-annihilation-lifetime-spectra-PALS-using-the-DRS4-evaluation-board) or [github](https://github.com/dpscience?tab=followers).
[](https://www.researchgate.net/project/DDRS4PALS-a-software-for-the-acquisition-and-simulation-of-positron-annihilation-lifetime-spectra-PALS-using-the-DRS4-evaluation-board)
# DLTPulseGenerator
Copyright (c) 2016-2022 Dr. Danny Petschke ([email protected]). All rights reserved.
DLTPulseGenerator - A library for the simulation of lifetime spectra based on detector-output pulses.
### ``Software Applications using DLTPulseGenerator Library``
[DDRS4PALS](https://github.com/dpscience/DDRS4PALS) software written by Danny Petschke.
# Quickstart Guide
### ``C++ Example Code``
```c++
#define forever while(true)
#define DDELETE_SAFETY(__ptr__) { if (__ptr__) { delete __ptr__; __ptr__ = nullptr; } }
int main() {
printf("let's go ...\n\n");
/* 1a. define your virtual setup and desired spectrum to be simulated */
DLTSetup setup = DLTSetup_DEMO;
DLTPulse pulse = DLTPulse_DEMO;
DLTPHS phs = DLTPHS_DEMO;
DLTSimulationInput simulationInput = DLTSimulationInput_DEMO;
/* 1b. set the trigger-levels for both detector branches A and B */
const double triggerA_in_mV = 50.0;
const double triggerB_in_mV = 50.0;
/* 2. create an instance of DLTPulseGenerator class and pass your setup information and simulation input */
DLTPulseGenerator *pulseGenerator = new DLTPulseGenerator(simulationInput, phs, setup, pulse, nullptr);
/* pulses to be manipulated by calling 'emitPulses(..)' */
DLTPulseF pulseA, pulseB;
forever {
/* receive the pulses */
if (pulseGenerator->emitPulses(&pulseA, &pulseB, triggerA_in_mV, triggerB_in_mV)) {
/* now its your turn ... use the generated pulses for whatever purposes ... for example ... */
/* const double timingA = determineCFTiming(pulseA, level=50.);
const double timingB = determineCFTiming(pulseB, level=50.);
const double lifetime = calcTimeDifference(timingA, timingB);
... add to the lifetime spectrum ... */
}
else
break;
}
DDELETE_SAFETY(pulseGenerator)
}
```
### ``Python Example Code``
DLTPulseGenerator can be compiled as linked library enabling access from programming languages such as Python (or Matlab).
A library wrapper for Python ([pyDLTPulseGenerator.py](https://github.com/dpscience/DLTPulseGenerator/tree/master/pyDLTPulseGenerator)) demonstrating the usage of [ctypes-library](https://docs.python.org/3/library/ctypes.html) is provided (see [pyDLTPulseGeneratorApp.py](https://github.com/dpscience/DLTPulseGenerator/blob/master/pyDLTPulseGenerator/pyDLTPulseGenerator.py)).
Examples can be found ([here](https://github.com/dpscience/DLTPulseGenerator/tree/master/pyDLTPulseGenerator)).
```python
import pyDLTPulseGenerator as dpg # import 'pyDLTPulseGenerator' module
import matplotlib.pyplot as plt
numberOfPulses = 100000 # number of pulses to be generated ...
# set trigger levels for branches A & B [mV] ...
triggerA = -25. # [mV]
triggerB = -25. # [mV]
# define your simulation input (or apply the defaults) ...
lt = dpg.DLTSimulationInput()
setupInfo = dpg.DLTSetup()
pulseInfo = dpg.DLTPulse()
phs = dpg.DLTPHS()
# create an instance of DLTPulseGenerator ...
pulseGen = dpg.DLTPulseGenerator(phs,
lt,
setupInfo,
pulseInfo,
'dltpulsegenerator.dll')
# catch errors ...
if not pulseGen.printErrorDescription():
quit() # kill process on error ...
pulseA = dpg.DLTPulseF() # pulse of detector A
pulseB = dpg.DLTPulseF() # pulse of detector B
for i in range(numberOfPulses):
if not pulseGen.emitPulses(pulseA,pulseB,triggerA,triggerB): # generate pulse pairs ...
continue
plt.plot(pulseA.getTime(),pulseA.getVoltage(),'r-',label="pulse-A")
plt.plot(pulseB.getTime(),pulseB.getVoltage(),'b-',label="pulse-B")
plt.show()
// ...
```
# Related Presentation & Publications
### ``DLTPulseGenerator v1.0``
[](https://doi.org/10.1016/j.softx.2018.04.002)
This [release v1.0](https://github.com/dpscience/DLTPulseGenerator/releases/tag/1.0) refers to the original paper by Petschke et al. published in SoftwareX (Elsevier, 2018)
[DLTPulseGenerator: A library for the simulation of lifetime spectra based on detector-output pulses](https://doi.org/10.1016/j.softx.2018.04.002)
and provides the simulation of lifetime spectra consisting of discrete characteristic lifetimes based on detector-output pulses modelled by a log-normal distribution function.
### ``DLTPulseGenerator v1.1``
[](https://doi.org/10.1016/j.softx.2018.05.001)
This [release v1.1](https://github.com/dpscience/DLTPulseGenerator/releases/tag/1.1) refers to the update paper (v1.1) by Petschke et al. published in SoftwareX (Elsevier, 2018)
[Update (v1.1) to DLTPulseGenerator: A library for the simulation of lifetime spectra based on detector-output pulses](https://doi.org/10.1016/j.softx.2018.05.001)
and provides the simulation of lifetime spectra consisting of distributed characteristic lifetimes as can be found in porous materials such as polymers or glasses due to distributions in their pore-sizes.
### ``DLTPulseGenerator v1.2``
[](https://doi.org/10.1016/j.softx.2018.06.003)
This [release v1.2](https://github.com/dpscience/DLTPulseGenerator/releases/tag/1.2) refers to the update paper (v1.2) by Petschke et al. published in SoftwareX (Elsevier, 2018)
[Update (v1.2) to DLTPulseGenerator: A library for the simulation of lifetime spectra based on detector-output pulses](https://doi.org/10.1016/j.softx.2018.06.003)
and enables the simulation of lifetime spectra consisting of non-Gaussian or any-distributed and linearly combined Instrument Response Functions (IRF) for the PDS A/B and MU.
### ``DLTPulseGenerator v1.3``
[](https://doi.org/10.1016/j.softx.2019.02.003)
This [release v1.3](https://github.com/dpscience/DLTPulseGenerator/releases/tag/1.3) refers to the update paper (v1.3) by Petschke et al. published in SoftwareX (Elsevier, 2019)
[Update (v1.3) to DLTPulseGenerator: A library for the simulation of lifetime spectra based on detector-output pulses](https://doi.org/10.1016/j.softx.2019.02.003)
and provides the simulation of realistic hardware influences mainly originating from the parts of the A/D converter such as baseline-offset jitter, random noise, fixed pattern and random aperture jitters on the time axis or the digitization depth.
### ``DLTPulseGenerator v1.4``
### ``DLTPulseGenerator v1.5``
DLTPulseGenerator v1.4 and 1.5
[](https://doi.org/10.5281/zenodo.718134)
This [release v1.5](https://github.com/dpscience/DLTPulseGenerator/releases/tag/1.5) enables the incorporation of pulse height spectra (PHS) from real data or
generated by Geant4, so that effects on the background contributing to the lifetime spectra with regard to the PHS window settings can be studied more realistically.
### ``Presentation at 18th International Conference on Positron Annihilation (ICPA-18) in Orlando (Aug. 2018)``
[ICPA-18 (Orlando): DLTPulseGenerator - A C/C++ library for the simulation of lifetime spectra based on detector output-pulses](https://www.researchgate.net/publication/329782711_ICPA-18_Orlando_DLTPulseGenerator_-_A_CC_library_for_the_simulation_of_lifetime_spectra_based_on_detector_output-pulses)
# How to cite this Library?
* You should at least cite the following publication.
[](https://doi.org/10.1016/j.softx.2018.04.002)
[DLTPulseGenerator: A library for the simulation of lifetime spectra based on detector-output pulses (SoftwareX 2018, Elsevier)](https://doi.org/10.1016/j.softx.2018.04.002)
* Additionally, you should cite the version of DLTPulseGenerator library used in your study.
You can cite all released software versions by using the DOI 10.5281/zenodo.7031107. This DOI represents all versions, and will always resolve to the latest one.
[](https://doi.org/10.5281/zenodo.7031107)
# License of DLTPulseGenerator (BSD-3-Clause)
Copyright (c) 2016-2022 Dr. Danny Petschke ([email protected]). All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder "Danny Petschke" nor the names of
its contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
see also [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause)