#include <ZDCWaveformFermiExp.h>

Inheritance diagram for ZDCWaveformFermiExp:

Collaboration diagram for ZDCWaveformFermiExp:

Public Member Functions
	ZDCWaveformFermiExp ()=delete
	ZDCWaveformFermiExp (const std::string &tag, double initialTauRise, double initialTauFall)
	ZDCWaveformFermiExp (const ZDCWaveformFermiExp &instance)
ZDCWaveformBase *	Duplicate ()
double	evaluate (double time) const
double	evaluateRoot (double x, double p)
double	evaluateRootNoTF1Par (double x, double p)
double	operator() (double x, double p)
const std::string &	getTag () const
std::string	getNameTag () const
const std::string	getName () const
double	getTauRise () const
double	getTauFall () const
unsigned int	getNumAddtlShapeValues () const
double	getAddtlShapeValue (const std::string &name) const
double	getAddtlShapeValue (unsigned int index) const
void	setAddtlShapeValue (std::string name, double value)
void	setAddtlShapeValue (unsigned int index, double value)
void	setTaus (double tauRise, double tauFall)
void	restoreInitial ()
TF1 *	makeWaveformTF1 (ZDCWaveformBase *ptr, double xmin, double xmax, bool useTF1Params=true)
TF1 *	makeWaveformTF1 (ZDCWaveformBase &instance, double xmin, double xmax, bool useTF1Params=true)

Protected Member Functions
double	doEvaluate (double time) const override
virtual std::string	name () const override
void	setAddtlShapeParameters (const std::vector< std::string > &addtlShapeNames, const std::vector< double > &addtlShapeValues)
void	setAddtlShapeValues (const double *values)
void	setAddtlShapeValues (const std::vector< double > &values)

Protected Attributes
double	m_tauRise
double	m_tauFall
std::vector< double >	m_addtlShapeValues

Private Attributes
std::string	m_tag
std::map< std::string, unsigned int >	m_addtlShapeNames
double	m_initialTauRise
double	m_initialTauFall
unsigned int	m_numAddtlShapePars
std::vector< double >	m_addtlShapeInitialValues

Detailed Description

Definition at line 14 of file ZDCWaveformFermiExp.h.

Constructor & Destructor Documentation

◆ ZDCWaveformFermiExp() [1/3]

ZDCWaveformFermiExp::ZDCWaveformFermiExp ( )

delete

◆ ZDCWaveformFermiExp() [2/3]

ZDCWaveformFermiExp::ZDCWaveformFermiExp	(	const std::string &	tag,
		double	initialTauRise,
		double	initialTauFall )

inline

Definition at line 24 of file ZDCWaveformFermiExp.h.

                                                                                          :
    ZDCWaveformBase(tag, initialTauRise, initialTauFall, std::vector<std::string>(), std::vector<double>())
  {}

◆ ZDCWaveformFermiExp() [3/3]

ZDCWaveformFermiExp::ZDCWaveformFermiExp ( const ZDCWaveformFermiExp & instance )

inlineexplicit

Definition at line 28 of file ZDCWaveformFermiExp.h.

28 :

29 ZDCWaveformBase(instance.getTag(), instance.getTauRise(),instance.getTauFall(), std::vector<std::string>(), std::vector<double>()) {};

instance

std::map< std::string, double > instance

Definition Run_To_Get_Tags.h:8

Member Function Documentation

◆ doEvaluate()

double ZDCWaveformFermiExp::doEvaluate ( double time ) const

overrideprotectedvirtual

Implements ZDCWaveformBase.

Reimplemented in ZDCWaveformFermiExpTail.

Definition at line 7 of file ZDCWaveformFermiExp.cxx.

{
  double tau1 = getTauRise();
  double tau2 = getTauFall();
  double shift = -tau1 * std::log(tau2 / tau1 - 1.0);
  double timeShift = time - shift;
  
  double expTerm = std::exp(-timeShift / tau2);
  double fermiTerm = 1. / (1. + std::exp(-timeShift / tau1));
  
  return expTerm * fermiTerm;
}

