#include <ZDCFitWrapper.h>

Inheritance diagram for ZDCFitExpFermiPreExp:

Collaboration diagram for ZDCFitExpFermiPreExp:

Public Member Functions
	ZDCFitExpFermiPreExp (const std::string &tag, float tmin, float tmax, float tau1, float tau2, float defExpTau, float fixExpTau)
	~ZDCFitExpFermiPreExp ()
virtual void	DoInitialize (float initialAmp, float initialT0, float ampMin, float ampMax) override
virtual void	SetT0FitLimits (float tMin, float tMax) override
virtual void	SetInitialExpPulse (float amp) override
virtual void	ConstrainFit () override
virtual void	UnconstrainFit () override
virtual float	GetAmplitude () const override
virtual float	GetAmpError () const override
virtual float	GetTau1 () const override
virtual float	GetTau2 () const override
virtual float	GetTime () const override
virtual float	GetExpAmp () const override
virtual float	GetExpTau () const override
virtual float	GetShapeParameter (size_t index) const override
virtual float	GetBkgdMaxFraction () const override
virtual double	operator() (const double x, const double p) override
bool	fixExpTau () const
float	getDefaultExpTau () const
void	Initialize (float initialAmp, float initialT0, float ampMin, float ampMax)
void	Initialize (float initialAmp, float initialT0, float ampMin, float ampMax, float fitTmin, float fitTmax, float fitTRef)
void	SetAmpMinMax (float minAmp, float maxAmp)
void	SetT0Range (float t0Min, float t0Max)
float	GetMinAmp () const
float	GetMaxAmp () const
float	GetTMin () const
float	GetTMax () const
float	GetT0Min () const
float	GetT0Max () const
float	GetTMinAdjust () const
virtual std::shared_ptr< TF1 >	GetWrapperTF1 ()
virtual const TF1 *	GetWrapperTF1 () const
virtual TF1 *	GetWrapperTF1RawPtr () const

Protected Attributes
float	m_defaultTau
bool	m_fixTau

Private Attributes
float	m_tau1 {0}
float	m_tau2 {0}
float	m_timeCorr {0}
double	m_norm
std::shared_ptr< TF1 >	m_expFermiFunc {0}
std::shared_ptr< TF1 >	m_expFermiPreFunc {0}
std::shared_ptr< TF1 >	m_wrapperTF1 {}
float	m_tmin {0}
float	m_tmax {0}
float	m_ampMin {0}
float	m_ampMax {0}
float	m_t0Min {0}
float	m_t0Max {0}
bool	m_adjTLimitsEvent {false}
float	m_tminAdjust {0}
float	m_tempTmin {0}
float	m_tempTmax {0}

Detailed Description

Definition at line 580 of file ZDCFitWrapper.h.

Constructor & Destructor Documentation

◆ ZDCFitExpFermiPreExp()

ZDCFitExpFermiPreExp::ZDCFitExpFermiPreExp	(	const std::string &	tag,
		float	tmin,
		float	tmax,
		float	tau1,
		float	tau2,
		float	defExpTau,
		float	fixExpTau )

