Simulate TRT Electronics Noise
For description of metod, see Thomas Kittelmanns PhD thesis chapters 9-11. More...

#include <TRTElectronicsNoise.h>

Collaboration diagram for TRTElectronicsNoise:

Public Member Functions
	TRTElectronicsNoise (const TRTDigSettings , CLHEP::HepRandomEngine rndmEngine)
	Constructor: Calls tabulateNoiseSignalShape() More...

	~TRTElectronicsNoise ()
	Destructor. More...

void	getSamplesOfMaxLTOverNoiseAmp (std::vector< float > &maxLTOverNoiseAmp, unsigned long nsamplings, CLHEP::HepRandomEngine *rndmEngine)
	From generated (and cached) noise samples, this function returns in vector `maxLTOverNoiseAmp` the maximum of the noise amplitude within each of `nsamplings` 75 ns long samplings. More...

void	reinitElectronicsNoise (const unsigned int &numberOfDigitLengths, CLHEP::HepRandomEngine *rndmEngine)
	Re-initialize electronics noise table. More...

void	setElectronicsNoiseAmplitude (const double &)
	Set electronics noise amplitude. More...

void	addElectronicsNoise (std::vector< double > &signal, const double &noiseamplitude, CLHEP::HepRandomEngine *rndmEngine)
	Add electronics noise to simulated signals in hit straws. More...

Private Member Functions
void	tabulateNoiseSignalShape ()
	Tabulate noise signal shape. More...

double	getMax (unsigned int firstbinslowsignal, unsigned int firstbinfastsignal, const unsigned int &binsinwindow)
	Get max amplitude of noise signal from weighted sum of fast and slow varying noise in period. More...

void	InitializeNoiseShaping ()
	Initialize signal shaping. More...

double	NoiseShape (const double &time) const
	Get parameterized signal shape for noise hits. More...

Private Attributes
const TRTDigSettings *	m_settings

std::vector< double >	m_noiseSignalShape
	Tabulated noise signal shape. More...

std::vector< float >	m_cachedFastNoiseAfterSignalShaping
	Cached samples of electronics noise after signal shaping (fast input) More...

std::vector< float >	m_cachedSlowNoiseAfterSignalShaping
	Cached samples of electronics noise after signal shaping (slow input) More...

std::vector< float >	m_tmpArray
	Here to avoid repeated memory allocs. More...

double	m_fractionOfSlowNoise

unsigned int	m_nbins_periodic

std::vector< double >	m_noisepars1
	Noise signal params 1 (t<15.5 ns) More...

std::vector< double >	m_noisepars2
	Noise signal params 2 (t>15.5 ns) More...

Detailed Description

Simulate TRT Electronics Noise
For description of metod, see Thomas Kittelmanns PhD thesis chapters 9-11.

Definition at line 18 of file TRTElectronicsNoise.h.

Constructor & Destructor Documentation

◆ TRTElectronicsNoise()

TRTElectronicsNoise::TRTElectronicsNoise	(	const TRTDigSettings *	digset,
		CLHEP::HepRandomEngine *	rndmEngine
	)

Constructor: Calls tabulateNoiseSignalShape()

Definition at line 20 of file TRTElectronicsNoise.cxx.

   : m_settings(digset)
 {
   //Need to initialize the signal shaping first as it is used in tabulateNoiseSignalShape()!
   this->InitializeNoiseShaping();
   m_fractionOfSlowNoise = m_settings->slowPeriodicNoisePulseFraction();
   this->tabulateNoiseSignalShape();
   this->reinitElectronicsNoise(200, elecNoiseRndmEngine);
   const double slowPeriod(m_settings->slowPeriodicNoisePulseDistance());
  
   //Must be rounded to nearest multiple of binwidth... (fixme - from options)
   const double binwidth(m_settings->timeInterval()/m_settings->numberOfBins());
   m_nbins_periodic = static_cast<int>(slowPeriod/binwidth + 0.5);
 }

◆ ~TRTElectronicsNoise()

TRTElectronicsNoise::~TRTElectronicsNoise ( )

default

Destructor.

Member Function Documentation

◆ addElectronicsNoise()

void TRTElectronicsNoise::addElectronicsNoise	(	std::vector< double > &	signal,
		const double &	noiseamplitude,
		CLHEP::HepRandomEngine *	rndmEngine
	)

