PMT analogue signal processor. More...

#include <JPMTAnalogueSignalProcessor.hh>

Inheritance diagram for JDETECTOR::JPMTAnalogueSignalProcessor:

Public Member Functions
	JPMTAnalogueSignalProcessor (const JPMTParameters &parameters=JPMTParameters())
	Constructor. More...

void	configure ()
	Configure internal parameters. More...

double	getDecayTime () const
	Get decay time. More...

double	getT1 () const
	Get time at transition point from Gaussian to exponential. More...

double	getY1 () const
	Get amplitude at transition point from Gaussian to exponential. More...

double	getStartOfLinearisation () const
	Get transition point from a model dependent to linear relation between time-over-threshold and number of photo-electrons. More...

double	getAmplitude (const double t1_ns) const
	Get amplitude at given time for a one photo-electron pulse. More...

double	getRiseTime (const double npe, const double th) const
	Get time to pass from threshold to top of analogue pulse. More...

double	getDecayTime (const double npe, const double th) const
	Get time to pass from top of analogue pulse to threshold. More...

double	getSaturation (const double y) const
	Get function value with saturation. More...

double	getDerivativeOfSaturation (const double y) const
	Get derivative of function value with saturation. More...

double	getGainSpread (int NPE) const
	Get gain spread for given number of photo-electrons. More...

double	getIntegralOfProbability (const double xmin, const double xmax, const int NPE) const
	Get integral of probability. More...

void	setPMTParameters (const JPMTParameters &parameters)
	Set PMT parameters. More...

virtual bool	applyQE () const
	Apply relative QE. More...

virtual double	getRandomTime (const double t_ns) const
	Get randomised time according transition time distribution. More...

virtual bool	compare (const JPhotoElectron &first, const JPhotoElectron &second) const
	Compare (arrival times of) photo-electrons. More...

virtual double	getRandomAmplitude (const int NPE) const
	Get randomised amplitude according gain and gain spread. More...

virtual double	getProbability (const double npe, const int NPE) const
	Get probability for given charge. More...

virtual bool	applyThreshold (const double npe) const
	Apply threshold. More...

virtual double	getRiseTime (const double npe) const
	Get time to reach threshold. More...

virtual double	getTimeOverThreshold (const double npe) const
	Get time-over-threshold (ToT). More...

virtual double	getDerivative (const double npe) const
	Get derivative of number of photo-electrons to time-over-threshold. More...

virtual double	getSurvivalProbability (const int NPE) const
	Probability that a hit survives the simulation of the PMT. More...

void	operator() (const JCalibration &calibration, const JPMTData< JPMTSignal > &input, JPMTData< JPMTPulse > &output) const
	Process hits. More...

virtual void	merge (JPMTData< JPMTPulse > &data) const
	Merging of PMT hits. More...

double	getNPE (const double tot_ns, const double eps=1.0e-3) const
	Get number of photo-electrons. More...

const JPMTParameters &	getPMTParameters () const
	Get PMT parameters. More...

bool	is_valid () const
	Check validity of PMT parameters. More...

JProperties	getProperties (const JEquationParameters &equation=JPMTParameters::getEquationParameters())
	Get properties of this class. More...

JProperties	getProperties (const JEquationParameters &equation=JPMTParameters::getEquationParameters()) const
	Get properties of this class. More...

Static Public Member Functions
static double	getMaximalRiseTime (const double th)
	Get maximal rise time for given threshold. More...

static double	getTH0 ()
	Get lower threshold for rise time evaluation. More...

static double	getTH1 ()
	Get upper threshold for rise time evaluation. More...

static double	getTmin ()
	Get two photo-electron resolution for time-over-threshold. More...

static double	getQmin ()
	Get minimal width of charge distribution. More...

static JEquationParameters &	getEquationParameters ()
	Get equation parameters. More...

static void	setEquationParameters (const JEquationParameters &equation)
	Set equation parameters. More...

Public Attributes
double	QE
	relative quantum efficiency More...

double	gain
	gain [unit] More...

double	gainSpread
	gain spread [unit] More...

double	riseTime_ns
	rise time of analogue pulse [ns] More...

double	TTS_ns
	transition time spread [ns] More...

double	threshold
	threshold [npe] More...

double	slope
	slope [ns/npe] More...

double	saturation
	saturation [ns] More...

bool	slewing
	time slewing of analogue signal More...