Definition at line 363 of file ZDCFitWrapper.cxx.

                                                             :
  ZDCPreExpFitWrapper(std::make_shared<TF1>(("ExpFermiPreExp" + tag).c_str(), this, tmin, tmax, 6), defExpTau, fixExpTau),
  m_tau1(tau1), m_tau2(tau2)
{
  // Create the reference function that we use to evaluate ExpFermiFit more efficiently
  //
  std::string funcNameRefFunc = "ExpFermiPreExpRefFunc" + tag;
 
  m_expFermiFunc = std::make_shared<TF1>(funcNameRefFunc.c_str(), ZDCFermiExpFit, tmin, tmax, 8);
 
  // The parameters for the FermiExp
  //
  m_expFermiFunc->SetParameter(0, 1);
  m_expFermiFunc->SetParameter(1, 0);
  m_expFermiFunc->SetParameter(2, m_tau1);
  m_expFermiFunc->SetParameter(3, m_tau2);
  m_expFermiFunc->SetParameter(4, 0);
 
  m_norm = 1. / m_expFermiFunc->GetMaximum();
  m_timeCorr = m_tau1 * std::log(m_tau2 / m_tau1 - 1.0);
 
  // Now set up the actual TF1
  //
  std::shared_ptr<TF1> theTF1 = ZDCFitWrapper::GetWrapperTF1();
  theTF1->SetParName(0, "Amp");
  theTF1->SetParName(1, "T0");
  theTF1->SetParName(2, "Amp_{pre}");
  theTF1->SetParName(3, "tau_{pre}");
  theTF1->SetParName(4, "tausqrt_{pre}");
  theTF1->SetParName(5, "C");
 
  theTF1->SetParLimits(1, tmin, tmax);
  theTF1->SetParLimits(2, -1, 8196); // Increase the upper range to 2 times of ADC range to deal with large exponential tail case of pre-pulse.
  theTF1->SetParLimits(3, 6, 30);
  theTF1->SetParLimits(4, -0.2, 0.2);
  theTF1->SetParLimits(5, -50, 50);
}

◆ ~ZDCFitExpFermiPreExp()

ZDCFitExpFermiPreExp::~ZDCFitExpFermiPreExp ( )

inline

Definition at line 594 of file ZDCFitWrapper.h.

594{}

Member Function Documentation

◆ ConstrainFit()

void ZDCFitExpFermiPreExp::ConstrainFit ( )

overridevirtual

Implements ZDCFitWrapper.

Definition at line 402 of file ZDCFitWrapper.cxx.

{
  // We force the constant term and per-pulse amplitude to zero
  //
  std::shared_ptr<TF1> theTF1 = GetWrapperTF1();
 
  theTF1->FixParameter(2, 0);
  theTF1->FixParameter(3, getDefaultExpTau());
  theTF1->FixParameter(5, 0);
}

◆ DoInitialize()

void ZDCFitExpFermiPreExp::DoInitialize	(	float	initialAmp,
		float	initialT0,
		float	ampMin,
		float	ampMax )

overridevirtual

Implements ZDCFitWrapper.

Definition at line 428 of file ZDCFitWrapper.cxx.

{
  GetWrapperTF1()->SetParameter(0, initialAmp);
  GetWrapperTF1()->SetParameter(1, initialT0);
  GetWrapperTF1()->SetParameter(2, 0);
  GetWrapperTF1()->SetParameter(3, getDefaultExpTau());
  GetWrapperTF1()->SetParameter(4, 0.);
  GetWrapperTF1()->SetParameter(5, 0);
 
  GetWrapperTF1()->SetParLimits(0, ampMin, ampMax);
 
  // Set parameter errors for fit step size
  //
  double ampStep = std::min(0.05*initialAmp, std::abs(ampMax - initialAmp)/2.);
  GetWrapperTF1()->SetParError(0, ampStep);
  GetWrapperTF1()->SetParError(1, 1.0);
  GetWrapperTF1()->SetParError(2, ampStep/2);
  GetWrapperTF1()->SetParError(3, 1.0);
  GetWrapperTF1()->SetParError(4, 0.025);
  GetWrapperTF1()->SetParError(5, 1.0);
}

◆ fixExpTau()

bool ZDCPreExpFitWrapper::fixExpTau ( ) const

inlineinherited

Definition at line 156 of file ZDCFitWrapper.h.

156{return m_fixTau;}

ZDCPreExpFitWrapper::m_fixTau

bool m_fixTau

Definition ZDCFitWrapper.h:147

◆ GetAmpError()

virtual float ZDCFitExpFermiPreExp::GetAmpError ( ) const

inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 608 of file ZDCFitWrapper.h.

608{return GetWrapperTF1()->GetParError(0); }

◆ GetAmplitude()

virtual float ZDCFitExpFermiPreExp::GetAmplitude ( ) const

inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 607 of file ZDCFitWrapper.h.

607{return GetWrapperTF1()->GetParameter(0); }

◆ GetBkgdMaxFraction()

virtual float ZDCFitExpFermiPreExp::GetBkgdMaxFraction ( ) const

inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 628 of file ZDCFitWrapper.h.

  {
    const TF1* theTF1 = ZDCFitWrapper::GetWrapperTF1();
    double maxTime = GetTime();
 
    double amp = theTF1->GetParameter(0);
    if (amp <= 0) return -1;
    
    double preAmp = theTF1->GetParameter(2);
    double preT0 = theTF1->GetParameter(3);
 
    double deltaTPre = maxTime - preT0;
    double background = preAmp * m_norm * m_expFermiFunc->operator()(deltaTPre);
 
    return background / (amp + background);
  }

◆ getDefaultExpTau()

float ZDCPreExpFitWrapper::getDefaultExpTau ( ) const

inlineinherited

Definition at line 157 of file ZDCFitWrapper.h.

157{return m_defaultTau;}

ZDCPreExpFitWrapper::m_defaultTau

float m_defaultTau

Definition ZDCFitWrapper.h:146

◆ GetExpAmp()

virtual float ZDCFitExpFermiPreExp::GetExpAmp ( ) const

inlineoverridevirtual

Implements ZDCPreExpFitWrapper.

Definition at line 617 of file ZDCFitWrapper.h.

617{return GetWrapperTF1()->GetParameter(2);}

◆ GetExpTau()

virtual float ZDCFitExpFermiPreExp::GetExpTau ( ) const

inlineoverridevirtual

Implements ZDCPreExpFitWrapper.

Definition at line 618 of file ZDCFitWrapper.h.

618{return GetWrapperTF1()->GetParameter(3);}

◆ GetMaxAmp()

float ZDCFitWrapper::GetMaxAmp ( ) const

inlineinherited

Definition at line 87 of file ZDCFitWrapper.h.

87{return m_ampMax;}

ZDCFitWrapper::m_ampMax

float m_ampMax

Definition ZDCFitWrapper.h:27

◆ GetMinAmp()

float ZDCFitWrapper::GetMinAmp ( ) const

inlineinherited

Definition at line 86 of file ZDCFitWrapper.h.

86{return m_ampMin;}

ZDCFitWrapper::m_ampMin

float m_ampMin

Definition ZDCFitWrapper.h:26

◆ GetShapeParameter()

virtual float ZDCFitExpFermiPreExp::GetShapeParameter ( size_t index ) const

inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 620 of file ZDCFitWrapper.h.

  {
    if (index == 0) return m_tau1;
    else if (index == 1) return m_tau2;
    else if (index < 5) return GetWrapperTF1()->GetParameter(index);
    else throw std::runtime_error("Fit parameter does not exist.");
  }

◆ GetT0Max()

float ZDCFitWrapper::GetT0Max ( ) const

inlineinherited

Definition at line 97 of file ZDCFitWrapper.h.

                         {
    if (m_adjTLimitsEvent) return m_tempTmax;
    else return m_t0Max;
  }

◆ GetT0Min()

float ZDCFitWrapper::GetT0Min ( ) const

inlineinherited

Definition at line 92 of file ZDCFitWrapper.h.

                         {
    if (m_adjTLimitsEvent) return m_tempTmin;
    else return m_t0Min;
  }

◆ GetTau1()

virtual float ZDCFitExpFermiPreExp::GetTau1 ( ) const

inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 610 of file ZDCFitWrapper.h.

610{return m_tau1;}

◆ GetTau2()

virtual float ZDCFitExpFermiPreExp::GetTau2 ( ) const

inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 611 of file ZDCFitWrapper.h.

611{return m_tau2;}

◆ GetTime()

virtual float ZDCFitExpFermiPreExp::GetTime ( ) const

inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 613 of file ZDCFitWrapper.h.

                                         {
    return GetWrapperTF1()->GetParameter(1) + m_timeCorr; // Correct the time to the maximum
  }

◆ GetTMax()

float ZDCFitWrapper::GetTMax ( ) const

inlineinherited

Definition at line 90 of file ZDCFitWrapper.h.

90{return m_tmax;}

ZDCFitWrapper::m_tmax

