piece-wise exponential pulse, modelled as an output of a capacitor More...

#include <QIEInputPulse.h>

Public Member Functions
	Expo ()
	The default constructor.

	Expo (float k, float tmax)
	Main constructor.

virtual	~Expo ()=default
	main constructor

float	GetRise ()
	Get Rise time of the pulse.

float	GetFall ()
	Get Fall time of the pulse.

void	SetRiseFall (float rr, float ff)
	Set Rise and Fall time of the pulse.

float	EvalSingle (float T, int id) override
	Evaluate the pulse at time T.

float	Integrate (float T1, float T2) override
	Integrate the pulse from T1 to T2.

float	Max (int id) override
	maximum of the pulse

float	Derivative (float T, int id) override
	Differentiate pulse at time T.

Public Member Functions inherited from trigscint::QIEInputPulse
virtual	~QIEInputPulse ()=default
	Destructor.

float	Eval (float T)
	Evaluate the pulse train at time T.

void	AddPulse (float toff, float ampl)
	To add a pulse to the collection.

int	GetNPulses ()
	Get the number of pulses in the collection.

Private Member Functions
float	I_Int (float T, int id)
	Indefinite integral at time T.

Private Attributes
float	k_
	1/RC time constant (for the capacitor)

float	tmax_
	time when pulse attains maximum

float	rt_ {-1}
	Rise Time.

float	ft_ {-1}
	Fall Time.

Additional Inherited Members
Protected Attributes inherited from trigscint::QIEInputPulse
std::vector< float >	toff_
	collection of pulse time offsets

std::vector< float >	ampl_
	collection of pulse amplitudes

Detailed Description

piece-wise exponential pulse, modelled as an output of a capacitor

Note: This is the preferred inpute pulse shape

Definition at line 122 of file QIEInputPulse.h.

Constructor & Destructor Documentation

◆ Expo() [1/2]

trigscint::Expo::Expo ( )

The default constructor.

Definition at line 100 of file QIEInputPulse.cxx.

100{}

◆ Expo() [2/2]

trigscint::Expo::Expo	(	float	k,
		float	tmax
	)

Main constructor.

Parameters

k	= 1/(RC time const)
tmax	= relative time of the pulse maximum (in ns)

Definition at line 107 of file QIEInputPulse.cxx.

                              {
  k_ = k;
  tmax_ = tmax;
 
  rt_ = (log(9 + exp(-k_ * tmax_)) - log(1 + 9 * exp(-k_ * tmax_))) / k_;
  ft_ = log(9) / k_;
}

References ft_, k_, rt_, and tmax_.

◆ ~Expo()

virtual trigscint::Expo::~Expo ( )

virtualdefault

main constructor

Destructor

Member Function Documentation

◆ Derivative()

float trigscint::Expo::Derivative	(	float	T,
		int	id
	)

overridevirtual

Differentiate pulse at time T.

Implements trigscint::QIEInputPulse.

Definition at line 157 of file QIEInputPulse.cxx.

                                      {
  if (id >= ampl_.size()) return 0;
  if (T <= toff_[id]) return 0;
 
  float t = T - toff_[id];
  // Normalization constant
  float nc = ampl_[id] / tmax_;
 
  if (t <= tmax_) return (nc * k_ * exp(-k_ * t));
  return (-nc * k_ * (1 - exp(-k_ * tmax_)) * exp(k_ * (tmax_ - t)));
}

References trigscint::QIEInputPulse::ampl_, k_, tmax_, and trigscint::QIEInputPulse::toff_.

◆ EvalSingle()

float trigscint::Expo::EvalSingle	(	float	T,
		int	id
	)

overridevirtual

Evaluate the pulse at time T.

Implements trigscint::QIEInputPulse.

Definition at line 124 of file QIEInputPulse.cxx.

                                       {
  if (id >= ampl_.size()) return 0;
  if (t_ <= toff_[id]) return 0;
  if (ampl_[id] == 0) return 0;
 
  // Normalization constant
  float nc = ampl_[id] / tmax_;
  // time relative to the offset
  float T = t_ - toff_[id];
  if (T < tmax_) {
    return (nc * (1 - exp(-k_ * T)));
  } else {
    return (nc * (1 - exp(-k_ * tmax_)) * exp(k_ * (tmax_ - T)));
  }
  return -1;
}

References trigscint::QIEInputPulse::ampl_, k_, tmax_, and trigscint::QIEInputPulse::toff_.