Protected Attributes
double	decayTime_ns
	decay time [ns] More...

double	t1
	time at match point [ns] More...

double	y1
	amplitude at match point [npe] More...

double	x1
	Transition point from a logarithmic to a linear relation between time-over-threshold and number of photo-electrons. More...

Private Attributes
JPMTData< JPhotoElectron >	buffer

Friends
std::istream &	operator>> (std::istream &in, JPMTAnalogueSignalProcessor &object)
	Read PMT signal from input. More...

Detailed Description

PMT analogue signal processor.

This class provides for an implementation of the JDETECTOR::JPMTSignalProcessorInterface using a specific model for the analogue pulse of the PMT.
In this, the leading edge of the analogue pulse from the PMT is assumed to be a Gaussian and the tail an exponential.
The width of the Gaussian is referred to as the rise time and the inverse slope of the exponential to the decay time.
The two functions are matched at a point where the values and first derivatives are identical.
Note that the decay time is related to the rise time via the specification JDETECTOR::TIME_OVER_THRESHOLD_NS.

The charge distribution is assumed to be a Gaussian which is centered at the specified gain and truncated by the specified threshold.

The transition times are generated according the specified spread as follows.

If the specified transition time spread (TTS) is negative, the transition times are generated according to the measurements (see method JDETECTOR::getTransitionTime).
If the specified TTS is positive, the transition times are generated according a Gaussian with a sigma equals to the TTS.
If the TTS is zero, the transition times are generated without any spread.

Definition at line 46 of file JPMTAnalogueSignalProcessor.hh.

Constructor & Destructor Documentation

◆ JPMTAnalogueSignalProcessor()

JDETECTOR::JPMTAnalogueSignalProcessor::JPMTAnalogueSignalProcessor ( const JPMTParameters & parameters = JPMTParameters() )

inline

Constructor.

Parameters

parameters PMT parameters

Definition at line 55 of file JPMTAnalogueSignalProcessor.hh.

                                                                                      :
       JPMTSignalProcessorInterface(),
       JPMTParameters(parameters),
       decayTime_ns(0.0),
       t1(0.0),
       y1(0.0),
       x1(std::numeric_limits<double>::max())
     {
       configure();
     }

Member Function Documentation

◆ configure()

void JDETECTOR::JPMTAnalogueSignalProcessor::configure ( )

inline

Configure internal parameters.

This method provides the implementations for

matching of the leading edge of the analogue pulse (Gaussian) and the tail (exponential); and
determination of number of photo-electrons above which the time-over-threshold linearly depends on the number of photo-electrons (apart from saturation).

Note that this method will throw an error if the value of the rise time (i.e. width of the Gaussian) is too large with respect to the specification JDETECTOR::TIME_OVER_THRESHOLD_NS.

Definition at line 78 of file JPMTAnalogueSignalProcessor.hh.

     {
       static const int    N         = 100;
       static const double precision = 1.0e-3;
  
       // check rise time      
  
       if (riseTime_ns > getMaximalRiseTime(threshold)) {
         THROW(JValueOutOfRange, "JPMTAnalogueSignalProcessor::configure(): Invalid rise time [ns] " << riseTime_ns);
       } 
  
       // decay time
  
       const double y  = -log(threshold);
  
       const double a  =  y;
       const double b  =  riseTime_ns * sqrt(2.0*y) - TIME_OVER_THRESHOLD_NS;
       const double c  =  0.5*riseTime_ns*riseTime_ns;
       
       const double Q  =  b*b - 4.0*a*c;
  
       if (Q > 0.0) 
         decayTime_ns = (-b + sqrt(Q)) / (2.0*a);
       else
         decayTime_ns =  -b / (2.0*a);
  
       // fix matching of Gaussian and exponential
  
       const double x  =  riseTime_ns / decayTime_ns;
  
       t1 = riseTime_ns*x;
       y1 = exp(-0.5*x*x);
  
       // determine transition point to linear dependence of time-over-threshold as a function of number of photo-electrons
  
       const double v = slope / getDerivativeOfSaturation(getTimeOverThreshold(1.0));
  
       x1 = std::numeric_limits<double>::max();   // disable linearisation
  
       double xmin = 1.0;
       double xmax = 1.0 / (getDerivative(1.0) * slope);
  
       for (int i = 0; i != N; ++i) {
  
         const double x = 0.5 * (xmin + xmax);
         const double u = getDerivative(x) * v;
  
         if (fabs(1.0 - u) < precision) {
           break;
         }
  
         if (u < 1.0)
           xmin = x;
         else
           xmax = x;
       }
  
       x1 = 0.5 * (xmin + xmax);
     }