float m_tmax

Definition ZDCFitWrapper.h:24

◆ GetTMin()

float ZDCFitWrapper::GetTMin ( ) const

inlineinherited

Definition at line 89 of file ZDCFitWrapper.h.

89{return m_tmin;}

ZDCFitWrapper::m_tmin

float m_tmin

Definition ZDCFitWrapper.h:23

◆ GetTMinAdjust()

float ZDCFitWrapper::GetTMinAdjust ( ) const

inlineinherited

Definition at line 102 of file ZDCFitWrapper.h.

102{return m_tminAdjust;}

ZDCFitWrapper::m_tminAdjust

float m_tminAdjust

Definition ZDCFitWrapper.h:33

◆ GetWrapperTF1() [1/2]

virtual std::shared_ptr< TF1 > ZDCFitWrapper::GetWrapperTF1 ( )

inlinevirtualinherited

Definition at line 110 of file ZDCFitWrapper.h.

110{return m_wrapperTF1;}

ZDCFitWrapper::m_wrapperTF1

std::shared_ptr< TF1 > m_wrapperTF1

Definition ZDCFitWrapper.h:21

◆ GetWrapperTF1() [2/2]

virtual const TF1 * ZDCFitWrapper::GetWrapperTF1 ( ) const

inlinevirtualinherited

Definition at line 111 of file ZDCFitWrapper.h.

111{return m_wrapperTF1.get();}

◆ GetWrapperTF1RawPtr()

virtual TF1 * ZDCFitWrapper::GetWrapperTF1RawPtr ( ) const

inlinevirtualinherited

Definition at line 112 of file ZDCFitWrapper.h.

112{return m_wrapperTF1.get();}

◆ Initialize() [1/2]

void ZDCFitWrapper::Initialize	(	float	initialAmp,
		float	initialT0,
		float	ampMin,
		float	ampMax )

inherited

Definition at line 9 of file ZDCFitWrapper.cxx.

{
  // Clear the errors on the TF1 because retaining the errors seems to affect 
  //   the convergence of fits
  //
  unsigned int npar = GetWrapperTF1()->GetNpar();
  std::vector<double> zeroVec(npar, 0.0);
  GetWrapperTF1()->SetParErrors(&zeroVec[0]);
 
  // If we adjusted the time range on the previous event, restore to default
  //
  if (m_adjTLimitsEvent) {
    SetT0FitLimits(m_t0Min, m_t0Max);
 
    m_adjTLimitsEvent = false;
    m_tminAdjust = 0;
  }
 
  SetAmpMinMax(ampMin, ampMax);
 
  DoInitialize(initialAmp, initialT0, ampMin, ampMax);
}

◆ Initialize() [2/2]

void ZDCFitWrapper::Initialize	(	float	initialAmp,
		float	initialT0,
		float	ampMin,
		float	ampMax,
		float	fitTmin,
		float	fitTmax,
		float	fitTRef )

inherited

Definition at line 32 of file ZDCFitWrapper.cxx.

{
  // Clear the errors on the TF1 because retaining the errors seems to affect 
  //   the convergence of fits
  //
  unsigned int npar = GetWrapperTF1()->GetNpar();
  std::vector<double> zeroVec(npar, 0.0);
  GetWrapperTF1()->SetParErrors(&zeroVec[0]);
 
  m_adjTLimitsEvent = true;
 
  m_tminAdjust = fitTRef; // Note: this is the time corresponding to the sample used for presample subtraction 
 
  m_tempTmin = std::max(m_t0Min, fitTmin);
  m_tempTmax = std::min(m_t0Max, fitTmax);
  
  SetAmpMinMax(ampMin, ampMax);
  SetT0FitLimits(m_tempTmin, m_tempTmax);
 
  DoInitialize(initialAmp, initialT0, ampMin, ampMax);
}

◆ operator()()

virtual double ZDCFitExpFermiPreExp::operator()	(	const double *	x,
		const double *	p )

inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 645 of file ZDCFitWrapper.h.

  {
    double t = x[0];
 
    double amp = p[0];
    double t0 = p[1];
    double expAmp = p[2];
    double expTau = p[3];
    double expSqrtTau = p[4];
    double C = p[5];
 
    double deltaT = t - t0;
    double pulse =  amp * m_norm * m_expFermiFunc->operator()(deltaT);
 
    // We subtract off the value of the exponential pulse at the minimum time (nominally 0),
    //   because it would have been included in the baseline subtraction
    //
    double tRef = GetTMinAdjust();
    double expPre = 0;
    if (t > 0 && std::abs(expSqrtTau)>1e-6) expPre = expAmp * (std::exp(-t/expTau-expSqrtTau*std::sqrt(t)) - std::exp(-tRef/expTau));
    else expPre = expAmp * (std::exp(-t/expTau) - std::exp(-tRef/expTau));
      
    return C + pulse + expPre;
  }

◆ SetAmpMinMax()

void ZDCFitWrapper::SetAmpMinMax	(	float	minAmp,
		float	maxAmp )

inlineinherited

Definition at line 63 of file ZDCFitWrapper.h.

  {
    m_ampMin = minAmp;
    m_ampMax = maxAmp;
  }

◆ SetInitialExpPulse()

virtual void ZDCFitExpFermiPreExp::SetInitialExpPulse ( float amp )

inlineoverridevirtual

Implements ZDCPreExpFitWrapper.

Definition at line 599 of file ZDCFitWrapper.h.

  {
    GetWrapperTF1()->SetParameter(2, std::max(amp, (float) 0.5)); //0.5 here ensures that we're above lower limit (0)   
  }

◆ SetT0FitLimits()

void ZDCFitExpFermiPreExp::SetT0FitLimits	(	float	tMin,
		float	tMax )

overridevirtual

Implements ZDCFitWrapper.

Definition at line 450 of file ZDCFitWrapper.cxx.

{
  std::shared_ptr<TF1> theTF1 = GetWrapperTF1();
  theTF1->SetParLimits(1, t0Min, t0Max);
}

◆ SetT0Range()

void ZDCFitWrapper::SetT0Range	(	float	t0Min,
		float	t0Max )

inlineinherited

Definition at line 69 of file ZDCFitWrapper.h.

  {
    m_t0Min = t0Min;
    m_t0Max = t0Max;
 
    SetT0FitLimits(t0Min, t0Max);
  }

◆ UnconstrainFit()

void ZDCFitExpFermiPreExp::UnconstrainFit ( )

overridevirtual

Implements ZDCFitWrapper.

Definition at line 412 of file ZDCFitWrapper.cxx.

{
  std::shared_ptr<TF1> theTF1 = GetWrapperTF1();
 
  theTF1->ReleaseParameter(2);
  theTF1->SetParLimits(2, -1, 8196); // Increase the upper range to 2 times of ADC range to deal with large exponential tail case of pre-pulse.
 
  theTF1->ReleaseParameter(3);
  theTF1->SetParLimits(3, 6, 30);
  theTF1->SetParameter(3, getDefaultExpTau());
  
  theTF1->ReleaseParameter(5);
  theTF1->SetParLimits(5, -50, 50);
  theTF1->SetParameter(5, 0);
}

Member Data Documentation

◆ m_adjTLimitsEvent

bool ZDCFitWrapper::m_adjTLimitsEvent {false}

privateinherited

Definition at line 32 of file ZDCFitWrapper.h.

32{false};

◆ m_ampMax

float ZDCFitWrapper::m_ampMax {0}

privateinherited

Definition at line 27 of file ZDCFitWrapper.h.

27{0};

◆ m_ampMin

float ZDCFitWrapper::m_ampMin {0}

privateinherited

Definition at line 26 of file ZDCFitWrapper.h.

26{0};

◆ m_defaultTau

float ZDCPreExpFitWrapper::m_defaultTau

protectedinherited

Definition at line 146 of file ZDCFitWrapper.h.

◆ m_expFermiFunc

std::shared_ptr<TF1> ZDCFitExpFermiPreExp::m_expFermiFunc {0}

private

Definition at line 588 of file ZDCFitWrapper.h.