◆ Duplicate()

ZDCWaveformBase * ZDCWaveformBase::Duplicate ( )

inherited

◆ evaluate()

double ZDCWaveformBase::evaluate ( double time ) const

inlineinherited

Definition at line 81 of file ZDCWaveform.h.

  {
    return doEvaluate(time)/doEvaluate(0);
  }

◆ evaluateRoot()

double ZDCWaveformBase::evaluateRoot	(	double *	x,
		double *	p )

inlineinherited

Definition at line 86 of file ZDCWaveform.h.

                                             {
    return this->operator()(x,p);
  }

◆ evaluateRootNoTF1Par()

double ZDCWaveformBase::evaluateRootNoTF1Par	(	double *	x,
		double *	p )

inlineinherited

Definition at line 90 of file ZDCWaveform.h.

                                                     {
    (void)p;
    return evaluate(x[0]);
  }

◆ getAddtlShapeValue() [1/2]

double ZDCWaveformBase::getAddtlShapeValue ( const std::string & name ) const

inlineinherited

Definition at line 108 of file ZDCWaveform.h.

108{return m_addtlShapeValues.at(m_addtlShapeNames.find(name)->second);}

ZDCWaveformBase::name

virtual std::string name() const =0

ZDCWaveformBase::m_addtlShapeValues

std::vector< double > m_addtlShapeValues

Definition ZDCWaveform.h:45

ZDCWaveformBase::m_addtlShapeNames

std::map< std::string, unsigned int > m_addtlShapeNames

Definition ZDCWaveform.h:33

◆ getAddtlShapeValue() [2/2]

double ZDCWaveformBase::getAddtlShapeValue ( unsigned int index ) const

inlineinherited

Definition at line 109 of file ZDCWaveform.h.

109{return m_addtlShapeValues.at(index);}

◆ getName()

const std::string ZDCWaveformBase::getName ( ) const

inlineinherited

Definition at line 103 of file ZDCWaveform.h.

103{return name();}

◆ getNameTag()

std::string ZDCWaveformBase::getNameTag ( ) const

inlineinherited

Definition at line 102 of file ZDCWaveform.h.

102{return name() + "_" + m_tag;}

ZDCWaveformBase::m_tag

std::string m_tag

Definition ZDCWaveform.h:32

◆ getNumAddtlShapeValues()

unsigned int ZDCWaveformBase::getNumAddtlShapeValues ( ) const

inlineinherited

Definition at line 107 of file ZDCWaveform.h.

107{return m_numAddtlShapePars;}

ZDCWaveformBase::m_numAddtlShapePars

unsigned int m_numAddtlShapePars

Definition ZDCWaveform.h:37

◆ getTag()

const std::string & ZDCWaveformBase::getTag ( ) const

inlineinherited

Definition at line 101 of file ZDCWaveform.h.

101{return m_tag;}

◆ getTauFall()

double ZDCWaveformBase::getTauFall ( ) const

inlineinherited

Definition at line 105 of file ZDCWaveform.h.

105{return m_tauFall;}

ZDCWaveformBase::m_tauFall

double m_tauFall

Definition ZDCWaveform.h:43

◆ getTauRise()

double ZDCWaveformBase::getTauRise ( ) const

inlineinherited

Definition at line 104 of file ZDCWaveform.h.

104{return m_tauRise;}

ZDCWaveformBase::m_tauRise

double m_tauRise

Definition ZDCWaveform.h:42

◆ makeWaveformTF1() [1/2]

TF1 * ZDCWaveformBase::makeWaveformTF1	(	ZDCWaveformBase &	instance,
		double	xmin,
		double	xmax,
		bool	useTF1Params = true )

inlineinherited

Definition at line 163 of file ZDCWaveform.h.

