ATLAS Offline Software
Loading...
Searching...
No Matches
ZDCPreExpFitWrapper Class Referenceabstract

#include <ZDCFitWrapper.h>

Inheritance diagram for ZDCPreExpFitWrapper:
Collaboration diagram for ZDCPreExpFitWrapper:

Public Member Functions

 ZDCPreExpFitWrapper (std::shared_ptr< TF1 > wrapperTF1, float defaultExpTau, bool fixTau)
 ZDCPreExpFitWrapper (std::shared_ptr< TF1 > wrapperTF1, const std::vector< FitParameter > &defaultParamSet)
virtual void SetInitialExpPulse (float expamp)=0
bool fixExpTau () const
float getDefaultExpTau () const
virtual float GetExpAmp () const =0
virtual float GetExpTau () const =0
bool HaveParameterSet () const
void OverrideParameterSet (const std::vector< FitParameter > &parameterSet)
const FitParameter & GetParameterDescr (const std::string &name)
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)
bool finalized () const
virtual void Finalize ()
virtual void DoInitialize (float initialAmp, float initialT0, float ampMin, float ampMax)=0
virtual void DoFinalize ()
void SetAmpMinMax (float minAmp, float maxAmp)
void SetT0Range (float t0Min, float t0Max)
void ConstrainFit ()
void UnconstrainFit ()
virtual float GetAmplitude () const =0
virtual float GetAmpError () const =0
virtual float GetTime () const =0
virtual float GetTau1 () const =0
virtual float GetTau2 () const =0
float GetMinAmp () const
float GetMaxAmp () const
float GetTMin () const
float GetTMax () const
float GetT0Min () const
float GetT0Max () const
float GetTMinAdjust () const
virtual float GetBkgdMaxFraction () const =0
virtual unsigned int GetNumShapeParameters () const =0
virtual float GetShapeParameter (size_t index) const =0
virtual double operator() (const double *x, const double *p)=0
virtual std::shared_ptr< TF1 > GetWrapperTF1 ()
virtual const TF1 * GetWrapperTF1 () const
virtual TF1 * GetWrapperTF1RawPtr () const

Protected Member Functions

virtual void SetT0FitLimits (float tMin, float tMax)=0
virtual void doConstrainFit ()=0
virtual void doUnconstrainFit ()=0
void LoadDefaultParameterSet (const std::vector< FitParameter > &parameterSet)

Protected Attributes

float m_defaultTau
bool m_fixTau

Private Attributes

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}
bool m_haveParameterSet {false}
std::vector< FitParameter > m_parameterSet
bool m_finalized {false}

Detailed Description

Definition at line 235 of file ZDCFitWrapper.h.

Constructor & Destructor Documentation

◆ ZDCPreExpFitWrapper() [1/2]

ZDCPreExpFitWrapper::ZDCPreExpFitWrapper ( std::shared_ptr< TF1 > wrapperTF1,
float defaultExpTau,
bool fixTau )
inline

Definition at line 242 of file ZDCFitWrapper.h.

242 :
243 ZDCFitWrapper(wrapperTF1), m_defaultTau(defaultExpTau), m_fixTau(fixTau)
244 {}
ZDCFitWrapper()=delete

◆ ZDCPreExpFitWrapper() [2/2]

ZDCPreExpFitWrapper::ZDCPreExpFitWrapper ( std::shared_ptr< TF1 > wrapperTF1,
const std::vector< FitParameter > & defaultParamSet )
inline

Definition at line 246 of file ZDCFitWrapper.h.

246 :
247 ZDCFitWrapper(wrapperTF1, defaultParamSet)
248 {
249 const auto & tauParamDescr = GetParameterDescr("tauexp");
250 m_defaultTau = tauParamDescr.defaultValue();
251 m_fixTau = tauParamDescr.fixed();
252 }
const FitParameter & GetParameterDescr(const std::string &name)

Member Function Documentation

◆ ConstrainFit()