Add electronics noise to simulated signals in hit straws.

Analog noise is added to simulated signal after signal shaping. The analog noise is taken from m_cachedFastNoiseAfterSignalShaping[] and m_cachedSlowNoiseAfterSignalShaping[]

Parameters

signal	tabulated analog shaped signal
noiseamplitude	noise amplitude

Definition at line 197 of file TRTElectronicsNoise.cxx.

                                                                                 {
  
   // complain if uninitialized? (fixme)
  
   // We "smear" the 25ns signal (simulating the fact that different
   // straws have different offsets):
   //
   // Effectively, in 64% of the cases we choose the shift randomly in
   // the interval [-1.56ns,3.9ns], and in the remaining 36% we choose
   // the shift randomly in [4.7ns,17.97ns]. This scheme seems to
   // reproduce the features of data well.
  
   static const unsigned int n_slowperiodic_shift = 26;
   static const int slowperiodic_constshift       = -2;
   static const double slowperiodic_shift_prob_comul[n_slowperiodic_shift] =
     {0.08, 0.16, 0.24, 0.32, 0.40, 0.48, 0.56, 0.64, 0.66, 0.68,
      0.70, 0.72, 0.74, 0.76, 0.78, 0.80, 0.82, 0.84, 0.86, 0.88,
      0.90, 0.92, 0.94, 0.96, 0.98, 1.00};
  
   //Find array offset for fast signal:
   const unsigned int nsignalbins(signal.size());
   const unsigned int offset_fast(CLHEP::RandFlat::shootInt(rndmEngine, m_cachedFastNoiseAfterSignalShaping.size()-nsignalbins));
  
   //Find array offset for slow periodic signal:
   int offset_slowperiodic(CLHEP::RandFlat::shootInt(rndmEngine,
                                                     m_cachedSlowNoiseAfterSignalShaping.size()
                                                     - nsignalbins-n_slowperiodic_shift
                                                     - slowperiodic_constshift));
  
   offset_slowperiodic -= ( offset_slowperiodic % m_nbins_periodic );
   offset_slowperiodic -= slowperiodic_constshift;
  
   const double rand(CLHEP::RandFlat::shoot(rndmEngine, 0., 1.));
   for (unsigned int i(0); i < n_slowperiodic_shift; ++i) {
     if ( rand < slowperiodic_shift_prob_comul[i] ) {
       offset_slowperiodic -= i;
       break;
     };
   };
  
   //Fix for rare case when offset becomes negative
   if (offset_slowperiodic<0)
     offset_slowperiodic += (((-offset_slowperiodic)%m_nbins_periodic)+1)*m_nbins_periodic;
  
   //Add the two components to the signal:
   for ( unsigned int i(0); i<nsignalbins; ++i) {
     signal[i] += noiseamplitude *
       ( m_cachedFastNoiseAfterSignalShaping[offset_fast + i] +
         m_cachedSlowNoiseAfterSignalShaping[offset_slowperiodic + i] );
   };
 }

◆ getMax()

double TRTElectronicsNoise::getMax	(	unsigned int	firstbinslowsignal,
		unsigned int	firstbinfastsignal,
		const unsigned int &	binsinwindow
	)

private

Get max amplitude of noise signal from weighted sum of fast and slow varying noise in period.

Returns: max signal

Parameters

firstbinslowsignal	pointer into array (LUT) of slow noise signals
firstbinfastsignal	pointer into array (LUT) of fast noise signals
binsinwindow	number of bins in window, where maximum is searched

Definition at line 66 of file TRTElectronicsNoise.cxx.

 {
  
   // This method assumes that firstbinslowsignal + binsinwindow doesn't
   // exceed the cached array sizes (and same for fastsignal).
  
   double max = -99999.0;
   unsigned int lastslowbinplusone = firstbinslowsignal + binsinwindow;
  
   while( firstbinslowsignal < lastslowbinplusone ) {
     double totalsig =
       m_cachedFastNoiseAfterSignalShaping[firstbinfastsignal++] +
       m_cachedSlowNoiseAfterSignalShaping[firstbinslowsignal++];
     if ( max<totalsig ) max = totalsig;
   };
  
   return max;
 }