◆ getDecayTime() [1/2]

double JDETECTOR::JPMTAnalogueSignalProcessor::getDecayTime ( ) const

inline

Get decay time.

Returns: decay time [ns]

Definition at line 144 of file JPMTAnalogueSignalProcessor.hh.

     {
       return decayTime_ns;
     }

◆ getT1()

double JDETECTOR::JPMTAnalogueSignalProcessor::getT1 ( ) const

inline

Get time at transition point from Gaussian to exponential.

Returns: time [ns]

Definition at line 155 of file JPMTAnalogueSignalProcessor.hh.

     {
       return t1;
     }

◆ getY1()

double JDETECTOR::JPMTAnalogueSignalProcessor::getY1 ( ) const

inline

Get amplitude at transition point from Gaussian to exponential.

Returns: amplitude [npe]

Definition at line 166 of file JPMTAnalogueSignalProcessor.hh.

     {
       return y1;
     }

◆ getStartOfLinearisation()

double JDETECTOR::JPMTAnalogueSignalProcessor::getStartOfLinearisation ( ) const

inline

Get transition point from a model dependent to linear relation between time-over-threshold and number of photo-electrons.

Returns: number of photo-electrons [npe]

Definition at line 177 of file JPMTAnalogueSignalProcessor.hh.

     {
       return x1;
     }

◆ getAmplitude()

double JDETECTOR::JPMTAnalogueSignalProcessor::getAmplitude ( const double t1_ns ) const

inline

Get amplitude at given time for a one photo-electron pulse.

Parameters

t1_ns time [ns]

Returns: amplitude [npe]

Definition at line 189 of file JPMTAnalogueSignalProcessor.hh.

     {
       if (t1_ns < t1) {
  
         const double x = t1_ns / riseTime_ns;
         
         return exp(-0.5*x*x);                                // Gaussian
  
       } else {
  
         const double x = t1_ns / decayTime_ns;
  
         return exp(-x) / y1;                                 // exponential
       }
     }

◆ getRiseTime() [1/2]

double JDETECTOR::JPMTAnalogueSignalProcessor::getRiseTime	(	const double	npe,
		const double	th
	)		const

inline

Get time to pass from threshold to top of analogue pulse.

In this, the leading edge of the analogue pulse is assumed to be Gaussian.

Parameters

npe	number of photo-electrons
th	threshold [npe]

Returns: time [ns]

Definition at line 214 of file JPMTAnalogueSignalProcessor.hh.

     {
       return riseTime_ns * sqrt(2.0*log(npe/th));            // Gaussian
     }

◆ getDecayTime() [2/2]

double JDETECTOR::JPMTAnalogueSignalProcessor::getDecayTime	(	const double	npe,
		const double	th
	)		const

inline

Get time to pass from top of analogue pulse to threshold.

In this, the trailing edge of the analogue pulse is assumed to be exponential.

Parameters

npe	number of photo-electrons
th	threshold [npe]

Returns: time [ns]

Definition at line 228 of file JPMTAnalogueSignalProcessor.hh.

     {
       if (npe*y1 > th)
         return decayTime_ns * (log(npe/th) - log(y1));       // exponential
       else
         return riseTime_ns * sqrt(2.0*log(npe/th));          // Gaussian
     }

◆ getMaximalRiseTime()

static double JDETECTOR::JPMTAnalogueSignalProcessor::getMaximalRiseTime ( const double th )

inlinestatic

Get maximal rise time for given threshold.

Note that the rise time is entirely constraint by the specification JDETECTOR::TIME_OVER_THRESHOLD_NS.

Parameters

th	threshold [npe]

Returns: rise time [ns]

Definition at line 245 of file JPMTAnalogueSignalProcessor.hh.

     {
       if (th > 0.0 && th < 1.0)
         return 0.5 * TIME_OVER_THRESHOLD_NS / sqrt(-2.0*log(th));
       else
         THROW(JValueOutOfRange, "JPMTAnalogueSignalProcessor::getMaximalRiseTime(): Invalid threshold " << th);
     }

◆ getSaturation()

double JDETECTOR::JPMTAnalogueSignalProcessor::getSaturation ( const double y ) const

inline

Get function value with saturation.

