Go4Fit
Class TGo4Fitter

class TGo4Fitter

derived from TGo4FitterAbstract

Central class of Go4Fit package.

Fields inherited from class TNamed

fName, fTitle

Fields inherited from class Go4Fit.TGo4FitSlotList

fbUpdateSlotList, fxSlotList

Constructor Summary

TGo4Fitter()           Default constructor.

TGo4Fitter(const char * iName, const char * iTitle)           Creates TGo4Fitter object and sets name and title.

TGo4Fitter(const char * iName, Int_t iFitFunctionType, Bool_t IsAddStandardActions)           Creates TGo4Fitter object and set type of fit function.

Destructor Summary
virtual synchronized	~TGo4Fitter()           Destructor.

Method Summary
void	AddAmplEstimation(Int_t NumIters)           Add amplitude estimation to actions list.
TGo4FitData*	AddData(TGo4FitData* d)           Add data object to fitter.
TGo4FitModelGauss1*	AddGauss1(const char * DataName, const char * ModelName, Double_t iPosition, Double_t iWidth, Double_t iAmpl, Int_t Axis)           Add 1-dim gaussian model to fitter.
TGo4FitDataGraph*	AddGraph(const char * DataName, TGraph* gr, Bool_t Owned, Double_t lrange, Double_t rrange)           Create TGo4FitDataGraph object and adds its to fitter.
TGo4FitDataHistogram*	AddH1(const char * DataName, TH1* histo, Bool_t Owned, Double_t lrange, Double_t rrange)           Create TGo4FitDataHistogram object and adds its to fitter.
TGo4FitModel*	AddModel(TGo4FitModel* m)           Add model component to fitter.
TGo4FitModel*	AddModel(const char * DataName, TGo4FitModel* m)           Add model component to fitter and assign it to specified data object.
void	AddPolynoms(const char * DataName, const char * NamePrefix, Int_t MaxOrder, Int_t NumAxis, Int_t GroupIndex)           Construct full polynom for specified data object.
void	AddPolynomX(const char * DataName, const char * NamePrefix, Int_t MaxOrder, Int_t GroupIndex, Double_t lrange, Double_t rrange)           Construct 1-dim polynom for specified data object for x scale.
void	AddPolynomX(const char * DataName, const char * NamePrefix, TArrayD& Coef, Int_t GroupIndex)           Construct 1-dim polynom with specified polynom coefficients NamePrefix sets prefix of model name for each polynom component.
void	AddStandardActions()           Add list of standard actions to fitter.
void	AssignModelTo(const char * ModelName, const char * DataName, Double_t RatioValue, Bool_t FixRatio)           Assign model to specified data object.
protected Double_t	CalculateFCN(Int_t FitFunctionType, TGo4FitData* selectdata)
Double_t	CalculateFitFunction(Double_t* pars, Int_t FitFunctionType, const char * DataName)           Calculate value of fit function for given set of parameters and specified type of fit function (it can not correspond to minimized fit function type).
Int_t	CalculateNDF(const char * DataName)           Calculates number of degree of freedom (NDF).
Double_t	CalculatesIntegral(const char * DataName, const char * ModelName, Bool_t OnlyCounts)           Calculates integral for data or model (if ModelName is specified) if OnlyCounts specified, only sum of values in bins position are calculated
Double_t	CalculatesModelIntegral(const char * ModelName, Bool_t OnlyCounts)           Calculates integral of model (if ModelName is specified) if OnlyCounts specified, only sum of values in bins position are calculated
Bool_t	CalculatesMomentums(const char * DataName, Bool_t UseRanges, Bool_t SubstractModels, Double_t& first, Double_t& second)           Calculates first and second momentum for specified data Usage of ranges and substraction of model can be specified
void	ChangeDataNameInAssignments(const char * oldname, const char * newname)           Change data name in model component assignments.
private void	CheckSlotsBeforeDelete(TGo4FitComponent* comp)
virtual void	Clear(Option_t* option)           Remove all data, all models and all actions
void	ClearModelAssignmentTo(const char * ModelName, const char * DataName)           Remove assignment to given data (if exists).
protected virtual void	CollectAllPars()
TObject*	CreateDrawObject(const char * ObjName, const char * DataName, Bool_t IsModel, const char * ModelName)           Create object (TH1 or TGraph), which can be drawn.
protected Bool_t	DataBuffersAllocated(TGo4FitData* data)
void	DeleteAllData()           Delete all data objects from fitter.
void	DeleteAllModels()           Delete all model objects from fitter.
void	DeleteModelsAssosiatedTo(const char * DataName)           Remove models assosiated with specific data.
protected virtual Double_t	DoCalculation()
protected virtual Int_t	DoNDFCalculation()
virtual void	Draw(Option_t* option)           Draw fitter on current canvas.
void	EstimateAmplitudes(Int_t NumIters)           Estimate amplitude of all model components.
virtual void	FillSlotList(TSeqCollection* list)           Collect all TGo4FitSlot objects, situated in fitter, data and models to givven TObjArray.
protected virtual void	FinalizeFitterData()
TGo4FitData*	FindData(const char * DataName)           Return data object with given name. if no corresponding objects, return 0.
TGo4FitModel*	FindModel(const char * ModelName)           Return model component with given name.
TString	FindNextName(const char * Head, Int_t start, Bool_t isModel)
TGo4FitComponent*	GetComp(Int_t n)           Return TGo4FitComponent object with given index.
TGo4FitData*	GetData(Int_t n)           Return data object with given index.
protected Double_t*	GetDataBinsDevs(TGo4FitData* data)
protected Double_t*	GetDataBinsResult(TGo4FitData* data)
protected Int_t	GetDataBinsSize(TGo4FitData* data)
protected Double_t*	GetDataBinsValues(TGo4FitData* data)
const const char *	GetDataName(Int_t n)           Return name of data object with given index.
Int_t	GetFitFunctionType()           Return type of fitted function.
Int_t	GetMemoryUsage()           Retrurn value of memory usage parameter.
TGo4FitModel*	GetModel(Int_t n)           Return model component with given index.
protected Double_t*	GetModelBinsValues(TGo4FitModel* model, const char * DataName)
const Int_t	GetNumComp()           Return total number of TGo4FitComponent (data and model) objects in fitter.
const Int_t	GetNumData()           Return number of data objects in fitter.
const Int_t	GetNumModel()           Return number of model component in fitter.
protected virtual Bool_t	InitFitterData()
protected Bool_t	ModelBuffersAllocated(TGo4FitModel* model)
private void	MoveDrawObjectsToROOT()
Int_t	NumModelsAssosiatedTo(const char * DataName)           Counts models assosiated with specific data.
protected Double_t	PointFitFunction(Int_t FitFunctionType, Double_t value, Double_t modelvalue, Double_t standdev)
virtual const void	Print(Option_t* option)           Print containment of fitter.
const void	PrintAmpls()           Print value of all amplitude parameters.
const void	PrintLines()           Print amplitude, position and width for each model components
void	ProvideLastDrawObjects(TObjArray& lst)           Copy pointer on drawn object after last command to specified TObjArray.
protected void	RebuildAll(Bool_t ForceBuild)           Update all data objects and model components acording to current parameters values.
TGo4FitData*	RemoveData(const char * DataName, Bool_t IsDel)           Remove data object from fitter.
TGo4FitModel*	RemoveModel(const char * ModelName, Bool_t IsDel)           Remove model component from fitter.
void	SetFitFunctionType(Int_t iFitFunctionType)           Set fitted function type for minimization.
TGo4FitDataGraph*	SetGraph(const char * DataName, TGraph* gr, Bool_t Owned)           Set graph to existing TGo4FitDataGraph object
TGo4FitDataHistogram*	SetH1(const char * DataName, TH1* histo, Bool_t Owned)           Set histogram to existing TGo4FitDataHistogram object
void	SetMemoryUsage(Int_t iMemoryUsage)           Set value of memory usage.
void	SetUserFitFunction(TUserFitFunction iFunc)           Set user-defined fitted function.