◆ getSamplesOfMaxLTOverNoiseAmp()

void TRTElectronicsNoise::getSamplesOfMaxLTOverNoiseAmp	(	std::vector< float > &	maxLTOverNoiseAmp,
		unsigned long	nsamplings,
		CLHEP::HepRandomEngine *	rndmEngine
	)

From generated (and cached) noise samples, this function returns in vector maxLTOverNoiseAmp the maximum of the noise amplitude within each of nsamplings 75 ns long samplings.

Parameters

maxLTOverNoiseAmp	vector containing max noise signal for each of the 75 ns long sampling
nsamplings	number of samplings

Definition at line 40 of file TRTElectronicsNoise.cxx.

                                                                                                                     {
  
   // Note: The offset structure is not the same as in
   // addElectronicsNoise(), but that is OK, since it is not the exact
   // time-structure we are looking for here - but only the distribution
   // of the highest amplitude.
  
   maxLTOverNoiseAmp.resize(nsamplings);
  
   reinitElectronicsNoise(500, rndmEngine);
   unsigned int index         = m_noiseSignalShape.size();
   unsigned int nbinsinperiod = m_settings->numberOfBins();
   unsigned int maxindex      = m_cachedFastNoiseAfterSignalShaping.size() - nbinsinperiod;
  
   for (unsigned int i = 0; i < nsamplings; ++i) {
     maxLTOverNoiseAmp[i] = getMax(index, index, nbinsinperiod );
     index += nbinsinperiod;
     if ( index  > maxindex ) {
       reinitElectronicsNoise(500, rndmEngine);
       index = m_noiseSignalShape.size();
     }
   }
 }

◆ InitializeNoiseShaping()

void TRTElectronicsNoise::InitializeNoiseShaping ( )

private

Initialize signal shaping.

Note: The noise shape parameters are hardcoded here.

Definition at line 252 of file TRTElectronicsNoise.cxx.

                                                  {
  
   // For now we hardcode the noise shape parameters here:
   // (I am not sure they make much sense in the DB in any case - a simple version flag should suffice).
   // According to Anatoli, this shape can be the same for Xe, Kr and Ar.
   m_noisepars1.clear();
   m_noisepars1.push_back(263.1021);//N
   m_noisepars1.push_back(4.611810);//mu
   m_noisepars1.push_back(8.496722);//sigma
   m_noisepars1.push_back(-226.9187);//a
   m_noisepars1.push_back(-15.15887);//+bt
   m_noisepars1.push_back(2.833467);//+ct**2
   m_noisepars1.push_back(-.8981638E-01);//+dt**3
   m_noisepars2.clear();
   m_noisepars2.push_back(-131.7723);//N
   m_noisepars2.push_back(12.94000);//mu
   m_noisepars2.push_back(8.107412);//sigma
   m_noisepars2.push_back(276.7422);//a
   m_noisepars2.push_back(-6.767590);//+bt
   m_noisepars2.push_back(-.3214721);//+ct**2
   m_noisepars2.push_back(.8512509E-02);//+dt**3
  
 }

◆ NoiseShape()

double TRTElectronicsNoise::NoiseShape ( const double & time ) const

private

Get parameterized signal shape for noise hits.

Returns: Signal amplitude

Parameters

time	time after signal arrival

Definition at line 277 of file TRTElectronicsNoise.cxx.

                                                                {
  
   //convert to nanoseconds:
   const double time_ns(time/CLHEP::nanosecond);
  
   if ( time_ns<0 || time_ns > 32 ) return 0;
  
   double tmp(0);
   for (unsigned int i(6); i>=4; --i) {
     if (time_ns<15.5)
       tmp = (tmp + m_noisepars1[i])*time_ns;
     else
       tmp = (tmp + m_noisepars2[i])*time_ns;
   };
  
   if (time_ns<15.5)
     tmp += m_noisepars1[0]*exp(-0.5*((time_ns-m_noisepars1[1])/m_noisepars1[2])
                                *((time_ns-m_noisepars1[1])/m_noisepars1[2])) + m_noisepars1[3];
   else
     tmp += m_noisepars2[0]*exp(-0.5*((time_ns-m_noisepars2[1])/m_noisepars2[2])
                                *((time_ns-m_noisepars2[1])/m_noisepars2[2])) + m_noisepars2[3];
  
   tmp *= 0.001;
  
   return tmp;
  
 }