{
  return makeWaveformTF1(&instance, xmin, xmax, useTF1Params);
}

◆ makeWaveformTF1() [2/2]

TF1 * ZDCWaveformBase::makeWaveformTF1	(	ZDCWaveformBase *	ptr,
		double	xmin,
		double	xmax,
		bool	useTF1Params = true )

inlineinherited

Definition at line 133 of file ZDCWaveform.h.

{
  std::string name = ptr->getNameTag() + "_TF1";
 
  TF1* newTF1 = 0;
 
  if (useTF1Params) {
    unsigned int numPar = 2 + ptr->getNumAddtlShapeValues();
 
    newTF1= new TF1(name.c_str(), ptr, &ZDCWaveformBase::evaluateRoot, xmin, xmax, numPar,
            "ZDCWaveformBase", "evaluateRoot");
 
    newTF1->SetParameter(0, ptr->getTauRise());
    newTF1->SetParameter(1, ptr->getTauFall());
    
    if (numPar > 2) {
      for (unsigned int idxpar = 2; idxpar < numPar; idxpar++) {
    newTF1->SetParameter(idxpar, ptr->getAddtlShapeValue(idxpar - 2));
      }
    }
  }
  else {
    newTF1= new TF1(name.c_str(), ptr, &ZDCWaveformBase::evaluateRootNoTF1Par, xmin, xmax, 0,
            "ZDCWaveformBase", "evaluateRoot");
  }
  
  newTF1->SetNpx(1000);
  return newTF1;
}

◆ name()

virtual std::string ZDCWaveformFermiExp::name ( ) const

inlineoverrideprotectedvirtual

Implements ZDCWaveformBase.

Reimplemented in ZDCWaveformFermiExpTail.

Definition at line 19 of file ZDCWaveformFermiExp.h.

19{return "FermiExp";}

◆ operator()()

double ZDCWaveformBase::operator()	(	double *	x,
		double *	p )

inlineinherited

Definition at line 95 of file ZDCWaveform.h.

                                           {
    setTaus(p[0], p[1]);
    if (getNumAddtlShapeValues() > 0) setAddtlShapeValues(p + 2);
    return evaluate(x[0]);
  }

◆ restoreInitial()

void ZDCWaveformBase::restoreInitial ( )

inherited

Definition at line 60 of file ZDCWaveform.cxx.

{
  m_tauRise = m_initialTauRise;
  m_tauFall = m_initialTauFall;
  m_addtlShapeValues = m_addtlShapeInitialValues;
}

◆ setAddtlShapeParameters()

void ZDCWaveformBase::setAddtlShapeParameters	(	const std::vector< std::string > &	addtlShapeNames,
		const std::vector< double > &	addtlShapeValues )

protectedinherited

Definition at line 32 of file ZDCWaveform.cxx.

{
  // Enforce consistency in vector lengths
  //
  m_numAddtlShapePars = addtlShapeNames.size();
  if (m_numAddtlShapePars != addtlShapeValues.size()) throw std::runtime_error("ZDCWaveformBase::setAddtlShapeParameters; Shape name and value size mismatch");
 
  m_addtlShapeNames.clear();
  
  // Insert names into map with index
  //
  for (unsigned int param = 0; param < addtlShapeNames.size(); param++) {
    m_addtlShapeNames.insert({addtlShapeNames[param], param});
  }
 
  // Save shape values, first to "initial", then to the actual
  //
  m_addtlShapeInitialValues = addtlShapeValues;
  m_addtlShapeValues = m_addtlShapeInitialValues;
}

◆ setAddtlShapeValue() [1/2]

void ZDCWaveformBase::setAddtlShapeValue	(	std::string	name,
		double	value )

inherited

◆ setAddtlShapeValue() [2/2]

void ZDCWaveformBase::setAddtlShapeValue	(	unsigned int	index,
		double	value )

inlineinherited

