TGo4FitterConfig Class Reference

Fitter configuration action By default all fitter parameters are used in optimization as independent from each other. More...

#include <TGo4FitterConfig.h>

Inheritance diagram for TGo4FitterConfig:

TGo4FitterAction TGo4FitNamed List of all members.

Public Member Functions

 TGo4FitterConfig ()
 Default constructor.
 TGo4FitterConfig (const char *iName, const char *iTitle)
 Creates TGo4FiierConfig object with given name and Title.
virtual ~TGo4FitterConfig ()
 Destroys TGo4FitterConfig object.
void AddParNew (const char *ParName, Double_t iValue=0)
 Add new parameter with given name and initial value.
virtual Bool_t SetParFixed (const char *ParName, Bool_t iFixed=kTRUE)
 Sets, that parameter with ParName should be fixed or not.
virtual Bool_t SetParRange (const char *ParName, Double_t RangeMin, Double_t RangeMax)
 Sets valid range for parameter ParName.
virtual Bool_t SetParEpsilon (const char *ParName, Double_t Epsilon)
 Sets epsilon for parameter ParName.
virtual Bool_t GetParFixed (const char *ParName)
 Return kTRUE, if parameter ParName should be fixed in minimization.
virtual Bool_t GetParRange (const char *ParName, Double_t &RangeMin, Double_t &RangeMax)
 Return kTRUE, if parameter ParName has explicit configuration for valid range in minimization.
virtual Bool_t GetParEpsilon (const char *ParName, Double_t &Epsilon)
 Return kTRUE, if parameter ParName has explicit configuration for epsilon value in minimization.
void SetParInit (const char *FullName, Double_t iValue)
 Set initial value for parameter.
void SetParInit (const char *FullName, const char *iExpression)
 Set initial value for parameter, calculated from expression.
void SetParDepend (const char *FullName, const char *iExpression)
 Set dependency expression for parameter.
void AddResult (const char *Expression)
 Add expression for calculating result value.
void AddResult (Double_t Value)
 Add constant value as result value.
TGo4FitParsListGetParsCfg ()
 Get list of TGo4FitParameter objects, used as explicit configuration for minimizing.
TGo4FitParsListGetParsNew ()
 Get list of TGo4FitParameter objects, which can be used in minimization and dependency calculations.
TObjArray & GetParsInit ()
 Returns list of TGo4FitDependency objects, used for parameters initialization.
TObjArray & GetParsDepend ()
 Returns list of TGo4FitDependency objects, used for dependencies calculations.
TObjArray & GetResults ()
 Returns list of TGo4FitDependency objects, used for calculating result values for fitter.
virtual void DoAction (TGo4FitterAbstract *Fitter)
 Do configuration action.
virtual void Print (Option_t *option) const
 Print information on standard output.

Protected Member Functions

TGo4FitParameterMakeParForProperties (const char *ParName)
TGo4FitDependencyFindDepen (const char *FullName, TObjArray *list)

Protected Attributes

TGo4FitParsList fxParsCfg
 List of parameters objects, used for alternative configuration of parameters, which should be fitted.
TGo4FitParsList fxParsNew
 List of parameters object, which can be used in dependency calculations and minimization.
TObjArray fxParsInit
 Array of dependencies for parameters initialization.
TObjArray fxParsDepend
 Array of dependencies (TGo4FitDependency) for introducing dependency between fitted parameters.
TObjArray fxResults
 Array of TGo4FitDependency objects, which repersent equations to calculate result values in fitter.
Bool_t fbFixedByDefault
 Determine, if all parameters should be fixed by default.

Detailed Description

Fitter configuration action By default all fitter parameters are used in optimization as independent from each other.

But there are a lot of situation, then one would like to introduce some kind of dependency between parameters. For instance, two lines have constant difference in positions. In other cases some of the parameter properties should be redefined without touching parameter object itself. For such a cases configuration class TGo4FitterConfig was introduced. There are several routines of TGo4FitterConfig class, which provide useful fitter configurations: SetParFixed() - fix value of given parameter; SetParRange() - fix range for given parameter; SetParEpsilon() - set initial error for given parameter. SetParInit() - set initial value for parameter (can be double value or expression); SetParDepend() - set dependency of given parameter via expression; AddParNew() - create new parameter, which can be used in expressions. Several configuration objects can be added to actions list. It may be useful, if several minimization routines are used. Then before each minimization action new configuration can be applied.

Definition at line 36 of file TGo4FitterConfig.h.


Constructor & Destructor Documentation

TGo4FitterConfig::TGo4FitterConfig (  ) 

Default constructor.

Definition at line 24 of file TGo4FitterConfig.cxx.

TGo4FitterConfig::TGo4FitterConfig ( const char *  iName,
const char *  iTitle 
)

Creates TGo4FiierConfig object with given name and Title.