Parameters

y value

Returns: value

Definition at line 260 of file JPMTAnalogueSignalProcessor.hh.

     {
       return saturation / sqrt(y*y + saturation*saturation);
     }

◆ getDerivativeOfSaturation()

double JDETECTOR::JPMTAnalogueSignalProcessor::getDerivativeOfSaturation ( const double y ) const

inline

Get derivative of function value with saturation.

Parameters

y value

Returns: value

Definition at line 272 of file JPMTAnalogueSignalProcessor.hh.

     {
       return (saturation*saturation + y*y) * sqrt(saturation*saturation + y*y) / (saturation * saturation * saturation);
     }

◆ getGainSpread()

double JDETECTOR::JPMTAnalogueSignalProcessor::getGainSpread ( int NPE ) const

inline

Get gain spread for given number of photo-electrons.

Parameters

NPE	number of photo-electrons

Returns: gain spread

Definition at line 284 of file JPMTAnalogueSignalProcessor.hh.

     {
       return sqrt((double) NPE * gain) * gainSpread;
     }

◆ getIntegralOfProbability()

double JDETECTOR::JPMTAnalogueSignalProcessor::getIntegralOfProbability	(	const double	xmin,
		const double	xmax,
		const int	NPE
	)		const

inline

Get integral of probability.

Parameters

xmin	minimum number of photo-electrons
xmax	maximum number of photo-electrons
NPE	true number of photo-electrons

Returns: probability

Definition at line 298 of file JPMTAnalogueSignalProcessor.hh.

     {
       double zmin = xmin;
       double zmax = xmax;
  
       if (zmin < threshold) { zmin = threshold; }
       if (zmax < threshold) { zmax = threshold; }
         
       const double mu    = NPE * gain;
       const double sigma = getGainSpread(NPE);
  
       return (0.5 * TMath::Erfc((zmin - mu) / sqrt(2.0) / sigma)  -
               0.5 * TMath::Erfc((zmax - mu) / sqrt(2.0) / sigma));
     }

◆ setPMTParameters()

void JDETECTOR::JPMTAnalogueSignalProcessor::setPMTParameters ( const JPMTParameters & parameters )

inline

Set PMT parameters.

Parameters

parameters PMT parameters

Definition at line 319 of file JPMTAnalogueSignalProcessor.hh.

     {
       static_cast<JPMTParameters&>(*this).setPMTParameters(parameters);
  
       configure();
     }

◆ applyQE()

virtual bool JDETECTOR::JPMTAnalogueSignalProcessor::applyQE ( ) const

inlinevirtual

Apply relative QE.

Returns: true if accepted; false if rejected

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 349 of file JPMTAnalogueSignalProcessor.hh.

     {
       if      (QE <= 0.0)
         return false;
       else if (QE <  1.0)
         return gRandom->Rndm() < QE;
       else
         return true;
     }

◆ getRandomTime()

virtual double JDETECTOR::JPMTAnalogueSignalProcessor::getRandomTime ( const double t_ns ) const

inlinevirtual

Get randomised time according transition time distribution.

Parameters

t_ns time [ns]

Returns: time [ns]

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 366 of file JPMTAnalogueSignalProcessor.hh.

     {
       if (TTS_ns < 0.0)
         return t_ns + getTransitionTime(gRandom->Rndm());
       else
         return gRandom->Gaus(t_ns, TTS_ns);
     }

◆ compare()

virtual bool JDETECTOR::JPMTAnalogueSignalProcessor::compare	(	const JPhotoElectron &	first,
		const JPhotoElectron &	second
	)		const

inlinevirtual

Compare (arrival times of) photo-electrons.

Parameters

first	first photo-electron
second	second photo-electron

Returns: true if arrival times of photo-electrons are within rise time of analogue pulses; else false

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 382 of file JPMTAnalogueSignalProcessor.hh.

     {
       return second.t_ns < first.t_ns + riseTime_ns;
     }

◆ getRandomAmplitude()

virtual double JDETECTOR::JPMTAnalogueSignalProcessor::getRandomAmplitude ( const int NPE ) const

inlinevirtual

Get randomised amplitude according gain and gain spread.

Parameters

NPE	number of photo-electrons

Returns: number of photo-electrons

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 394 of file JPMTAnalogueSignalProcessor.hh.

     {
       double x;
  
       do {
         x = gRandom->Gaus(NPE*gain, getGainSpread(NPE));
       } while (x < 0.0);
  
       return x;
     }