Methods inherited from class Go4Fit.TGo4FitterAbstract

AddAction, AddActionAt, AddOutputAction, AddSimpleMinuit, ApplyConfig, CalculateFitFunction, CheckParsListChanging, CopyParsValuesFrom, DeleteAction, DeleteActions, DeleteOutputActions, DoAction, DoAction, DoActions, ExecuteDependencies, Finalize, FinalizeDependencies, Get, GetAction, GetNumActions, GetNumResults, GetParEpsilon, GetParFixed, GetParRange, GetResultFF, GetResultNDF, GetResults, GetResultValue, Initialize, InitializeDependencies, IsInitialized, IsParsAsResults, IsSuitableConfig, NeedPadsNumber, NumPars, PrintResults, ProcessObjects, ReplaceAction, RunDependenciesList, SetPad, SetParsListChange

Methods inherited from class Go4Fit.TGo4FitParsList

AddPar, CanRollbackPars, ClearPars, ClearParsBlocking, CollectParsTo, CreatePar, Find, Find, Find, FindPar, FindPar, FindPar, GetPar, GetParError, GetParFullName, GetParIndex, GetParName, GetParsValues, GetParValue, InsertPar, IsAllParsFixed, MemorizePars, NumFixedPars, NumFreePars, PrintPars, RememberPars, RemovePar, RemovePar, RemoveParByIndex, SetParEpsilon, SetParError, SetParFixed, SetParName, SetParRange, SetParsNames, SetParsOwner, SetParsValues, SetParsValues, SetParValue