◆ reinitElectronicsNoise()

void TRTElectronicsNoise::reinitElectronicsNoise	(	const unsigned int &	numberOfDigitLengths,
		CLHEP::HepRandomEngine *	rndmEngine
	)

Re-initialize electronics noise table.

Fills the cached tables m_cachedFastNoiseAfterSignalShaping and m_cachedSlowNoiseAfterSignalShaping with numberOfDigitLengths 75 ns long noise signals.

Procedure (same for fast and slow signals)

Create periodic noise pulses with Gaussian pulse height centered around zero and with unit width.
Shape pulses according to noiseSignalShaping into cached tables

Parameters

numberOfDigitLengths number of 75ns timeslices to generate noise for

Definition at line 88 of file TRTElectronicsNoise.cxx.

 {
   //This method gives the actual physics shape!
   //Model parameters:
  
   const double fastPeriod = m_settings->fastElectronicsNoisePulseDistance();
   //Must be rounded to nearest multiple of binwidth... (fixme - from options)
  
   const double slowPeriod = m_settings->slowPeriodicNoisePulseDistance();
   //Must be rounded to nearest multiple of binwidth... (fixme - from options)
  
   //For consistency we start the arrays a little earlier than the bins we use -
   //the time back from where the signal shaping could carry a pulse:
   unsigned int nbins = m_noiseSignalShape.size() + numberOfDigitLengths * m_settings->numberOfBins();
  
   m_cachedFastNoiseAfterSignalShaping.resize(nbins);
   m_cachedSlowNoiseAfterSignalShaping.resize(nbins);
  
   m_tmpArray.resize(nbins);
  
   const double invbinwidth(m_settings->numberOfBins() / m_settings->timeInterval());
   double timeOfNextPulse;
   unsigned int binindex;
  
   //### Fast signal:
   double fractionOfFastNoise = 1.0-m_fractionOfSlowNoise;
  
   //### First we produce the noise as it is BEFORE signal shaping:
   for (unsigned int i(0); i < nbins; ++i) {
     m_tmpArray[i] = 0.;
     m_cachedFastNoiseAfterSignalShaping[i] = 0.;
   }
  
   timeOfNextPulse = 0.5 * fastPeriod;
   while ( true ) {
     binindex = static_cast<unsigned int>(timeOfNextPulse*invbinwidth);
     if (binindex >= nbins) break;
     m_tmpArray[binindex] += CLHEP::RandGaussZiggurat::shoot(rndmEngine, 0., 1.);
     timeOfNextPulse += fastPeriod;
   };
  
   //### Then (Anatolis) signal shaping:
   for (unsigned int i(0); i < nbins; ++i) {
     unsigned int limit(i+m_noiseSignalShape.size());
     if ( limit > nbins ) limit = nbins;
     for (unsigned int j(i); j < limit; ++j) {
       m_cachedFastNoiseAfterSignalShaping[j] +=
         m_tmpArray[i] * m_noiseSignalShape[j-i] * fractionOfFastNoise;
     };
   };
  
   //### Slow periodic signal
   for (unsigned int i(0); i < nbins; ++i) {
     m_tmpArray[i] = 0.;
     m_cachedSlowNoiseAfterSignalShaping[i] = 0.;
   }
  
   //### First we produce the noise as it is BEFORE signal shaping:
   timeOfNextPulse = 0.5 * slowPeriod;
   while (true) {
     binindex = static_cast<unsigned int>(timeOfNextPulse*invbinwidth);
     if (binindex >= nbins) break;
     m_tmpArray[binindex] += CLHEP::RandGaussZiggurat::shoot(rndmEngine, 0., 1.);
     timeOfNextPulse += slowPeriod;
   };
  
   //### Then (Anatolis) signal shaping:
   for (unsigned int i(0); i < nbins; ++i) {
     unsigned int limit(i+m_noiseSignalShape.size());
     if (limit > nbins) limit = nbins;
     for (unsigned int j(i); j < limit; ++j) {
       m_cachedSlowNoiseAfterSignalShaping[j] +=
         m_tmpArray[i] * m_noiseSignalShape[j-i] *
         m_fractionOfSlowNoise;
     };
   };
  
 }