◆ getProbability()

virtual double JDETECTOR::JPMTAnalogueSignalProcessor::getProbability	(	const double	npe,
		const int	NPE
	)		const

inlinevirtual

Get probability for given charge.

Parameters

npe	observed number of photo-electrons
NPE	true number of photo-electrons

Returns: probability [npe^-1]

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 413 of file JPMTAnalogueSignalProcessor.hh.

     {
       if (npe >= threshold) {
         
         const double mu    = NPE * gain;
         const double sigma = getGainSpread(NPE);
         const double V     = 0.5 * TMath::Erfc((threshold - mu) / sqrt(2.0) / sigma);
         
         return TMath::Gaus(npe, mu, sigma, kTRUE) / V;
       }
  
       return 0.0;
     }

◆ applyThreshold()

virtual bool JDETECTOR::JPMTAnalogueSignalProcessor::applyThreshold ( const double npe ) const

inlinevirtual

Apply threshold.

Parameters

npe	number of photo-electrons

Returns: true if pass; else false

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 434 of file JPMTAnalogueSignalProcessor.hh.

     {
       return npe >= threshold;
     }

◆ getRiseTime() [2/2]

virtual double JDETECTOR::JPMTAnalogueSignalProcessor::getRiseTime ( const double npe ) const

inlinevirtual

Get time to reach threshold.

Note that the rise time is defined to be zero for a one photo-electron signal.

Parameters

npe	number of photo-electrons

Returns: time [ns]

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 448 of file JPMTAnalogueSignalProcessor.hh.

     {
       if (slewing)
         return ((getRiseTime(npe, getTH0())  -  getRiseTime(npe, this->threshold)) -
                 (getRiseTime(1.0, getTH0())  -  getRiseTime(1.0, this->threshold)));
       else
         return 0.0;
     }

◆ getTimeOverThreshold()

virtual double JDETECTOR::JPMTAnalogueSignalProcessor::getTimeOverThreshold ( const double npe ) const

inlinevirtual

Get time-over-threshold (ToT).

Parameters

npe	number of photo-electrons

Returns: ToT [ns]

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 464 of file JPMTAnalogueSignalProcessor.hh.

     {
       if (npe > threshold) {
         
         double tot = 0.0;
  
         if (npe*y1 > threshold) {
  
           if (npe <= getStartOfLinearisation()) {
  
             tot += getRiseTime (npe, threshold);                        // Gaussian
             tot += getDecayTime(npe, threshold);                        // exponential
  
           } else {
  
             tot += getRiseTime (getStartOfLinearisation(), threshold);  // Gaussian
             tot += getDecayTime(getStartOfLinearisation(), threshold);  // exponential
  
             tot += slope * (npe - getStartOfLinearisation());           // linear
           }
  
         } else {
  
           tot += getRiseTime(npe, threshold);                           // Gaussian
           tot += getRiseTime(npe, threshold);                           // Gaussian
         }
  
         return tot * getSaturation(tot);
  
       } else {
  
         return 0.0;
       }
     }

◆ getDerivative()

virtual double JDETECTOR::JPMTAnalogueSignalProcessor::getDerivative ( const double npe ) const

inlinevirtual

Get derivative of number of photo-electrons to time-over-threshold.

Parameters

npe	number of photo-electrons

Returns: dnpe/dToT [ns^-1]

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 506 of file JPMTAnalogueSignalProcessor.hh.

     {
       if (npe >= threshold) {
  
         const double z  = riseTime_ns / sqrt(2.0 * log(npe/threshold));
  
         double y = 0.0;
  
         if (npe*y1 > threshold) {
           
           if (npe <= getStartOfLinearisation())
             y = npe / (z + decayTime_ns);           // Gaussian + exponential
           else
             y = 1.0 / slope;                        // linear
  
         } else {
  
           y = npe / (2.0 * z);                      // Gaussian + Gaussian
         }
         
         return y * getDerivativeOfSaturation(getTimeOverThreshold(npe));
           
       } else {
         
         return 0.0;
       }
     }

◆ getSurvivalProbability()

virtual double JDETECTOR::JPMTAnalogueSignalProcessor::getSurvivalProbability ( const int NPE ) const

inlinevirtual

Probability that a hit survives the simulation of the PMT.

Parameters

NPE	number of photo-electrons

Returns: probability

