ScintillatorSimulator Class Reference

Digitize EKLMSim2Hits to get EKLM StripHits. More...

#include <ScintillatorSimulator.h>

Collaboration diagram for ScintillatorSimulator:

Classes
struct	Photoelectron
	Photoelectron data. More...

Public Member Functions
	ScintillatorSimulator (const KLMScintillatorDigitizationParameters *digPar, ScintillatorFirmware *fitter, double digitizationInitialTime, bool debug)
	Constructor. More...
	ScintillatorSimulator (const ScintillatorSimulator &)=delete
	Copy constructor (disabled).
ScintillatorSimulator &	operator= (const ScintillatorSimulator &)=delete
	Operator = (disabled).
	~ScintillatorSimulator ()
	Destructor.
void	simulate (const std::multimap< KLMChannelNumber, const BKLMSimHit * >::iterator &firstHit, const std::multimap< KLMChannelNumber, const BKLMSimHit * >::iterator &end)
	Simulate BKLM strip. More...
void	simulate (const std::multimap< KLMChannelNumber, const EKLMSimHit * >::iterator &firstHit, const std::multimap< KLMChannelNumber, const EKLMSimHit * >::iterator &end)
	Simulate EKLM strip. More...
KLMScintillatorFirmwareFitResult *	getFPGAFit ()
	Get fit data.
enum ScintillatorFirmwareFitStatus	getFitStatus () const
	Get fit status. More...
double	getNPhotoelectrons ()
	Get number of photoelectrons (fit result).
int	getNGeneratedPhotoelectrons ()
	Get generated number of photoelectrons.
double	getEnergy ()
	Get total energy deposited in the strip (sum over ssimulation hits).
void	setFEEData (const KLMScintillatorFEEData *FEEData)
	Set FEE data.
void	generatePhotoelectrons (double stripLen, double distSiPM, int nPhotons, double timeShift, bool isReflected)
	Generate photoelectrons. More...
void	fillSiPMOutput (float *hist, bool useDirect, bool useReflected)
	Fill SiPM output. More...
float	getMCTime () const
	Get MC time. More...
float	getSiPMMCTime () const
	Get SiPM MC time. More...

Private Member Functions
void	reallocPhotoElectronBuffers (int size)
	Reallocate photoelectron buffers. More...
void	prepareSimulation ()
	Prepare simulation.
void	performSimulation ()
	Perform common simulation stage.
int *	sortPhotoelectrons (int nPhotoelectrons)
	Sort photoelectrons. More...
void	addRandomSiPMNoise ()
	Add random noise to the signal (amplitude-dependend).
void	simulateADC ()
	Simulate ADC (create digital signal from analog),.
void	debugOutput ()
	Debug output (signal and fit result histograms).

Private Attributes
const KLMTime *	m_Time
	Time.
const KLMScintillatorDigitizationParameters *	m_DigPar
	Parameters.
ScintillatorFirmware *	m_fitter
	Fitter.
double	m_DigitizationInitialTime
	Initial digitization time.
bool	m_Debug
	Debug mode (generates additional output files with histograms).
double	m_histRange
	Time range, (number of digitizations) * (ADC sampling time).
float *	m_amplitudeDirect
	Analog amplitude (direct).
float *	m_amplitudeReflected
	Analog amplitude (reflected).
float *	m_amplitude
	Analog amplitude.
int *	m_ADCAmplitude
	Digital amplitude.
double *	m_SignalTimeDependence
	Buffer for signal time dependence calculation.
double *	m_SignalTimeDependenceDiff
	Buffer for signal time dependence calculation.
struct Photoelectron *	m_Photoelectrons
	Buffer for photoelectron data.
int *	m_PhotoelectronIndex
	Buffer for photoelectron indices.
int *	m_PhotoelectronIndex2
	Buffer for photoelectron indices.
int	m_PhotoelectronBufferSize
	Size of photoelectron data buffer.
enum ScintillatorFirmwareFitStatus	m_FPGAStat
	FPGA fit status.
KLMScintillatorFirmwareFitResult	m_FPGAFit
	FPGA fit data.
int	m_npe
	Number of photoelectrons (generated).
double	m_Energy
	Total energy deposited in the strip.
std::string	m_stripName
	Name of the strip.
double	m_Pedestal
	Pedestal.
double	m_PhotoelectronAmplitude
	Photoelectron amplitude.
int	m_Threshold
	Threshold.
float	m_MCTime
	MC time.
float	m_SiPMMCTime
	MC time at SiPM.

Detailed Description

Digitize EKLMSim2Hits to get EKLM StripHits.

Definition at line 30 of file ScintillatorSimulator.h.

Constructor & Destructor Documentation

ScintillatorSimulator()

ScintillatorSimulator	(	const KLMScintillatorDigitizationParameters *	digPar,
		ScintillatorFirmware *	fitter,
		double	digitizationInitialTime,
		bool	debug
	)

Constructor.

Parameters

[in]	digPar	Digitization parameters.
[in]	digitizationInitialTime	Initial digitization time.
[in]	fitter	Fitter.
[in]	debug	Use debug mode.