◆ setElectronicsNoiseAmplitude()

void TRTElectronicsNoise::setElectronicsNoiseAmplitude ( const double & )

Set electronics noise amplitude.

◆ tabulateNoiseSignalShape()

void TRTElectronicsNoise::tabulateNoiseSignalShape ( )

private

Tabulate noise signal shape.

Extract signal shape from NoiseShape(time) function and store in table.

Definition at line 169 of file TRTElectronicsNoise.cxx.

                                                    {
  
   m_noiseSignalShape.resize(0);
  
   const double binwidth(m_settings->timeInterval()/m_settings->numberOfBins());
  
   //Tabulate:
   double shapemax = 0;
   for ( double time(0.5*binwidth); time < m_settings->timeInterval(); time += binwidth ) {
     m_noiseSignalShape.push_back(this->NoiseShape(time));
     shapemax = std::max(shapemax,std::abs(m_noiseSignalShape.back()));
   }
  
   //Cut of trailing zeroes:
   unsigned int noiseshapebins(m_noiseSignalShape.size()-1);
   for ( ;noiseshapebins>0;--noiseshapebins) {
     if (m_noiseSignalShape.at(noiseshapebins-1)>0.001*shapemax) break;
   }
   m_noiseSignalShape.resize(noiseshapebins);
  
   //Normalize:
   for (double & i : m_noiseSignalShape) {
     i /= shapemax;
   };
  
 }

Member Data Documentation

◆ m_cachedFastNoiseAfterSignalShaping

std::vector<float> TRTElectronicsNoise::m_cachedFastNoiseAfterSignalShaping

private

Cached samples of electronics noise after signal shaping (fast input)

Definition at line 102 of file TRTElectronicsNoise.h.

◆ m_cachedSlowNoiseAfterSignalShaping

std::vector<float> TRTElectronicsNoise::m_cachedSlowNoiseAfterSignalShaping

private

Cached samples of electronics noise after signal shaping (slow input)

Definition at line 104 of file TRTElectronicsNoise.h.

◆ m_fractionOfSlowNoise

double TRTElectronicsNoise::m_fractionOfSlowNoise

private

Definition at line 108 of file TRTElectronicsNoise.h.

◆ m_nbins_periodic

unsigned int TRTElectronicsNoise::m_nbins_periodic

private

Definition at line 109 of file TRTElectronicsNoise.h.

◆ m_noisepars1

std::vector<double> TRTElectronicsNoise::m_noisepars1

private

Noise signal params 1 (t<15.5 ns)

Definition at line 123 of file TRTElectronicsNoise.h.

◆ m_noisepars2

std::vector<double> TRTElectronicsNoise::m_noisepars2

private

Noise signal params 2 (t>15.5 ns)

Definition at line 124 of file TRTElectronicsNoise.h.

◆ m_noiseSignalShape

std::vector<double> TRTElectronicsNoise::m_noiseSignalShape

private

Tabulated noise signal shape.

Definition at line 99 of file TRTElectronicsNoise.h.

◆ m_settings

const TRTDigSettings* TRTElectronicsNoise::m_settings

private

Definition at line 79 of file TRTElectronicsNoise.h.

◆ m_tmpArray

std::vector<float> TRTElectronicsNoise::m_tmpArray

private

Here to avoid repeated memory allocs.

Definition at line 106 of file TRTElectronicsNoise.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TRTElectronicsNoise()

◆ ~TRTElectronicsNoise()

Member Function Documentation

◆ addElectronicsNoise()

◆ getMax()

◆ getSamplesOfMaxLTOverNoiseAmp()

◆ InitializeNoiseShaping()

◆ NoiseShape()

◆ reinitElectronicsNoise()

◆ setElectronicsNoiseAmplitude()

◆ tabulateNoiseSignalShape()

Member Data Documentation

◆ m_cachedFastNoiseAfterSignalShaping

◆ m_cachedSlowNoiseAfterSignalShaping

◆ m_fractionOfSlowNoise

◆ m_nbins_periodic

◆ m_noisepars1

◆ m_noisepars2

◆ m_noiseSignalShape

◆ m_settings

◆ m_tmpArray