Reimplemented from JDETECTOR::JPMTSignalProcessorInterface.

Definition at line 541 of file JPMTAnalogueSignalProcessor.hh.

     {
       if        (QE <= 0.0) {
  
         return 0.0;
  
       } else if (QE <= 1.0) {
  
         double P = 0.0;
  
         for (int i = 1; i <= NPE; ++i) {
  
           const double p     = TMath::Binomial(NPE, i) * TMath::Power(QE, i) * TMath::Power(1.0 - QE, NPE - i);
           const double mu    = i * gain;
           const double sigma = getGainSpread(i);
           const double V     = 0.5 * TMath::Erfc((threshold  - mu) / sqrt(2.0) / sigma);
           const double W     = 0.5 * TMath::Erfc((0.0        - mu) / sqrt(2.0) / sigma);
  
           P += p*V/W;
         }
         
         return P;
  
       } else {
  
         THROW(JValueOutOfRange, "JPMTAnalogueSignalProcessor::getSurvivalProbability: Invalid QE " << QE);
       }
     }

◆ getTH0()

static double JDETECTOR::JPMTAnalogueSignalProcessor::getTH0 ( )

inlinestatic

Get lower threshold for rise time evaluation.

Returns: threshold [npe]

Definition at line 576 of file JPMTAnalogueSignalProcessor.hh.

     {
       return 0.1;
     }

◆ getTH1()

static double JDETECTOR::JPMTAnalogueSignalProcessor::getTH1 ( )

inlinestatic

Get upper threshold for rise time evaluation.

Returns: threshold [npe]

Definition at line 587 of file JPMTAnalogueSignalProcessor.hh.

     {
       return 0.9;
     }

◆ operator()()

void JDETECTOR::JPMTSignalProcessorInterface::operator()	(	const JCalibration &	calibration,
		const JPMTData< JPMTSignal > &	input,
		JPMTData< JPMTPulse > &	output
	)		const

inlineinherited

Process hits.

Parameters

calibration	PMT calibration
input	PMT signals
output	PMT hits

Definition at line 92 of file JPMTSignalProcessorInterface.hh.

     {
       // apply transition time distribution to each photo-electron.
  
       buffer.clear();
       
       for (JPMTData<JPMTSignal>::const_iterator hit = input.begin(); hit != input.end(); ++hit) {
         for (int i = 0; i != hit->npe; ++i) {
           if (applyQE()) {
             buffer.push_back(JPhotoElectron(getRandomTime(hit->t_ns)));
           }
         }
       }
  
       if (!buffer.empty()) {
       
         buffer.push_back(JPhotoElectron::getEndMarker());
       
         buffer.sort();
       
       
         // generate PMT hits from time sequence of photo-electrons.
         
         for (JPMTData<JPhotoElectron>::const_iterator q = buffer.begin(), p = q++; q != buffer.end(); ++q) {
           
           while (compare(*p,*q)) {
             ++q;
           }
           
           const double npe = getRandomAmplitude(distance(p,q));
           
           if (applyThreshold(npe)) {
             output.push_back(JPMTPulse(putTime(p->t_ns + getRiseTime(npe), calibration), getTimeOverThreshold(npe)));
           }
           
           p = q;
         }
         
         // merge overlapping PMT hits.
       
         merge(output);
       }
     }

◆ merge()

virtual void JDETECTOR::JPMTSignalProcessorInterface::merge ( JPMTData< JPMTPulse > & data ) const

inlinevirtualinherited

Merging of PMT hits.

Hits with overlapping time-over-threshold signals should -de facto- be combined. In this, the leading edge is maintained and the time-over-threshold is set to the difference between the overall trailing and leading edges. As a result, the number of PMT hits may be reduced.

Parameters

data PMT hits

Definition at line 284 of file JPMTSignalProcessorInterface.hh.

     {
       using namespace std;
       
       JPMTData<JPMTPulse>::iterator out = data.begin();
       
       for (JPMTData<JPMTPulse>::iterator i = data.begin(); i != data.end(); ) {
         
         double t1 = i->t_ns;
         double t2 = i->t_ns + i->tot_ns;
         
         while (++i != data.end() && i->t_ns < t2 + getTmin()) {
           t2 = max(t2, i->t_ns + i->tot_ns);
         }
         
         out->t_ns   = t1;
         out->tot_ns = t2 - t1;
         
         ++out;
       }
       
       data.resize(distance(data.begin(), out));
     }