Methods inherited from class Go4Fit.TGo4FitNamed

GetFullName, GetOwner, GetOwnerFullName, SetOwner

Methods inherited from class TNamed

operator=, Clone, Compare, Copy, FillBuffer, GetName, GetTitle, Hash, IsSortable, SetName, SetNameTitle, SetTitle, ls, Sizeof, Class, Class_Name, Class_Version, Dictionary, IsA, ShowMembers, Streamer, StreamerNVirtual, DeclFileName, ImplFileLine, ImplFileName, DeclFileLine

Methods inherited from class Go4Fit.TGo4FitSlotList

CheckDuplicatesOnSlot, CheckObjects, ClearObjects, ClearSlot, ConnectSlots, ConnectSlots, FindSlot, GetSlot, GetSlotList, IsEmptySlots, IsObjectInSlots, NumSlots, PrepareSlotsForWriting, SetObject, SetObject, SetSaveFlagForObjects, SetUpdateSlotList

Field Detail

fiFitFunctionType

protected Int_t fiFitFunctionType

Defines type of fitted function.

protected Int_t fiMemoryUsage

Defines use of memory during actions executions.

protected TObjArray fxDatas

Container for data objects.

private TObjArray* fxDrawObjs

protected TObjArray fxModels

Container for model components.

private TUserFitFunction fxUserFitFunction

Pointer on user fit function.

public TGo4Fitter()

Default constructor.

public TGo4Fitter(const char * iName, const char * iTitle)

Creates TGo4Fitter object and sets name and title.

public TGo4Fitter(const char * iName, Int_t iFitFunctionType, Bool_t IsAddStandardActions)

Creates TGo4Fitter object and set type of fit function.
If AddStandardActions flag is set,

public virtual synchronized ~TGo4Fitter()

Destructor. Delete TGo4Fitter object.

public void AddAmplEstimation(Int_t NumIters)

Add amplitude estimation to actions list.

public TGo4FitData* AddData(TGo4FitData* d)