Definition at line 113 of file ZDCWaveform.h.

                                                             {
    m_addtlShapeValues.at(index) = value;
   }

◆ setAddtlShapeValues() [1/2]

void ZDCWaveformBase::setAddtlShapeValues ( const double * values )

protectedinherited

Definition at line 54 of file ZDCWaveform.cxx.

{
  unsigned int nvalues = m_addtlShapeValues.size();
  std::copy_n(values, nvalues, m_addtlShapeValues.begin());
}

◆ setAddtlShapeValues() [2/2]

void ZDCWaveformBase::setAddtlShapeValues ( const std::vector< double > & values )

inlineprotectedinherited

Definition at line 53 of file ZDCWaveform.h.

                                                            {
    setAddtlShapeValues(&values[0]);
  }

◆ setTaus()

void ZDCWaveformBase::setTaus	(	double	tauRise,
		double	tauFall )

inlineinherited

Definition at line 117 of file ZDCWaveform.h.

  {
    m_tauRise = tauRise;
    m_tauFall = tauFall;
  }

Member Data Documentation

◆ m_addtlShapeInitialValues

std::vector<double> ZDCWaveformBase::m_addtlShapeInitialValues

privateinherited

Definition at line 38 of file ZDCWaveform.h.

◆ m_addtlShapeNames

std::map<std::string, unsigned int> ZDCWaveformBase::m_addtlShapeNames

privateinherited

Definition at line 33 of file ZDCWaveform.h.

◆ m_addtlShapeValues

std::vector<double> ZDCWaveformBase::m_addtlShapeValues

protectedinherited

Definition at line 45 of file ZDCWaveform.h.

◆ m_initialTauFall

double ZDCWaveformBase::m_initialTauFall

privateinherited

Definition at line 36 of file ZDCWaveform.h.

◆ m_initialTauRise

double ZDCWaveformBase::m_initialTauRise

privateinherited

Definition at line 35 of file ZDCWaveform.h.

◆ m_numAddtlShapePars

unsigned int ZDCWaveformBase::m_numAddtlShapePars

privateinherited

Definition at line 37 of file ZDCWaveform.h.

◆ m_tag

std::string ZDCWaveformBase::m_tag

privateinherited

Definition at line 32 of file ZDCWaveform.h.

◆ m_tauFall

double ZDCWaveformBase::m_tauFall

protectedinherited

Definition at line 43 of file ZDCWaveform.h.

◆ m_tauRise

double ZDCWaveformBase::m_tauRise

protectedinherited

Definition at line 42 of file ZDCWaveform.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZDCWaveformFermiExp() [1/3]

◆ ZDCWaveformFermiExp() [2/3]

◆ ZDCWaveformFermiExp() [3/3]

Member Function Documentation

◆ doEvaluate()

◆ Duplicate()

◆ evaluate()

◆ evaluateRoot()

◆ evaluateRootNoTF1Par()

◆ getAddtlShapeValue() [1/2]

◆ getAddtlShapeValue() [2/2]

◆ getName()

◆ getNameTag()

◆ getNumAddtlShapeValues()

◆ getTag()

◆ getTauFall()

◆ getTauRise()

◆ makeWaveformTF1() [1/2]

◆ makeWaveformTF1() [2/2]

◆ name()

◆ operator()()

◆ restoreInitial()

◆ setAddtlShapeParameters()

◆ setAddtlShapeValue() [1/2]

◆ setAddtlShapeValue() [2/2]

◆ setAddtlShapeValues() [1/2]

◆ setAddtlShapeValues() [2/2]

◆ setTaus()

Member Data Documentation

◆ m_addtlShapeInitialValues

◆ m_addtlShapeNames

◆ m_addtlShapeValues

◆ m_initialTauFall

◆ m_initialTauRise

◆ m_numAddtlShapePars

◆ m_tag

◆ m_tauFall

◆ m_tauRise