Definition at line 29 of file TGo4FitterConfig.cxx.

References fxParsDepend, fxParsInit, and fxResults.

TGo4FitterConfig::~TGo4FitterConfig (  )  [virtual]

Destroys TGo4FitterConfig object.

Definition at line 37 of file TGo4FitterConfig.cxx.


Member Function Documentation

void TGo4FitterConfig::AddParNew ( const char *  ParName,
Double_t  iValue = 0 
) [inline]

Add new parameter with given name and initial value.

This parameter can be used later in dependency calculations in minimizations.

Definition at line 58 of file TGo4FitterConfig.h.

References TGo4FitParsList::CreatePar(), and fxParsNew.

Bool_t TGo4FitterConfig::SetParFixed ( const char *  ParName,
Bool_t  iFixed = kTRUE 
) [virtual]

Sets, that parameter with ParName should be fixed or not.

ParName may be standard or full name of parameter.

Definition at line 46 of file TGo4FitterConfig.cxx.

References MakeParForProperties(), and TGo4FitParameter::SetFixed().

Bool_t TGo4FitterConfig::SetParRange ( const char *  ParName,
Double_t  RangeMin,
Double_t  RangeMax 
) [virtual]

Sets valid range for parameter ParName.

ParName may be standard or full name of parameter.

Definition at line 52 of file TGo4FitterConfig.cxx.

References MakeParForProperties(), and TGo4FitParameter::SetRange().

Bool_t TGo4FitterConfig::SetParEpsilon ( const char *  ParName,
Double_t  Epsilon 
) [virtual]

Sets epsilon for parameter ParName.

ParName may be standard or full name of parameter.

Definition at line 58 of file TGo4FitterConfig.cxx.

References MakeParForProperties(), and TGo4FitParameter::SetEpsilon().

Bool_t TGo4FitterConfig::GetParFixed ( const char *  ParName  )  [virtual]

Return kTRUE, if parameter ParName should be fixed in minimization.

ParName may be standard or full name of parameter.

Definition at line 64 of file TGo4FitterConfig.cxx.

References fxParsCfg, and TGo4FitParsList::GetParFixed().

Referenced by TGo4FitterAbstract::GetParFixed().

Bool_t TGo4FitterConfig::GetParRange ( const char *  ParName,
Double_t &  RangeMin,
Double_t &  RangeMax 
) [virtual]

Return kTRUE, if parameter ParName has explicit configuration for valid range in minimization.

ParName may be standard or full name of parameter.

Definition at line 68 of file TGo4FitterConfig.cxx.

References fxParsCfg, and TGo4FitParsList::GetParRange().

Referenced by TGo4FitterAbstract::GetParRange().

Bool_t TGo4FitterConfig::GetParEpsilon ( const char *  ParName,
Double_t &  Epsilon 
) [virtual]

Return kTRUE, if parameter ParName has explicit configuration for epsilon value in minimization.

ParName may be standard or full name of parameter.

Definition at line 72 of file TGo4FitterConfig.cxx.

References fxParsCfg, and TGo4FitParsList::GetParEpsilon().

Referenced by TGo4FitterAbstract::GetParEpsilon().

void TGo4FitterConfig::SetParInit ( const char *  FullName,
Double_t  iValue 
)

Set initial value for parameter.

Init value sets to parameter once when configuration activating. FullName should be full name of parameter.

Definition at line 84 of file TGo4FitterConfig.cxx.

References FindDepen(), fxParsInit, and TGo4FitDependency::SetInitValue().

void TGo4FitterConfig::SetParInit ( const char *  FullName,
const char *  iExpression 
)

Set initial value for parameter, calculated from expression.

Expression may use fitter parameters like Gauss2.Pos+Gaus3.Pos/10 Initializing expression calculated once when config activated. FullName should be full name of parameter.

Definition at line 90 of file TGo4FitterConfig.cxx.

References FindDepen(), fxParsInit, and TGo4FitDependency::SetExpression().

void TGo4FitterConfig::SetParDepend ( const char *  FullName,
const char *  iExpression 
)

Set dependency expression for parameter.

Expression may use fitter parameters like Gauss2.Pos+Gaus3.Pos/10 Dependency expression calculated every time before fit function calculations. FullName should be full name of parameter.

Definition at line 96 of file TGo4FitterConfig.cxx.

References FindDepen(), fxParsDepend, and TGo4FitDependency::SetExpression().

void TGo4FitterConfig::AddResult ( const char *  Expression  ) 

Add expression for calculating result value.

Definition at line 102 of file TGo4FitterConfig.cxx.

References fxResults.

void TGo4FitterConfig::AddResult ( Double_t  Value  ) 

Add constant value as result value.

Definition at line 106 of file TGo4FitterConfig.cxx.

References fxResults.

TGo4FitParsList& TGo4FitterConfig::GetParsCfg (  )  [inline]

