ATLAS Offline Software
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Attributes | List of all members
ZDCFitExpFermiPreExp Class Reference

#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 unsigned int GetNumShapeParameters () 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 652 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 446 of file ZDCFitWrapper.cxx.

447 :
448 ZDCPreExpFitWrapper(std::make_shared<TF1>(("ExpFermiPreExp" + tag).c_str(), this, tmin, tmax, 6), defExpTau, fixExpTau),
449 m_tau1(tau1), m_tau2(tau2)
450{
451 // Create the reference function that we use to evaluate ExpFermiFit more efficiently
452 //
453 std::string funcNameRefFunc = "ExpFermiPreExpRefFunc" + tag;
454
455 m_expFermiFunc = std::make_shared<TF1>(funcNameRefFunc.c_str(), ZDCFermiExpFit, tmin, tmax, 8);
456
457 // The parameters for the FermiExp
458 //
459 m_expFermiFunc->SetParameter(0, 1);
460 m_expFermiFunc->SetParameter(1, 0);
461 m_expFermiFunc->SetParameter(2, m_tau1);
462 m_expFermiFunc->SetParameter(3, m_tau2);
463 m_expFermiFunc->SetParameter(4, 0);
464
465 m_norm = 1. / m_expFermiFunc->GetMaximum();
466 m_timeCorr = m_tau1 * std::log(m_tau2 / m_tau1 - 1.0);
467
468 // Now set up the actual TF1
469 //
470 std::shared_ptr<TF1> theTF1 = ZDCFitWrapper::GetWrapperTF1();
471 theTF1->SetParName(0, "Amp");
472 theTF1->SetParName(1, "T0");
473 theTF1->SetParName(2, "Amp_{pre}");
474 theTF1->SetParName(3, "tau_{pre}");
475 theTF1->SetParName(4, "tausqrt_{pre}");
476 theTF1->SetParName(5, "C");
477
478 theTF1->SetParLimits(1, tmin, tmax);
479 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.
480 theTF1->SetParLimits(3, 6, 30);
481 theTF1->SetParLimits(4, -0.2, 0.2);
482 theTF1->SetParLimits(5, -50, 50);
483}
ZDCFermiExpFit
double ZDCFermiExpFit(const double *xvec, const double *pvec)
Definition ZDCFitWrapper.h:1390
ZDCFitExpFermiPreExp::m_expFermiFunc
std::shared_ptr< TF1 > m_expFermiFunc
Definition ZDCFitWrapper.h:660
ZDCFitWrapper::GetWrapperTF1
virtual std::shared_ptr< TF1 > GetWrapperTF1()
Definition ZDCFitWrapper.h:115
ZDCPreExpFitWrapper::ZDCPreExpFitWrapper
ZDCPreExpFitWrapper(std::shared_ptr< TF1 > wrapperTF1, float defaultExpTau, bool fixTau)
Definition ZDCFitWrapper.h:155
ZDCPreExpFitWrapper::fixExpTau
bool fixExpTau() const
Definition ZDCFitWrapper.h:161
CaloCondBlobAlgs_fillNoiseFromASCII.tag
str tag
Definition CaloCondBlobAlgs_fillNoiseFromASCII.py:23

◆ ~ZDCFitExpFermiPreExp()

ZDCFitExpFermiPreExp::~ZDCFitExpFermiPreExp ( )
inline

Definition at line 666 of file ZDCFitWrapper.h.

666{}

Member Function Documentation

◆ ConstrainFit()

void ZDCFitExpFermiPreExp::ConstrainFit ( )
overridevirtual

Implements ZDCFitWrapper.

Definition at line 485 of file ZDCFitWrapper.cxx.

486{
487 // We force the constant term and per-pulse amplitude to zero
488 //
489 std::shared_ptr<TF1> theTF1 = GetWrapperTF1();
490
491 theTF1->FixParameter(2, 0);
492 theTF1->FixParameter(3, getDefaultExpTau());
493 theTF1->FixParameter(5, 0);
494}
ZDCPreExpFitWrapper::getDefaultExpTau
float getDefaultExpTau() const
Definition ZDCFitWrapper.h:162

◆ DoInitialize()

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

Implements ZDCFitWrapper.

Definition at line 511 of file ZDCFitWrapper.cxx.

512{
513 GetWrapperTF1()->SetParameter(0, initialAmp);
514 GetWrapperTF1()->SetParameter(1, initialT0);
515 GetWrapperTF1()->SetParameter(2, 0);
516 GetWrapperTF1()->SetParameter(3, getDefaultExpTau());
517 GetWrapperTF1()->SetParameter(4, 0.);
518 GetWrapperTF1()->SetParameter(5, 0);
519
520 GetWrapperTF1()->SetParLimits(0, ampMin, ampMax);
521
522 // Set parameter errors for fit step size
523 //
524 double ampStep = std::min(0.05*initialAmp, std::abs(ampMax - initialAmp)/2.);
525 GetWrapperTF1()->SetParError(0, ampStep);
526 GetWrapperTF1()->SetParError(1, 1.0);
527 GetWrapperTF1()->SetParError(2, ampStep/2);
528 GetWrapperTF1()->SetParError(3, 1.0);
529 GetWrapperTF1()->SetParError(4, 0.025);
530 GetWrapperTF1()->SetParError(5, 1.0);
531}