Add data object to fitter. Data object owned by fitter and will be destroyed together with fitter.

public TGo4FitModelGauss1* AddGauss1(const char * DataName, const char * ModelName, Double_t iPosition, Double_t iWidth, Double_t iAmpl, Int_t Axis)

Add 1-dim gaussian model to fitter.

public TGo4FitDataGraph* AddGraph(const char * DataName, TGraph* gr, Bool_t Owned, Double_t lrange, Double_t rrange)

Create TGo4FitDataGraph object and adds its to fitter.

public TGo4FitDataHistogram* AddH1(const char * DataName, TH1* histo, Bool_t Owned, Double_t lrange, Double_t rrange)

Create TGo4FitDataHistogram object and adds its to fitter.

public TGo4FitModel* AddModel(TGo4FitModel* m)

Add model component to fitter. Model already should be assigned to at least one data object.

public TGo4FitModel* AddModel(const char * DataName, TGo4FitModel* m)

Add model component to fitter and assign it to specified data object.

public void AddPolynoms(const char * DataName, const char * NamePrefix, Int_t MaxOrder, Int_t NumAxis, Int_t GroupIndex)

Construct full polynom for specified data object.
NamePrefix sets prefix of model name for each polynom component.
MaxOrder sets maximum order of polynom (default =1 )
NumAxis sets number of axis, for which polynom will be sets
GroupIndex sets index of models group for all polyn components (default = 0 - background group)

public void AddPolynomX(const char * DataName, const char * NamePrefix, Int_t MaxOrder, Int_t GroupIndex, Double_t lrange, Double_t rrange)

Construct 1-dim polynom for specified data object for x scale.
NamePrefix sets prefix of model name for each polynom component.
MaxOrder sets maximum order of polynom (default =1 )
NumAxis sets number of axis, for which polynom will be sets
GroupIndex sets index of models group for all polyn components (default = 0 - background group)
lbound and rbound sets range, where polynom will be calculated

public void AddPolynomX(const char * DataName, const char * NamePrefix, TArrayD& Coef, Int_t GroupIndex)

Construct 1-dim polynom with specified polynom coefficients
NamePrefix sets prefix of model name for each polynom component.
GroupIndex sets index of models group for all polyn components (default = 0 - background group)

public void AddStandardActions()

Add list of standard actions to fitter.
Now : AmplEstimate action and Minuit minimizer with "MIGRAD 500 1" command.

public void AssignModelTo(const char * ModelName, const char * DataName, Double_t RatioValue, Bool_t FixRatio)

Assign model to specified data object.
When model assigns to more then one data, additional "Ratio1", "Ratio2" and so on parameters will be created.
They means ratio in amplitude of model component in this data to ampltute of this component in data, to wich model was assigned first. By default, this ratio is 1. and not fixed.

protected Double_t CalculateFCN(Int_t FitFunctionType, TGo4FitData* selectdata)

public Double_t CalculateFitFunction(Double_t* pars, Int_t FitFunctionType, const char * DataName)

Calculate value of fit function for given set of parameters and specified type of fit function (it can not correspond to minimized fit function type). If DataName not specified (default), fitfunction calculates for all data objects.

public Int_t CalculateNDF(const char * DataName)

Calculates number of degree of freedom (NDF).
If DataName not specified (default), NDF calculates for all data objects.
NDF defined as total number of bins in data object minus number of variable parameters.

public Double_t CalculatesIntegral(const char * DataName, const char * ModelName, Bool_t OnlyCounts)

Calculates integral for data or model (if ModelName is specified)
if OnlyCounts specified, only sum of values in bins position are calculated

public Double_t CalculatesModelIntegral(const char * ModelName, Bool_t OnlyCounts)

Calculates integral of model (if ModelName is specified)
if OnlyCounts specified, only sum of values in bins position are calculated