void ZDCFitWrapper::ConstrainFit ( )
inherited

Definition at line 277 of file ZDCFitWrapper.cxx.

278{
279 if (m_haveParameterSet) {
280 auto tf1_p = GetWrapperTF1();
281
282 for (unsigned int ipar = 2; ipar < m_parameterSet.size(); ipar++) {
283 const auto & fitparDescr = m_parameterSet[ipar];
284
285 if (!fitparDescr.fixed() && fitparDescr.constrainFixed()) {
286 tf1_p->FixParameter(ipar, fitparDescr.constrainValue());
287 }
288 }
289 }
290 else doConstrainFit();
291}
virtual std::shared_ptr< TF1 > GetWrapperTF1()
std::vector< FitParameter > m_parameterSet
bool m_haveParameterSet
virtual void doConstrainFit()=0

◆ doConstrainFit()

◆ DoFinalize()

virtual void ZDCFitWrapper::DoFinalize ( )
inlinevirtualinherited

◆ DoInitialize()

◆ doUnconstrainFit()

◆ Finalize()

virtual void ZDCFitWrapper::Finalize ( )
inlinevirtualinherited

Definition at line 136 of file ZDCFitWrapper.h.

137 {
138 DoFinalize();
139 m_finalized = true;
140 }
virtual void DoFinalize()

◆ finalized()

bool ZDCFitWrapper::finalized ( ) const
inlineinherited

Definition at line 134 of file ZDCFitWrapper.h.

134{return m_finalized;}

◆ fixExpTau()

bool ZDCPreExpFitWrapper::fixExpTau ( ) const
inline

Definition at line 256 of file ZDCFitWrapper.h.

256{return m_fixTau;}

◆ GetAmpError()

◆ GetAmplitude()

◆ GetBkgdMaxFraction()

◆ getDefaultExpTau()

float ZDCPreExpFitWrapper::getDefaultExpTau ( ) const
inline

Definition at line 257 of file ZDCFitWrapper.h.

257{return m_defaultTau;}

◆ GetExpAmp()

virtual float ZDCPreExpFitWrapper::GetExpAmp ( ) const
pure virtual

◆ GetExpTau()

virtual float ZDCPreExpFitWrapper::GetExpTau ( ) const
pure virtual

◆ GetMaxAmp()

float ZDCFitWrapper::GetMaxAmp ( ) const
inlineinherited

Definition at line 172 of file ZDCFitWrapper.h.

172{return m_ampMax;}

◆ GetMinAmp()

float ZDCFitWrapper::GetMinAmp ( ) const
inlineinherited

Definition at line 171 of file ZDCFitWrapper.h.

171{return m_ampMin;}

◆ GetNumShapeParameters()

◆ GetParameterDescr()

const ZDCFitWrapper::FitParameter & ZDCFitWrapper::GetParameterDescr ( const std::string & name)
inherited

Definition at line 118 of file ZDCFitWrapper.cxx.

119{
120 auto iter = std::find_if(m_parameterSet.begin(), m_parameterSet.end(),
121 [name](const FitParameter& parDesc){return parDesc.name() == name;});
122 if (iter == m_parameterSet.end()) throw std::logic_error("ZDCFitWrapper::GetParameterDescr: invalid parameter name: " + name );
123 return *iter;
124}

◆ GetShapeParameter()

◆ GetT0Max()

float ZDCFitWrapper::GetT0Max ( ) const
inlineinherited

Definition at line 182 of file ZDCFitWrapper.h.

182 {
183 if (m_adjTLimitsEvent) return m_tempTmax;
184 else return m_t0Max;
185 }

◆ GetT0Min()

float ZDCFitWrapper::GetT0Min ( ) const
inlineinherited

Definition at line 177 of file ZDCFitWrapper.h.

177 {
178 if (m_adjTLimitsEvent) return m_tempTmin;
179 else return m_t0Min;
180 }

◆ GetTau1()

◆ GetTau2()