◆ fixExpTau()

bool ZDCPreExpFitWrapper::fixExpTau ( ) const
inlineinherited

Definition at line 161 of file ZDCFitWrapper.h.

161{return m_fixTau;}

◆ GetAmpError()

virtual float ZDCFitExpFermiPreExp::GetAmpError ( ) const
inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 680 of file ZDCFitWrapper.h.

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

◆ GetAmplitude()

virtual float ZDCFitExpFermiPreExp::GetAmplitude ( ) const
inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 679 of file ZDCFitWrapper.h.

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

◆ GetBkgdMaxFraction()

virtual float ZDCFitExpFermiPreExp::GetBkgdMaxFraction ( ) const
inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 700 of file ZDCFitWrapper.h.

701 {
702 const TF1* theTF1 = ZDCFitWrapper::GetWrapperTF1();
703 double maxTime = GetTime();
704
705 double amp = theTF1->GetParameter(0);
706 if (amp <= 0) return -1;
707
708 double preAmp = theTF1->GetParameter(2);
709 double preT0 = theTF1->GetParameter(3);
710
711 double deltaTPre = maxTime - preT0;
712 double background = preAmp * m_norm * m_expFermiFunc->operator()(deltaTPre);
713
714 return background / (amp + background);
715 }
ZDCFitExpFermiPreExp::GetTime
virtual float GetTime() const override
Definition ZDCFitWrapper.h:685

◆ getDefaultExpTau()

float ZDCPreExpFitWrapper::getDefaultExpTau ( ) const
inlineinherited

Definition at line 162 of file ZDCFitWrapper.h.

162{return m_defaultTau;}

◆ GetExpAmp()

virtual float ZDCFitExpFermiPreExp::GetExpAmp ( ) const
inlineoverridevirtual

Implements ZDCPreExpFitWrapper.

Definition at line 689 of file ZDCFitWrapper.h.

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

◆ GetExpTau()

virtual float ZDCFitExpFermiPreExp::GetExpTau ( ) const
inlineoverridevirtual

Implements ZDCPreExpFitWrapper.

Definition at line 690 of file ZDCFitWrapper.h.

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

◆ GetMaxAmp()

float ZDCFitWrapper::GetMaxAmp ( ) const
inlineinherited

Definition at line 91 of file ZDCFitWrapper.h.

91{return m_ampMax;}

◆ GetMinAmp()

float ZDCFitWrapper::GetMinAmp ( ) const
inlineinherited

Definition at line 90 of file ZDCFitWrapper.h.

90{return m_ampMin;}

◆ GetNumShapeParameters()

virtual unsigned int ZDCFitExpFermiPreExp::GetNumShapeParameters ( ) const
inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 692 of file ZDCFitWrapper.h.

692{return 2;}

◆ GetShapeParameter()

virtual float ZDCFitExpFermiPreExp::GetShapeParameter ( size_t index) const
inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 694 of file ZDCFitWrapper.h.

695 {
696 if (index < 2) return GetWrapperTF1()->GetParameter(index + 4);
697 else throw std::runtime_error("Fit parameter does not exist.");
698 }

◆ GetT0Max()

float ZDCFitWrapper::GetT0Max ( ) const
inlineinherited

Definition at line 101 of file ZDCFitWrapper.h.

101 {
102 if (m_adjTLimitsEvent) return m_tempTmax;
103 else return m_t0Max;
104 }

◆ GetT0Min()

float ZDCFitWrapper::GetT0Min ( ) const
inlineinherited

Definition at line 96 of file ZDCFitWrapper.h.

96 {
97 if (m_adjTLimitsEvent) return m_tempTmin;
98 else return m_t0Min;
99 }

◆ GetTau1()

virtual float ZDCFitExpFermiPreExp::GetTau1 ( ) const
inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 682 of file ZDCFitWrapper.h.

682{return m_tau1;}

◆ GetTau2()

virtual float ZDCFitExpFermiPreExp::GetTau2 ( ) const
inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 683 of file ZDCFitWrapper.h.

683{return m_tau2;}

◆ GetTime()

virtual float ZDCFitExpFermiPreExp::GetTime ( ) const
inlineoverridevirtual

Implements ZDCFitWrapper.

Definition at line 685 of file ZDCFitWrapper.h.

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

◆ GetTMax()