public Bool_t CalculatesMomentums(const char * DataName, Bool_t UseRanges, Bool_t SubstractModels, Double_t& first, Double_t& second)

Calculates first and second momentum for specified data
Usage of ranges and substraction of model can be specified

public void ChangeDataNameInAssignments(const char * oldname, const char * newname)

Change data name in model component assignments.
This function should be used, if data name is changing out of the fitter.

private void CheckSlotsBeforeDelete(TGo4FitComponent* comp)

public virtual void Clear(Option_t* option)

Remove all data, all models and all actions

public void ClearModelAssignmentTo(const char * ModelName, const char * DataName)

Remove assignment to given data (if exists).
If DataName==0, all assignments will be cleared.

protected virtual void CollectAllPars()

public TObject* CreateDrawObject(const char * ObjName, const char * DataName, Bool_t IsModel, const char * ModelName)

Create object (TH1 or TGraph), which can be drawn.
Object can contain data bins (IsModel = kFALSE), full data model (IsModel = kTRUE, ModelName = 0) or specific model component (IsModel = kTRUE, ModelName specify component name)

protected Bool_t DataBuffersAllocated(TGo4FitData* data)

public void DeleteAllData()

Delete all data objects from fitter.

public void DeleteAllModels()

Delete all model objects from fitter.

public void DeleteModelsAssosiatedTo(const char * DataName)

Remove models assosiated with specific data.

protected virtual Double_t DoCalculation()

protected virtual Int_t DoNDFCalculation()

public virtual void Draw(Option_t* option)

Draw fitter on current canvas.
As options, data name(s) or component name(s) should be specified, separated by commas.
For instance:
Draw("data1") - draw data object with name "data1" and it's full model
Draw("data1,Gauss1,Gauss2") - draw data object "data1", full model and model components with names "Gauss1" and "Gauss2"
All objects is created via CreateDrawObject() method and stored in internal list. They will be moved to ROOT when fitter will be destroyed.

public void EstimateAmplitudes(Int_t NumIters)

Estimate amplitude of all model components.
This routine typically should be executed before general minimization routine.
To obtain good estimation of amplitudes, rest model parameters (like position and widths) should has good estimation, otherwise amplitude estimation routine gives unacceptable values.

public virtual void FillSlotList(TSeqCollection* list)

Collect all TGo4FitSlot objects, situated in fitter, data and models to givven TObjArray.

protected virtual void FinalizeFitterData()

public TGo4FitData* FindData(const char * DataName)

Return data object with given name. if no corresponding objects, return 0.

public TGo4FitModel* FindModel(const char * ModelName)

Return model component with given name. If no such model name exists, return 0.

public TString FindNextName(const char * Head, Int_t start, Bool_t isModel)

public TGo4FitComponent* GetComp(Int_t n)

Return TGo4FitComponent object with given index.
If index < GetNumData() return data object, else return model component.
If index not valid, return 0.

public TGo4FitData* GetData(Int_t n)

Return data object with given index. If index out of valid range, return 0.

protected Double_t* GetDataBinsDevs(TGo4FitData* data)

protected Double_t* GetDataBinsResult(TGo4FitData* data)

protected Int_t GetDataBinsSize(TGo4FitData* data)

protected Double_t* GetDataBinsValues(TGo4FitData* data)

public const const char * GetDataName(Int_t n)

Return name of data object with given index. If index not valid, return 0.

public Int_t GetFitFunctionType()

Return type of fitted function. For possible values see SetFitFunctionType() method.

public Int_t GetMemoryUsage()

Retrurn value of memory usage parameter.
See SetMemoryUsage for detailed description.

public TGo4FitModel* GetModel(Int_t n)

Return model component with given index. If index out of valid range, return 0.

protected Double_t* GetModelBinsValues(TGo4FitModel* model, const char * DataName)

public const Int_t GetNumComp()

Return total number of TGo4FitComponent (data and model) objects in fitter.
This is just a sum GetNumData()+GetNumModel().