588{0};

◆ m_expFermiPreFunc

std::shared_ptr<TF1> ZDCFitExpFermiPreExp::m_expFermiPreFunc {0}

private

Definition at line 589 of file ZDCFitWrapper.h.

589{0};

◆ m_fixTau

bool ZDCPreExpFitWrapper::m_fixTau

protectedinherited

Definition at line 147 of file ZDCFitWrapper.h.

◆ m_norm

double ZDCFitExpFermiPreExp::m_norm

private

Definition at line 586 of file ZDCFitWrapper.h.

◆ m_t0Max

float ZDCFitWrapper::m_t0Max {0}

privateinherited

Definition at line 30 of file ZDCFitWrapper.h.

30{0};

◆ m_t0Min

float ZDCFitWrapper::m_t0Min {0}

privateinherited

Definition at line 29 of file ZDCFitWrapper.h.

29{0};

◆ m_tau1

float ZDCFitExpFermiPreExp::m_tau1 {0}

private

Definition at line 583 of file ZDCFitWrapper.h.

583{0};

◆ m_tau2

float ZDCFitExpFermiPreExp::m_tau2 {0}

private

Definition at line 584 of file ZDCFitWrapper.h.

584{0};

◆ m_tempTmax

float ZDCFitWrapper::m_tempTmax {0}

privateinherited

Definition at line 35 of file ZDCFitWrapper.h.

35{0};

◆ m_tempTmin

float ZDCFitWrapper::m_tempTmin {0}

privateinherited

Definition at line 34 of file ZDCFitWrapper.h.

34{0};

◆ m_timeCorr

float ZDCFitExpFermiPreExp::m_timeCorr {0}

private

Definition at line 585 of file ZDCFitWrapper.h.

585{0};

◆ m_tmax

float ZDCFitWrapper::m_tmax {0}

privateinherited

Definition at line 24 of file ZDCFitWrapper.h.

24{0};

◆ m_tmin

float ZDCFitWrapper::m_tmin {0}

privateinherited

Definition at line 23 of file ZDCFitWrapper.h.

23{0};

◆ m_tminAdjust

float ZDCFitWrapper::m_tminAdjust {0}

privateinherited

Definition at line 33 of file ZDCFitWrapper.h.

33{0};

◆ m_wrapperTF1

std::shared_ptr<TF1> ZDCFitWrapper::m_wrapperTF1 {}

privateinherited

Definition at line 21 of file ZDCFitWrapper.h.

21{};

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZDCFitExpFermiPreExp()

◆ ~ZDCFitExpFermiPreExp()

Member Function Documentation

◆ ConstrainFit()

◆ DoInitialize()

◆ fixExpTau()

◆ GetAmpError()

◆ GetAmplitude()

◆ GetBkgdMaxFraction()

◆ getDefaultExpTau()

◆ GetExpAmp()

◆ GetExpTau()

◆ GetMaxAmp()

◆ GetMinAmp()

◆ GetShapeParameter()

◆ GetT0Max()

◆ GetT0Min()

◆ GetTau1()

◆ GetTau2()

◆ GetTime()

◆ GetTMax()

◆ GetTMin()

◆ GetTMinAdjust()

◆ GetWrapperTF1() [1/2]

◆ GetWrapperTF1() [2/2]

◆ GetWrapperTF1RawPtr()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ operator()()

◆ SetAmpMinMax()

◆ SetInitialExpPulse()

◆ SetT0FitLimits()

◆ SetT0Range()

◆ UnconstrainFit()

Member Data Documentation

◆ m_adjTLimitsEvent

◆ m_ampMax

◆ m_ampMin

◆ m_defaultTau

◆ m_expFermiFunc

◆ m_expFermiPreFunc

◆ m_fixTau

◆ m_norm

◆ m_t0Max

◆ m_t0Min

◆ m_tau1

◆ m_tau2

◆ m_tempTmax

◆ m_tempTmin

◆ m_timeCorr

◆ m_tmax

◆ m_tmin

◆ m_tminAdjust

◆ m_wrapperTF1