◆ GetFall()

float trigscint::Expo::GetFall ( )

inline

Get Fall time of the pulse.

Definition at line 148 of file QIEInputPulse.h.

148{ return ft_; }

References ft_.

◆ GetRise()

float trigscint::Expo::GetRise ( )

inline

Get Rise time of the pulse.

Definition at line 143 of file QIEInputPulse.h.

143{ return rt_; }

References rt_.

◆ I_Int()

float trigscint::Expo::I_Int	(	float	T,
		int	id
	)

private

Indefinite integral at time T.

Definition at line 169 of file QIEInputPulse.cxx.

                                 {
  if (T <= toff_[id]) return 0;
  float t = T - toff_[id];
  // Normalization constant
  float nc = ampl_[id] / tmax_;
  if (t < tmax_) return (nc * (k_ * t + exp(-k_ * t) - 1) / k_);
 
  float c1 = (1 - exp(-k_ * tmax_)) / k_;
  float c2 = tmax_ - c1 * exp(k_ * (tmax_ - t));
  return nc * c2;
}

References trigscint::QIEInputPulse::ampl_, k_, tmax_, and trigscint::QIEInputPulse::toff_.

Referenced by Integrate().

◆ Integrate()

float trigscint::Expo::Integrate	(	float	T1,
		float	T2
	)

overridevirtual

Integrate the pulse from T1 to T2.

Implements trigscint::QIEInputPulse.

Definition at line 147 of file QIEInputPulse.cxx.

                                        {
  float val = 0;
  for (int id = 0; id < ampl_.size(); id++) {
    if (ampl_[id] > 0 && T2 > toff_[id]) {
      val += I_Int(T2, id) - I_Int(T1, id);
    }
  }
  return val;
}

References trigscint::QIEInputPulse::ampl_, I_Int(), and trigscint::QIEInputPulse::toff_.

◆ Max()

float trigscint::Expo::Max ( int id )

overridevirtual

maximum of the pulse

Implements trigscint::QIEInputPulse.

Definition at line 141 of file QIEInputPulse.cxx.

                      {
  // Normalization constant
  float nc = ampl_[id] / tmax_;
  return nc * (1 - exp(-k_ * tmax_));
}

References trigscint::QIEInputPulse::ampl_, k_, and tmax_.

◆ SetRiseFall()

void trigscint::Expo::SetRiseFall	(	float	rr,
		float	ff
	)

Set Rise and Fall time of the pulse.

Parameters

rr	Rise time
ff	Fall time

Definition at line 116 of file QIEInputPulse.cxx.

                                         {
  rt_ = rr;
  ft_ = ff;
 
  k_ = log(9) / ft_;
  tmax_ = (log(9 - exp(-k_ * rt_)) - log(9 * exp(-k_ * rt_) - 1)) / k_;
}

References ft_, k_, rt_, and tmax_.

Member Data Documentation

◆ ft_

float trigscint::Expo::ft_ {-1}

private

Fall Time.

Definition at line 185 of file QIEInputPulse.h.

185{-1};

Referenced by Expo(), GetFall(), and SetRiseFall().

◆ k_

float trigscint::Expo::k_

private

1/RC time constant (for the capacitor)

Definition at line 179 of file QIEInputPulse.h.

Referenced by Derivative(), EvalSingle(), Expo(), I_Int(), Max(), and SetRiseFall().

◆ rt_

float trigscint::Expo::rt_ {-1}

private

Rise Time.

Definition at line 183 of file QIEInputPulse.h.

183{-1};

Referenced by Expo(), GetRise(), and SetRiseFall().

◆ tmax_

float trigscint::Expo::tmax_

private

time when pulse attains maximum

Definition at line 181 of file QIEInputPulse.h.

Referenced by Derivative(), EvalSingle(), Expo(), I_Int(), Max(), and SetRiseFall().

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

TrigScint/include/TrigScint/QIEInputPulse.h
TrigScint/src/TrigScint/QIEInputPulse.cxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Expo() [1/2]

◆ Expo() [2/2]

◆ ~Expo()

Member Function Documentation

◆ Derivative()

◆ EvalSingle()

◆ GetFall()

◆ GetRise()

◆ I_Int()

◆ Integrate()

◆ Max()

◆ SetRiseFall()

Member Data Documentation

◆ ft_

◆ k_

◆ rt_

◆ tmax_