public const Int_t GetNumData()

Return number of data objects in fitter.

public const Int_t GetNumModel()

Return number of model component in fitter.

protected virtual Bool_t InitFitterData()

protected Bool_t ModelBuffersAllocated(TGo4FitModel* model)

private void MoveDrawObjectsToROOT()

public Int_t NumModelsAssosiatedTo(const char * DataName)

Counts models assosiated with specific data.

protected Double_t PointFitFunction(Int_t FitFunctionType, Double_t value, Double_t modelvalue, Double_t standdev)

public virtual const void Print(Option_t* option)

Print containment of fitter.
If option = "**", print also containment of all associated objects like histogram, calibrations and so on.

public const void PrintAmpls()

Print value of all amplitude parameters.

public const void PrintLines()

Print amplitude, position and width for each model components

public void ProvideLastDrawObjects(TObjArray& lst)

Copy pointer on drawn object after last command to specified TObjArray.
From this moment user should take care about proper destroyment of this objects.

protected void RebuildAll(Bool_t ForceBuild)

Update all data objects and model components acording to current parameters values.
Only those objects will be recalculated, which parameters were changed after last recalculation.
If ForceBuild flag is set (default = kFALSE), all objects will be recalculated anyway.

public TGo4FitData* RemoveData(const char * DataName, Bool_t IsDel)

Remove data object from fitter. If IsDel flag is set, object will be destroyed, otherwise (by default) function return pointer on this object.

public TGo4FitModel* RemoveModel(const char * ModelName, Bool_t IsDel)

Remove model component from fitter. If IsDel flag specified, component is delete, otherwise (by default) function return pointer on this model component.

public void SetFitFunctionType(Int_t iFitFunctionType)

Set fitted function type for minimization. Possible values are:
TGo4Fitter:ff_least_squares = 0 sum of difference squares between model and data;
TGo4Fitter:ff_chi_square = 1 standard chi-square sum
TGo4Fitter:ff_chi_Pearson = 2 Pearson chi-square for Poisson statistic
TGo4Fitter:ff_chi_Neyman = 3 modified Neyman chi-square for Poisson statistic
TGo4Fitter:ff_chi_gamma = 4 modified chi-square for Poisson statistic
TGo4Fitter:ff_ML_Poisson = 5 -2Ln from maximum likelihood function for Poisson statistic
TGo4Fitter:ff_user = 6 user function
User function type should not be specified directly, but using SetUserFitFunction() method.
More informtation about fit function types can be found in Go4Fit tutorial.

public TGo4FitDataGraph* SetGraph(const char * DataName, TGraph* gr, Bool_t Owned)

Set graph to existing TGo4FitDataGraph object

public TGo4FitDataHistogram* SetH1(const char * DataName, TH1* histo, Bool_t Owned)

Set histogram to existing TGo4FitDataHistogram object

public void SetMemoryUsage(Int_t iMemoryUsage)

Set value of memory usage.
This parameter can be:
0 - no aditional memory will be allocated in buffers
1 - buffers will be allocated only for data objects
2 - buffers will be used for all data and models objects
3 - individual setup for data and model objects will be used for memory allocaions

public void SetUserFitFunction(TUserFitFunction iFunc)

Set user-defined fitted function.
Function should be global and has following signature:
Double_t (*TUserFitFunction)(Int_t, Double_t*, Double_t*)
First parameter - number of points,
Second - array of data points,
Third - array of model points.
Function should return value, which will be MINIMIZED by fitter.
If necessary maximization, fit function should return negative value.

Association Links

to Class TObjArray

Container for data objects.

to Class TObjArray

Container for model components.

to Class TObjArray

to Class TGo4FitModel

Label TObjArray of models

Supplier Cardinality 0..*

Type aggregation

to Class TGo4FitData

Label TObjArray of data

Supplier Cardinality 0..*

Type aggregation