ZDCWaveformBase Class Reference

#include <ZDCWaveform.h>

Inheritance diagram for ZDCWaveformBase:

Collaboration diagram for ZDCWaveformBase:

Public Member Functions
	ZDCWaveformBase (std::string tag, double initialTauRise, double initialTauFall, const std::vector< std::string > &addtlShapeNames, const std::vector< double > &addtlShapeValues)
virtual	~ZDCWaveformBase ()=default
	ZDCWaveformBase (const ZDCWaveformBase &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
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)
virtual double	doEvaluate (double time) const =0
virtual std::string	name () const =0
	ZDCWaveformBase ()=delete

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 30 of file ZDCWaveform.h.

Constructor & Destructor Documentation

ZDCWaveformBase() [1/3]

ZDCWaveformBase::ZDCWaveformBase ( )

protecteddelete

ZDCWaveformBase() [2/3]

ZDCWaveformBase::ZDCWaveformBase	(	std::string	tag,
		double	initialTauRise,
		double	initialTauFall,
		const std::vector< std::string > &	addtlShapeNames,
		const std::vector< double > &	addtlShapeValues
	)

Definition at line 8 of file ZDCWaveform.cxx.

                                                            :
  m_tag( std::move(tag) ),
  m_initialTauRise(initialTauRise),
  m_initialTauFall(initialTauFall),
  m_numAddtlShapePars(addtlShapeNames.size()),
  m_tauRise(initialTauRise),
  m_tauFall(initialTauFall)
{      
  setAddtlShapeParameters(addtlShapeNames, addtlShapeValues);
}

~ZDCWaveformBase()

virtual ZDCWaveformBase::~ZDCWaveformBase ( )

virtualdefault

ZDCWaveformBase() [3/3]

ZDCWaveformBase::ZDCWaveformBase

(

const ZDCWaveformBase &

instance

)

Definition at line 20 of file ZDCWaveform.cxx.

                                                                :
  m_tag( std::move(instance.m_tag) ),
  m_addtlShapeNames(instance.m_addtlShapeNames),
  m_initialTauRise(instance.m_initialTauRise),
  m_initialTauFall(instance.m_initialTauFall),
  m_numAddtlShapePars(instance.m_numAddtlShapePars),
  m_addtlShapeInitialValues(instance.m_addtlShapeInitialValues),
  m_tauRise(instance.m_tauRise),
  m_tauFall(instance.m_tauFall)
{      
}

Member Function Documentation

doEvaluate()

virtual double ZDCWaveformBase::doEvaluate ( double  time ) const

protectedpure virtual

Implemented in ZDCWaveformFermiExpTail, ZDCWaveformLTLinStep, and ZDCWaveformFermiExp.

Duplicate()

ZDCWaveformBase* ZDCWaveformBase::Duplicate

(

)

evaluate()

double ZDCWaveformBase::evaluate ( double  time ) const

inline

Definition at line 81 of file ZDCWaveform.h.

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

evaluateRoot()

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

inline

Definition at line 86 of file ZDCWaveform.h.

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

evaluateRootNoTF1Par()

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

inline

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

inline

Definition at line 108 of file ZDCWaveform.h.

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

getAddtlShapeValue() [2/2]

double ZDCWaveformBase::getAddtlShapeValue ( unsigned int  index ) const

inline

Definition at line 109 of file ZDCWaveform.h.

{return m_addtlShapeValues.at(index);}

getName()

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

inline

Definition at line 103 of file ZDCWaveform.h.

{return name();}

getNameTag()

std::string ZDCWaveformBase::getNameTag ( ) const

inline

Definition at line 102 of file ZDCWaveform.h.

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

getNumAddtlShapeValues()

unsigned int ZDCWaveformBase::getNumAddtlShapeValues ( ) const

inline

Definition at line 107 of file ZDCWaveform.h.

{return m_numAddtlShapePars;}

getTag()

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

inline

Definition at line 101 of file ZDCWaveform.h.

{return m_tag;}

getTauFall()

double ZDCWaveformBase::getTauFall ( ) const

inline

Definition at line 105 of file ZDCWaveform.h.

{return m_tauFall;}

getTauRise()

double ZDCWaveformBase::getTauRise ( ) const

inline

Definition at line 104 of file ZDCWaveform.h.

{return m_tauRise;}

makeWaveformTF1() [1/2]

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

inline

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  )

inline

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 ZDCWaveformBase::name ( ) const

protectedpure virtual

Implemented in ZDCWaveformFermiExpTail, ZDCWaveformLTLinStep, and ZDCWaveformFermiExp.

operator()()

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

inline

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

(

)

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  )

protected

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
	)

setAddtlShapeValue() [2/2]

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

inline

Definition at line 113 of file ZDCWaveform.h.

                                                             {
    m_addtlShapeValues.at(index) = value;
   }

setAddtlShapeValues() [1/2]

void ZDCWaveformBase::setAddtlShapeValues ( const double *  values )

protected

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 )

inlineprotected

Definition at line 53 of file ZDCWaveform.h.

                                                            {
    setAddtlShapeValues(&values[0]);
  }

setTaus()

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

inline

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

private

Definition at line 38 of file ZDCWaveform.h.

m_addtlShapeNames

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

private

Definition at line 33 of file ZDCWaveform.h.

m_addtlShapeValues

std::vector<double> ZDCWaveformBase::m_addtlShapeValues

protected

Definition at line 45 of file ZDCWaveform.h.

m_initialTauFall

double ZDCWaveformBase::m_initialTauFall

private

Definition at line 36 of file ZDCWaveform.h.

m_initialTauRise

double ZDCWaveformBase::m_initialTauRise

private

Definition at line 35 of file ZDCWaveform.h.

m_numAddtlShapePars

unsigned int ZDCWaveformBase::m_numAddtlShapePars

private

Definition at line 37 of file ZDCWaveform.h.

m_tag

std::string ZDCWaveformBase::m_tag

private

Definition at line 32 of file ZDCWaveform.h.

m_tauFall

double ZDCWaveformBase::m_tauFall

protected

Definition at line 43 of file ZDCWaveform.h.

m_tauRise

double ZDCWaveformBase::m_tauRise

protected

Definition at line 42 of file ZDCWaveform.h.

---

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

• ZDCWaveform.h
• ZDCWaveform.cxx