float ZDCFitWrapper::GetTMax ( ) const
inlineinherited

Definition at line 94 of file ZDCFitWrapper.h.

94{return m_tmax;}

◆ GetTMin()

float ZDCFitWrapper::GetTMin ( ) const
inlineinherited

Definition at line 93 of file ZDCFitWrapper.h.

93{return m_tmin;}

◆ GetTMinAdjust()

float ZDCFitWrapper::GetTMinAdjust ( ) const
inlineinherited

Definition at line 106 of file ZDCFitWrapper.h.

106{return m_tminAdjust;}

◆ GetWrapperTF1() [1/2]

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

Definition at line 115 of file ZDCFitWrapper.h.

115{return m_wrapperTF1;}
ZDCFitWrapper::m_wrapperTF1
std::shared_ptr< TF1 > m_wrapperTF1
Definition ZDCFitWrapper.h:25

◆ GetWrapperTF1() [2/2]

virtual const TF1 * ZDCFitWrapper::GetWrapperTF1 ( ) const
inlinevirtualinherited

Definition at line 116 of file ZDCFitWrapper.h.

116{return m_wrapperTF1.get();}

◆ GetWrapperTF1RawPtr()

virtual TF1 * ZDCFitWrapper::GetWrapperTF1RawPtr ( ) const
inlinevirtualinherited

Definition at line 117 of file ZDCFitWrapper.h.