◆ GetTime()

◆ GetTMax()

float ZDCFitWrapper::GetTMax ( ) const
inlineinherited

Definition at line 175 of file ZDCFitWrapper.h.

175{return m_tmax;}

◆ GetTMin()

float ZDCFitWrapper::GetTMin ( ) const
inlineinherited

Definition at line 174 of file ZDCFitWrapper.h.

174{return m_tmin;}

◆ GetTMinAdjust()

float ZDCFitWrapper::GetTMinAdjust ( ) const
inlineinherited

Definition at line 187 of file ZDCFitWrapper.h.

187{return m_tminAdjust;}

◆ GetWrapperTF1() [1/2]

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

Definition at line 196 of file ZDCFitWrapper.h.

196{return m_wrapperTF1;}
std::shared_ptr< TF1 > m_wrapperTF1

◆ GetWrapperTF1() [2/2]

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

Definition at line 197 of file ZDCFitWrapper.h.

197{return m_wrapperTF1.get();}

◆ GetWrapperTF1RawPtr()

virtual TF1 * ZDCFitWrapper::GetWrapperTF1RawPtr ( ) const
inlinevirtualinherited

Definition at line 198 of file ZDCFitWrapper.h.

198{return m_wrapperTF1.get();}

◆ HaveParameterSet()

bool ZDCFitWrapper::HaveParameterSet ( ) const
inlineinherited

Definition at line 127 of file ZDCFitWrapper.h.

127{return m_haveParameterSet;}

◆ Initialize() [1/2]

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

Definition at line 199 of file ZDCFitWrapper.cxx.

200{
201 // Clear the errors on the TF1 because retaining the errors seems to affect
202 // the convergence of fits
203 //
204 auto tf1_p = GetWrapperTF1();
205 unsigned int npar = tf1_p->GetNpar();
206 std::vector<double> zeroVec(npar, 0.0);
207 GetWrapperTF1()->SetParErrors(&zeroVec[0]);
208
209 // If we adjusted the time range on the previous event, restore to default
210 //
211 if (m_adjTLimitsEvent) {
213
214 m_adjTLimitsEvent = false;
215 m_tminAdjust = 0;
216 }
217
218 SetAmpMinMax(ampMin, ampMax);
219
220 //
221 // Do we have parameter sets?
222 //
223 if (m_haveParameterSet) {
224 for (unsigned int ipar = 0; ipar < m_parameterSet.size(); ipar++) {
225 //
226 // Yes, use parameter descriptors to initialize the TF1
227 //
228 const auto & fitparDescr = m_parameterSet[ipar];
229
230 if (!fitparDescr.fixed()) {
231 tf1_p->SetParameter(ipar, fitparDescr.defaultValue());
232 tf1_p->SetParError(ipar, fitparDescr.stepSize());
233 }
234 }
235
236 tf1_p->SetParameter(0, initialAmp);
237 tf1_p->SetParameter(1, initialT0);
238 }
239 else {
240 //
241 // No, perform the wrapper-implemented initialize
242 //
243 DoInitialize(initialAmp, initialT0, ampMin, ampMax);
244
245 // Clear the errors on the TF1 because retaining the errors seems to affect
246 // the convergence of fits
247 //
248 unsigned int npar = GetWrapperTF1()->GetNpar();
249 std::vector<double> zeroVec(npar, 0.0);
250 tf1_p->SetParErrors(&zeroVec[0]);
251
252 }
253}
virtual void SetT0FitLimits(float tMin, float tMax)=0
void SetAmpMinMax(float minAmp, float maxAmp)
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 255 of file ZDCFitWrapper.cxx.