Definition at line 69 of file ScintillatorSimulator.cc.

                                              :
  m_Time(&(KLMTime::Instance())),
  m_DigPar(digPar),
  m_fitter(fitter),
  m_DigitizationInitialTime(digitizationInitialTime),
  m_Debug(debug),
  m_FPGAStat(c_ScintillatorFirmwareNoSignal),
  m_npe(0),
  m_Energy(0),
  m_MCTime(-1),
  m_SiPMMCTime(-1)
{
  int i;
  const double samplingTime = m_DigPar->getADCSamplingTDCPeriods() *
                              m_Time->getTDCPeriod();
  /* cppcheck-suppress variableScope */
  double time, attenuationTime;
  m_histRange = m_DigPar->getNDigitizations() * samplingTime;
  m_Pedestal = m_DigPar->getADCPedestal();
  m_PhotoelectronAmplitude = m_DigPar->getADCPEAmplitude();
  m_Threshold = m_DigPar->getADCThreshold();
  /* Amplitude arrays. */
  m_amplitudeDirect = (float*)malloc(m_DigPar->getNDigitizations() *
                                     sizeof(float));
  if (m_amplitudeDirect == nullptr)
    B2FATAL(MemErr);
  m_amplitudeReflected = (float*)malloc(m_DigPar->getNDigitizations() *
                                        sizeof(float));
  if (m_amplitudeReflected == nullptr)
    B2FATAL(MemErr);
  m_amplitude = (float*)malloc(m_DigPar->getNDigitizations() * sizeof(float));
  if (m_amplitude == nullptr)
    B2FATAL(MemErr);
  m_ADCAmplitude = (int*)malloc(m_DigPar->getNDigitizations() * sizeof(int));
  if (m_ADCAmplitude == nullptr)
    B2FATAL(MemErr);
  m_SignalTimeDependence = (double*)malloc((m_DigPar->getNDigitizations() + 1) *
                                           sizeof(double));
  if (m_SignalTimeDependence == nullptr)
    B2FATAL(MemErr);
  m_SignalTimeDependenceDiff = (double*)malloc(m_DigPar->getNDigitizations() *
                                               sizeof(double));
  if (m_SignalTimeDependenceDiff == nullptr)
    B2FATAL(MemErr);
  attenuationTime = 1.0 / m_DigPar->getPEAttenuationFrequency();
  for (i = 0; i <= m_DigPar->getNDigitizations(); i++) {
    time = samplingTime * i;
    m_SignalTimeDependence[i] =
      exp(-digPar->getPEAttenuationFrequency() * time) * attenuationTime /
      samplingTime;
    if (i > 0) {
      m_SignalTimeDependenceDiff[i - 1] = m_SignalTimeDependence[i - 1] -
                                          m_SignalTimeDependence[i];
    }
  }
  m_Photoelectrons = nullptr;
  m_PhotoelectronIndex = nullptr;
  m_PhotoelectronIndex2 = nullptr;
  reallocPhotoElectronBuffers(100);
}

Member Function Documentation

fillSiPMOutput()

void fillSiPMOutput	(	float *	hist,
		bool	useDirect,
		bool	useReflected
	)

Fill SiPM output.

Parameters

[in,out]	hist	Output histogram (signal is added to it).
[in]	useDirect	Use direct photons.
[in]	useReflected	Use reflected photons.

Definition at line 448 of file ScintillatorSimulator.cc.

generatePhotoelectrons()

void generatePhotoelectrons	(	double	stripLen,
		double	distSiPM,
		int	nPhotons,
		double	timeShift,
		bool	isReflected
	)

Generate photoelectrons.

Parameters

[in]	stripLen	Strip length.
[in]	distSiPM	Distance from hit to SiPM.
[in]	nPhotons	Number of photons to be simulated.
[in]	timeShift	Time of hit.
[in]	isReflected	Whether the hits are reflected or not.

Definition at line 338 of file ScintillatorSimulator.cc.

getFitStatus()

enum KLM::ScintillatorFirmwareFitStatus getFitStatus

(

)

const

Get fit status.

Returns

Status of the fit.

Definition at line 515 of file ScintillatorSimulator.cc.

getMCTime()

float getMCTime ( ) const

inline

Get MC time.

Returns

MC time.

Definition at line 141 of file ScintillatorSimulator.h.

      {
        return m_MCTime;
      }

getSiPMMCTime()

float getSiPMMCTime ( ) const

inline

Get SiPM MC time.

Returns

SiPM MC yime.

Definition at line 150 of file ScintillatorSimulator.h.

reallocPhotoElectronBuffers()

void reallocPhotoElectronBuffers ( int  size )

private

Reallocate photoelectron buffers.

Parameters

[in]

size

New size of buffers.

Definition at line 45 of file ScintillatorSimulator.cc.

simulate() [1/2]

void simulate	(	const std::multimap< KLMChannelNumber, const BKLMSimHit * >::iterator &	firstHit,
		const std::multimap< KLMChannelNumber, const BKLMSimHit * >::iterator &	end
	)

Simulate BKLM strip.

Parameters

[in]	firstHit	First hit in this strip.
[in]	end	End of hit range.

Definition at line 170 of file ScintillatorSimulator.cc.

simulate() [2/2]

void simulate	(	const std::multimap< KLMChannelNumber, const EKLMSimHit * >::iterator &	firstHit,
		const std::multimap< KLMChannelNumber, const EKLMSimHit * >::iterator &	end
	)

Simulate EKLM strip.

Parameters

[in]	firstHit	First hit in this strip.
[in]	end	End of hit range.

Definition at line 220 of file ScintillatorSimulator.cc.

sortPhotoelectrons()

int * sortPhotoelectrons ( int  nPhotoelectrons )

private

Sort photoelectrons.

Parameters

[in]

nPhotoelectrons

Number of photoelectrons.

Returns

Pointer to index array.

Definition at line 290 of file ScintillatorSimulator.cc.

---

The documentation for this class was generated from the following files:

• klm/simulation/include/ScintillatorSimulator.h
• klm/simulation/src/ScintillatorSimulator.cc