Get list of TGo4FitParameter objects, used as explicit configuration for minimizing.

Definition at line 134 of file TGo4FitterConfig.h.

References fxParsCfg.

TGo4FitParsList& TGo4FitterConfig::GetParsNew (  )  [inline]

Get list of TGo4FitParameter objects, which can be used in minimization and dependency calculations.

Definition at line 139 of file TGo4FitterConfig.h.

References fxParsNew.

Referenced by TGo4FitterAbstract::CollectAllPars().

TObjArray& TGo4FitterConfig::GetParsInit (  )  [inline]

Returns list of TGo4FitDependency objects, used for parameters initialization.

Definition at line 144 of file TGo4FitterConfig.h.

References fxParsInit.

Referenced by TGo4FitterAbstract::ApplyConfig(), and TGo4FitterAbstract::IsSuitableConfig().

TObjArray& TGo4FitterConfig::GetParsDepend (  )  [inline]

Returns list of TGo4FitDependency objects, used for dependencies calculations.

Definition at line 149 of file TGo4FitterConfig.h.

References fxParsDepend.

Referenced by TGo4FitterAbstract::ApplyConfig(), TGo4FitterAbstract::ExecuteDependencies(), and TGo4FitterAbstract::IsSuitableConfig().

TObjArray& TGo4FitterConfig::GetResults (  )  [inline]

Returns list of TGo4FitDependency objects, used for calculating result values for fitter.

Definition at line 154 of file TGo4FitterConfig.h.

References fxResults.

Referenced by TGo4FitterAbstract::ApplyConfig(), TGo4FitterAbstract::Finalize(), and TGo4FitterAbstract::IsSuitableConfig().

void TGo4FitterConfig::DoAction ( TGo4FitterAbstract Fitter  )  [virtual]

Do configuration action.

Calls TGoFitterAbstract::ApplyConfig(this) method.

Implements TGo4FitterAction.

Definition at line 110 of file TGo4FitterConfig.cxx.

References TGo4FitterAbstract::ApplyConfig().

void TGo4FitterConfig::Print ( Option_t *  option  )  const [virtual]

Print information on standard output.

Reimplemented from TGo4FitNamed.

Definition at line 114 of file TGo4FitterConfig.cxx.

References fxParsCfg, fxParsDepend, fxParsInit, fxParsNew, fxResults, TGo4FitParsList::Print(), and TGo4FitNamed::Print().

TGo4FitParameter * TGo4FitterConfig::MakeParForProperties ( const char *  ParName  )  [protected]

Definition at line 40 of file TGo4FitterConfig.cxx.

References TGo4FitParsList::CreatePar(), TGo4FitParsList::FindPar(), and fxParsCfg.

Referenced by SetParEpsilon(), SetParFixed(), and SetParRange().

TGo4FitDependency * TGo4FitterConfig::FindDepen ( const char *  FullName,
TObjArray *  list 
) [protected]

Definition at line 76 of file TGo4FitterConfig.cxx.

Referenced by SetParDepend(), and SetParInit().


Member Data Documentation

TGo4FitParsList TGo4FitterConfig::fxParsCfg [protected]

List of parameters objects, used for alternative configuration of parameters, which should be fitted.

Definition at line 175 of file TGo4FitterConfig.h.

Referenced by GetParEpsilon(), GetParFixed(), GetParRange(), GetParsCfg(), MakeParForProperties(), and Print().

TGo4FitParsList TGo4FitterConfig::fxParsNew [protected]

List of parameters object, which can be used in dependency calculations and minimization.

Definition at line 181 of file TGo4FitterConfig.h.

Referenced by AddParNew(), GetParsNew(), and Print().

TObjArray TGo4FitterConfig::fxParsInit [protected]

Array of dependencies for parameters initialization.

Definition at line 187 of file TGo4FitterConfig.h.

Referenced by GetParsInit(), Print(), SetParInit(), and TGo4FitterConfig().

TObjArray TGo4FitterConfig::fxParsDepend [protected]

Array of dependencies (TGo4FitDependency) for introducing dependency between fitted parameters.

Definition at line 193 of file TGo4FitterConfig.h.

Referenced by GetParsDepend(), Print(), SetParDepend(), and TGo4FitterConfig().

TObjArray TGo4FitterConfig::fxResults [protected]

Array of TGo4FitDependency objects, which repersent equations to calculate result values in fitter.

Definition at line 199 of file TGo4FitterConfig.h.

Referenced by AddResult(), GetResults(), Print(), and TGo4FitterConfig().

Bool_t TGo4FitterConfig::fbFixedByDefault [protected]

Determine, if all parameters should be fixed by default.

Definition at line 205 of file TGo4FitterConfig.h.


The documentation for this class was generated from the following files:
Generated on Thu Oct 28 15:54:23 2010 for Go4-Fitpackagev4.04-2 by  doxygen 1.5.1