◆ getNPE()

double JDETECTOR::JPMTSignalProcessorInterface::getNPE	(	const double	tot_ns,
		const double	eps = `1.0e-3`
	)		const

inlineinherited

Get number of photo-electrons.

Parameters

tot_ns	time over threshold [ns]
eps	precision

Returns: number of photo-electrons

Definition at line 316 of file JPMTSignalProcessorInterface.hh.

     {
       static const int N = 100;
  
       if (tot_ns > 0.0) {
  
         double xmin =   0.0;
         double xmax = 100.0;
       
         for (int i = 0; i != N; ++i) {
         
           const double x = 0.5 * (xmin + xmax);
           const double y = this->getTimeOverThreshold(x);
           
           if (fabs(y - tot_ns) < eps) {
             return x;
           }
           
           if (y < tot_ns)
             xmin = x;
           else
             xmax = x;
         }
  
         return 0.5 * (xmin + xmax);
  
       } else {
  
         double xmin = 0.0;
         double xmax = 2.0;
       
         for (int i = 0; i != N; ++i) {
           
           const double x = 0.5 * (xmin + xmax);
           const double y = this->getTimeOverThreshold(x);
  
           if (y == 0.0)
             xmin = x;
           else
             xmax = x;
         }
  
         return 0.5 * (xmin + xmax);
       }
     }

◆ getTmin()

static double JDETECTOR::JPMTSignalProcessorInterface::getTmin ( )

inlinestaticinherited

Get two photo-electron resolution for time-over-threshold.

Returns: minimal time [ns]

Definition at line 369 of file JPMTSignalProcessorInterface.hh.

     {
       return 1.0;
     }

◆ getQmin()

static double JDETECTOR::JPMTSignalProcessorInterface::getQmin ( )

inlinestaticinherited

Get minimal width of charge distribution.

Returns: minimal charge [npe]

Definition at line 380 of file JPMTSignalProcessorInterface.hh.

     {
       return 1.0e-3;
     }

◆ getPMTParameters()

const JPMTParameters& JDETECTOR::JPMTParameters::getPMTParameters ( ) const

inlineinherited

Get PMT parameters.

Returns: PMT parameters

Definition at line 95 of file JPMTParameters.hh.

     {
       return static_cast<const JPMTParameters&>(*this);
     }

◆ is_valid()

bool JDETECTOR::JPMTParameters::is_valid ( ) const

inlineinherited

Check validity of PMT parameters.

Returns: true if valid; else false

Definition at line 117 of file JPMTParameters.hh.

     {
       if (this->QE         < 0.0 ||
           this->gain       < 0.0 ||
           this->gainSpread < 0.0 ||
           this->threshold  < 0.0) {
         return false;
       }
  
       return true;
     }

◆ getEquationParameters()

static JEquationParameters& JDETECTOR::JPMTParameters::getEquationParameters ( )

inlinestaticinherited

Get equation parameters.

Returns: equation parameters

Definition at line 175 of file JPMTParameters.hh.

     {
       static JEquationParameters equation("=", ",", "./", "#");
  
       return equation;
     }

◆ setEquationParameters()

static void JDETECTOR::JPMTParameters::setEquationParameters ( const JEquationParameters & equation )

inlinestaticinherited

Set equation parameters.

Parameters

equation equation parameters

Definition at line 188 of file JPMTParameters.hh.

     {
       getEquationParameters() = equation;
     }

◆ getProperties() [1/2]

JProperties JDETECTOR::JPMTParameters::getProperties ( const JEquationParameters & equation = JPMTParameters::getEquationParameters() )

inlineinherited

Get properties of this class.

Parameters

equation equation parameters

Definition at line 199 of file JPMTParameters.hh.

     {
       return JPMTParametersHelper(*this, equation);
     }

◆ getProperties() [2/2]

JProperties JDETECTOR::JPMTParameters::getProperties ( const JEquationParameters & equation = JPMTParameters::getEquationParameters() ) const

inlineinherited

Get properties of this class.

Parameters

equation equation parameters

Definition at line 210 of file JPMTParameters.hh.

     {
       return JPMTParametersHelper(*this, equation);
     }

Friends And Related Function Documentation

◆ operator>>

std::istream& operator>>	(	std::istream &	in,
		JPMTAnalogueSignalProcessor &	object
	)

friend

Read PMT signal from input.

Parameters

in	input stream
object	PMT signal