256{
257
258 // First do the nominal initializatioon
259 //
260 Initialize(initialAmp, initialT0, ampMin, ampMax);
261
262 // Now account for the modified time range
263 //
264 m_adjTLimitsEvent = true;
265
266 // Handle the specific limits on T0
267 //
268 m_tminAdjust = fitTRef; // Note: this is the time corresponding to the sample used for presample subtraction
269
270 m_tempTmin = std::max(m_t0Min, fitTmin);
271 m_tempTmax = std::min(m_t0Max, fitTmax);
272
273 SetAmpMinMax(ampMin, ampMax);
275}
void Initialize(float initialAmp, float initialT0, float ampMin, float ampMax)

◆ LoadDefaultParameterSet()

void ZDCFitWrapper::LoadDefaultParameterSet ( const std::vector< FitParameter > & parameterSet)
protectedinherited

Definition at line 126 of file ZDCFitWrapper.cxx.

127{
128 // First step is to check consistency with number of parameters in TF1
129 //
130 if (int(parameterSet.size()) != m_wrapperTF1->GetNpar()) throw std::logic_error("ZDCFitWrapper::LoadDefaultParameterSet:: Incorrect number of parameters in default parameter set");
131
132 m_parameterSet = parameterSet;
133 m_haveParameterSet = true;
134
135 std::shared_ptr<TF1> theTF1 = ZDCFitWrapper::GetWrapperTF1();
136
137 // Loop over passed descriptors
138 //
139 unsigned parIndex = 0;
140 for (const auto & parDescr : parameterSet) {
141 //
142 // Load the settings for this parameter in the TF1
143 //
144 std::string name = parDescr.name();
145 theTF1->SetParName(parIndex, name.c_str());
146
147 bool fixed = parDescr.fixed();
148
149 if (fixed) {
150 float fixedValue = parDescr.defaultValue();
151 theTF1->FixParameter(parIndex, fixedValue);
152 }
153 else {
154 float lowerLimit = parDescr.lowerLimit();
155 float upperLimit = parDescr.upperLimit();
156 theTF1->SetParLimits(parIndex, lowerLimit, upperLimit);
157 }
158
159 parIndex++;
160 }
161}

◆ operator()()

◆ OverrideParameterSet()

void ZDCFitWrapper::OverrideParameterSet ( const std::vector< FitParameter > & parameterSet)
inherited

Definition at line 163 of file ZDCFitWrapper.cxx.

164{
165 std::shared_ptr<TF1> theTF1 = ZDCFitWrapper::GetWrapperTF1();
166
167 // Loop over the provided parameter descriptors
168 //
169 for (const auto & parDescr : overParamSet) {
170 std::string inputName = parDescr.name();
171
172 // Fit the parameter name in the current list
173 //
174 auto iter = std::find_if(m_parameterSet.begin(), m_parameterSet.end(),
175 [inputName](const FitParameter& parDesc){return parDesc.name() == inputName;});
176 if (iter == m_parameterSet.end()) throw std::logic_error("ZDCFitWrapper::OverrideParameterSet: invalid parameter name: " +inputName );
177
178 // Update the descriptor for this parameter
179 //
180 (*iter) = parDescr;
181
182 // Update the settings in the TF!
183 //
184 unsigned int parIndex = std::distance(m_parameterSet.begin(), iter);
185 bool fixed = parDescr.fixed();
186
187 if (fixed) {
188 float fixedValue = parDescr.defaultValue();
189 theTF1->FixParameter(parIndex, fixedValue);
190 }
191 else {
192 float lowerLimit = parDescr.lowerLimit();
193 float upperLimit = parDescr.upperLimit();
194 theTF1->SetParLimits(parIndex, lowerLimit, upperLimit);
195 }
196 }
197}

◆ SetAmpMinMax()

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

Definition at line 147 of file ZDCFitWrapper.h.

148 {
149 m_ampMin = minAmp;
150 m_ampMax = maxAmp;
151 }

◆ SetInitialExpPulse()

virtual void ZDCPreExpFitWrapper::SetInitialExpPulse ( float expamp)
pure virtual

◆ SetT0FitLimits()

◆ SetT0Range()

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

Definition at line 153 of file ZDCFitWrapper.h.