117{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.

10{
11 // Clear the errors on the TF1 because retaining the errors seems to affect
12 // the convergence of fits
13 //
14 unsigned int npar = GetWrapperTF1()->GetNpar();
15 std::vector<double> zeroVec(npar, 0.0);
16 GetWrapperTF1()->SetParErrors(&zeroVec[0]);
17
18 // If we adjusted the time range on the previous event, restore to default
19 //
20 if (m_adjTLimitsEvent) {
21 SetT0FitLimits(m_t0Min, m_t0Max);
22
23 m_adjTLimitsEvent = false;
24 m_tminAdjust = 0;
25 }
26
27 SetAmpMinMax(ampMin, ampMax);
28
29 DoInitialize(initialAmp, initialT0, ampMin, ampMax);
30}
ZDCFitWrapper::SetT0FitLimits
virtual void SetT0FitLimits(float tMin, float tMax)=0
ZDCFitWrapper::SetAmpMinMax
void SetAmpMinMax(float minAmp, float maxAmp)
Definition ZDCFitWrapper.h:67
ZDCFitWrapper::DoInitialize
virtual void DoInitialize(float initialAmp, float initialT0, float ampMin, float ampMax)=0

◆ 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.

33{
34 // Clear the errors on the TF1 because retaining the errors seems to affect
35 // the convergence of fits
36 //
37 unsigned int npar = GetWrapperTF1()->GetNpar();
38 std::vector<double> zeroVec(npar, 0.0);
39 GetWrapperTF1()->SetParErrors(&zeroVec[0]);
40
41 m_adjTLimitsEvent = true;
42
43 m_tminAdjust = fitTRef; // Note: this is the time corresponding to the sample used for presample subtraction
44
45 m_tempTmin = std::max(m_t0Min, fitTmin);
46 m_tempTmax = std::min(m_t0Max, fitTmax);
47
48 SetAmpMinMax(ampMin, ampMax);
49 SetT0FitLimits(m_tempTmin, m_tempTmax);
50
51 DoInitialize(initialAmp, initialT0, ampMin, ampMax);
52}

◆ operator()()

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

Implements ZDCFitWrapper.

Definition at line 717 of file ZDCFitWrapper.h.

718 {
719 double t = x[0];
720
721 double amp = p[0];
722 double t0 = p[1];
723 double expAmp = p[2];
724 double expTau = p[3];
725 double expSqrtTau = p[4];
726 double C = p[5];
727
728 double deltaT = t - t0;
729 double pulse = amp * m_norm * m_expFermiFunc->operator()(deltaT);
730
731 // We subtract off the value of the exponential pulse at the minimum time (nominally 0),
732 // because it would have been included in the baseline subtraction
733 //
734 double tRef = GetTMinAdjust();
735 double expPre = 0;
736 if (t > 0 && std::abs(expSqrtTau)>1e-6) expPre = expAmp * (std::exp(-t/expTau-expSqrtTau*std::sqrt(t)) - std::exp(-tRef/expTau));
737 else expPre = expAmp * (std::exp(-t/expTau) - std::exp(-tRef/expTau));
738
739 return C + pulse + expPre;
740 }
t0
static Double_t t0
Definition LArPhysWaveHECTool.cxx:38
x
#define x
ZDCFitWrapper::GetTMinAdjust
float GetTMinAdjust() const
Definition ZDCFitWrapper.h:106
C
struct color C
read_hist_ntuple.t
t
Definition read_hist_ntuple.py:8

◆ SetAmpMinMax()

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

Definition at line 67 of file ZDCFitWrapper.h.

68 {
69 m_ampMin = minAmp;
70 m_ampMax = maxAmp;
71 }

◆ SetInitialExpPulse()

virtual void ZDCFitExpFermiPreExp::SetInitialExpPulse ( float amp)
inlineoverridevirtual

Implements ZDCPreExpFitWrapper.

Definition at line 671 of file ZDCFitWrapper.h.

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

◆ SetT0FitLimits()

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

Implements ZDCFitWrapper.

Definition at line 533 of file ZDCFitWrapper.cxx.

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

◆ SetT0Range()

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

Definition at line 73 of file ZDCFitWrapper.h.

74 {
75 m_t0Min = t0Min;
76 m_t0Max = t0Max;
77
78 SetT0FitLimits(t0Min, t0Max);
79 }

◆ UnconstrainFit()

void ZDCFitExpFermiPreExp::UnconstrainFit ( )
overridevirtual

Implements ZDCFitWrapper.

Definition at line 495 of file ZDCFitWrapper.cxx.

496{
497 std::shared_ptr<TF1> theTF1 = GetWrapperTF1();
498
499 theTF1->ReleaseParameter(2);
500 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.
501
502 theTF1->ReleaseParameter(3);
503 theTF1->SetParLimits(3, 6, 30);
504 theTF1->SetParameter(3, getDefaultExpTau());
505
506 theTF1->ReleaseParameter(5);
507 theTF1->SetParLimits(5, -50, 50);
508 theTF1->SetParameter(5, 0);
509}

Member Data Documentation

◆ m_adjTLimitsEvent

bool ZDCFitWrapper::m_adjTLimitsEvent {false}
privateinherited

Definition at line 36 of file ZDCFitWrapper.h.

36{false};

◆ m_ampMax

float ZDCFitWrapper::m_ampMax {0}
privateinherited

Definition at line 31 of file ZDCFitWrapper.h.

31{0};

◆ m_ampMin

float ZDCFitWrapper::m_ampMin {0}
privateinherited

Definition at line 30 of file ZDCFitWrapper.h.

30{0};

◆ m_defaultTau

float ZDCPreExpFitWrapper::m_defaultTau
protectedinherited

Definition at line 151 of file ZDCFitWrapper.h.

◆ m_expFermiFunc

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

Definition at line 660 of file ZDCFitWrapper.h.

660{0};

◆ m_expFermiPreFunc

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

Definition at line 661 of file ZDCFitWrapper.h.

661{0};

◆ m_fixTau

bool ZDCPreExpFitWrapper::m_fixTau
protectedinherited

Definition at line 152 of file ZDCFitWrapper.h.

◆ m_norm

double ZDCFitExpFermiPreExp::m_norm {}
private

Definition at line 658 of file ZDCFitWrapper.h.

658{};

◆ m_t0Max

float ZDCFitWrapper::m_t0Max {0}
privateinherited

Definition at line 34 of file ZDCFitWrapper.h.

34{0};

◆ m_t0Min

float ZDCFitWrapper::m_t0Min {0}
privateinherited

Definition at line 33 of file ZDCFitWrapper.h.

33{0};

◆ m_tau1

float ZDCFitExpFermiPreExp::m_tau1 {0}
private

Definition at line 655 of file ZDCFitWrapper.h.

655{0};

◆ m_tau2

float ZDCFitExpFermiPreExp::m_tau2 {0}
private

Definition at line 656 of file ZDCFitWrapper.h.

656{0};

◆ m_tempTmax

float ZDCFitWrapper::m_tempTmax {0}
privateinherited

Definition at line 39 of file ZDCFitWrapper.h.

39{0};

◆ m_tempTmin

float ZDCFitWrapper::m_tempTmin {0}
privateinherited

Definition at line 38 of file ZDCFitWrapper.h.

38{0};

◆ m_timeCorr

float ZDCFitExpFermiPreExp::m_timeCorr {0}
private

Definition at line 657 of file ZDCFitWrapper.h.

657{0};

◆ m_tmax

float ZDCFitWrapper::m_tmax {0}
privateinherited

Definition at line 28 of file ZDCFitWrapper.h.

28{0};

◆ m_tmin

float ZDCFitWrapper::m_tmin {0}
privateinherited

Definition at line 27 of file ZDCFitWrapper.h.

27{0};

◆ m_tminAdjust

float ZDCFitWrapper::m_tminAdjust {0}
privateinherited

Definition at line 37 of file ZDCFitWrapper.h.

37{0};

◆ m_wrapperTF1

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

Definition at line 25 of file ZDCFitWrapper.h.

25{};
The documentation for this class was generated from the following files:
Generated on for ATLAS Offline Software by doxygen 1.16.1