Returns: input stream

Definition at line 334 of file JPMTAnalogueSignalProcessor.hh.

     {
       in >> static_cast<JPMTParameters&>(object);
       
       object.configure();
  
       return in;
     }

Member Data Documentation

◆ decayTime_ns

double JDETECTOR::JPMTAnalogueSignalProcessor::decayTime_ns

protected

decay time [ns]

Definition at line 593 of file JPMTAnalogueSignalProcessor.hh.

◆ t1

double JDETECTOR::JPMTAnalogueSignalProcessor::t1

protected

time at match point [ns]

Definition at line 594 of file JPMTAnalogueSignalProcessor.hh.

◆ y1

double JDETECTOR::JPMTAnalogueSignalProcessor::y1

protected

amplitude at match point [npe]

Definition at line 595 of file JPMTAnalogueSignalProcessor.hh.

◆ x1

double JDETECTOR::JPMTAnalogueSignalProcessor::x1

protected

Transition point from a logarithmic to a linear relation between time-over-threshold and number of photo-electrons.

Measurements by B. Schermer and R. Bruijn at Nikhef.

Definition at line 601 of file JPMTAnalogueSignalProcessor.hh.

◆ buffer

JPMTData<JPhotoElectron> JDETECTOR::JPMTSignalProcessorInterface::buffer

mutableprivateinherited

Definition at line 387 of file JPMTSignalProcessorInterface.hh.

◆ QE

double JDETECTOR::JPMTParameters::QE

inherited

relative quantum efficiency

Definition at line 216 of file JPMTParameters.hh.

◆ gain

double JDETECTOR::JPMTParameters::gain

inherited

gain [unit]

Definition at line 217 of file JPMTParameters.hh.

◆ gainSpread

double JDETECTOR::JPMTParameters::gainSpread

inherited

gain spread [unit]

Definition at line 218 of file JPMTParameters.hh.

◆ riseTime_ns

double JDETECTOR::JPMTParameters::riseTime_ns

inherited

rise time of analogue pulse [ns]

Definition at line 219 of file JPMTParameters.hh.

◆ TTS_ns

double JDETECTOR::JPMTParameters::TTS_ns

inherited

transition time spread [ns]

Definition at line 220 of file JPMTParameters.hh.

◆ threshold

double JDETECTOR::JPMTParameters::threshold

inherited

threshold [npe]

Definition at line 221 of file JPMTParameters.hh.

◆ slope

double JDETECTOR::JPMTParameters::slope

inherited

slope [ns/npe]

Definition at line 222 of file JPMTParameters.hh.

◆ saturation

double JDETECTOR::JPMTParameters::saturation

inherited

saturation [ns]

Definition at line 223 of file JPMTParameters.hh.

◆ slewing

bool JDETECTOR::JPMTParameters::slewing

inherited

time slewing of analogue signal

Definition at line 224 of file JPMTParameters.hh.

The documentation for this struct was generated from the following file:

JPMTAnalogueSignalProcessor.hh

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JPMTAnalogueSignalProcessor()

Member Function Documentation

◆ configure()

◆ getDecayTime() [1/2]

◆ getT1()

◆ getY1()

◆ getStartOfLinearisation()

◆ getAmplitude()

◆ getRiseTime() [1/2]

◆ getDecayTime() [2/2]

◆ getMaximalRiseTime()

◆ getSaturation()

◆ getDerivativeOfSaturation()

◆ getGainSpread()

◆ getIntegralOfProbability()

◆ setPMTParameters()

◆ applyQE()

◆ getRandomTime()

◆ compare()

◆ getRandomAmplitude()

◆ getProbability()

◆ applyThreshold()

◆ getRiseTime() [2/2]

◆ getTimeOverThreshold()

◆ getDerivative()

◆ getSurvivalProbability()

◆ getTH0()

◆ getTH1()

◆ operator()()

◆ merge()

◆ getNPE()

◆ getTmin()

◆ getQmin()

◆ getPMTParameters()

◆ is_valid()

◆ getEquationParameters()

◆ setEquationParameters()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

Friends And Related Function Documentation

◆ operator>>

Member Data Documentation

◆ decayTime_ns

◆ t1

◆ y1

◆ x1

◆ buffer

◆ QE

◆ gain

◆ gainSpread

◆ riseTime_ns

◆ TTS_ns

◆ threshold

◆ slope

◆ saturation

◆ slewing