154 {
155 m_t0Min = t0Min;
156 m_t0Max = t0Max;
157
158 SetT0FitLimits(t0Min, t0Max);
159 }

◆ UnconstrainFit()

void ZDCFitWrapper::UnconstrainFit ( )
inherited

Definition at line 293 of file ZDCFitWrapper.cxx.

294{
295 if (m_haveParameterSet) {
296 auto tf1_p = GetWrapperTF1();
297
298 for (unsigned int ipar = 2; ipar < m_parameterSet.size(); ipar++) {
299 const auto & fitparDescr = m_parameterSet[ipar];
300
301 if (!fitparDescr.fixed() && fitparDescr.constrainFixed()) {
302 tf1_p->ReleaseParameter(ipar);
303 tf1_p->SetParameter(ipar, fitparDescr.defaultValue());
304
305 float lowerLimit = fitparDescr.lowerLimit();
306 float upperLimit = fitparDescr.upperLimit();
307 tf1_p->SetParLimits(ipar, lowerLimit, upperLimit);
308
309 tf1_p->SetParError(ipar, fitparDescr.stepSize());
310 }
311 }
312 }
313 else doUnconstrainFit();
314}
virtual void doUnconstrainFit()=0

Member Data Documentation

◆ m_adjTLimitsEvent

bool ZDCFitWrapper::m_adjTLimitsEvent {false}
privateinherited

Definition at line 74 of file ZDCFitWrapper.h.

74{false};

◆ m_ampMax

float ZDCFitWrapper::m_ampMax {0}
privateinherited

Definition at line 69 of file ZDCFitWrapper.h.

69{0};

◆ m_ampMin

float ZDCFitWrapper::m_ampMin {0}
privateinherited

Definition at line 68 of file ZDCFitWrapper.h.

68{0};

◆ m_defaultTau

float ZDCPreExpFitWrapper::m_defaultTau
protected

Definition at line 238 of file ZDCFitWrapper.h.

◆ m_finalized

bool ZDCFitWrapper::m_finalized {false}
privateinherited

Definition at line 82 of file ZDCFitWrapper.h.

82{false};

◆ m_fixTau

bool ZDCPreExpFitWrapper::m_fixTau
protected

Definition at line 239 of file ZDCFitWrapper.h.

◆ m_haveParameterSet

bool ZDCFitWrapper::m_haveParameterSet {false}
privateinherited

Definition at line 79 of file ZDCFitWrapper.h.

79{false};

◆ m_parameterSet

std::vector<FitParameter> ZDCFitWrapper::m_parameterSet
privateinherited

Definition at line 80 of file ZDCFitWrapper.h.

◆ m_t0Max

float ZDCFitWrapper::m_t0Max {0}
privateinherited

Definition at line 72 of file ZDCFitWrapper.h.

72{0};

◆ m_t0Min

float ZDCFitWrapper::m_t0Min {0}
privateinherited

Definition at line 71 of file ZDCFitWrapper.h.

71{0};

◆ m_tempTmax

float ZDCFitWrapper::m_tempTmax {0}
privateinherited

Definition at line 77 of file ZDCFitWrapper.h.

77{0};

◆ m_tempTmin

float ZDCFitWrapper::m_tempTmin {0}
privateinherited

Definition at line 76 of file ZDCFitWrapper.h.

76{0};

◆ m_tmax

float ZDCFitWrapper::m_tmax {0}
privateinherited

Definition at line 66 of file ZDCFitWrapper.h.

66{0};

◆ m_tmin

float ZDCFitWrapper::m_tmin {0}
privateinherited

Definition at line 65 of file ZDCFitWrapper.h.

65{0};

◆ m_tminAdjust

float ZDCFitWrapper::m_tminAdjust {0}
privateinherited

Definition at line 75 of file ZDCFitWrapper.h.

75{0};

◆ m_wrapperTF1

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

Definition at line 63 of file ZDCFitWrapper.h.

63{};

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