TGo4FitParsList Class Reference

List of TGo4FitParameter objects. More...

#include <TGo4FitParsList.h>

Inheritance diagram for TGo4FitParsList:


Public Member Functions
	TGo4FitParsList ()
	Default constructor.
	TGo4FitParsList (Bool_t IsParsOwned)
	Create TGo4FitParsList object and set flag of ownership of parameters object.
	TGo4FitParsList (const char Name, const char Title, Bool_t IsParsOwned)
	Create TGo4FitParsList object, set it's name and title, and ownership flag of parameters pbjects.
virtual	~TGo4FitParsList ()
	Destroy TGo4FitParsList object.
virtual Int_t	NumPars ()
	Return number of parameters in list.
TGo4FitParameter *	GetPar (Int_t n)
	Return parameter according given index.
Int_t	GetParIndex (const TGo4FitParameter *par)
	Return index of given parameter in list.
TGo4FitParameter *	FindPar (const char *ParName)
	Find parameter object with given name.
TGo4FitParameter *	FindPar (const char OwnerFullName, const char ParName)
	Find parameter with given owner full name and parameter name.
TGo4FitParameter *	FindPar (TGo4FitParameter *par)
	Find parameter in list.
Double_t	GetParValue (const char *ParName)
	Return value of parameter with given name.
Bool_t	SetParValue (const char *ParName, Double_t iValue)
	Set value of parameter with given name.
void	GetParsValues (Double_t *pars)
	Copy values of all parameters in list to provided array.
void	SetParsValues (Double_t *pars)
	Set value for all parameters from array.
Double_t	GetParError (const char *ParName)
	Get error value for parameter with given name.
Bool_t	SetParError (const char *ParName, Double_t iError)
	Set error value for parameter with given name.
virtual Bool_t	SetParFixed (const char *ParName, Bool_t iFixed=kTRUE)
	Set for parameter with given name, is it fixed or not.
virtual Bool_t	GetParFixed (const char *ParName)
	Return status for parameter with given name, is it fixed or not.
Int_t	NumFixedPars ()
	Return number of fixed pars.
Int_t	NumFreePars ()
	Return number of free pars.
virtual Bool_t	SetParRange (const char *ParName, Double_t RangeMin, Double_t RangeMax)
	Set range limits for parameter with given name.
virtual Bool_t	GetParRange (const char *ParName, Double_t &RangeMin, Double_t &RangeMax)
	Get range limits for parameter with given name.
virtual Bool_t	SetParEpsilon (const char *ParName, Double_t Epsilon)
	Set epsilon value for parameter with given name.
virtual Bool_t	GetParEpsilon (const char *ParName, Double_t &Epsilon)
	Get epsilon value for parameter with given name.
void	SetParName (Int_t n, const char *name)
	Set new name for parameter object with provided index.
const char *	GetParName (Int_t n)
	Return name of parameter with given index.
const char *	GetParFullName (Int_t n)
	Return full name of parameter with given index.
void	SetParsNames (const char name0="Par0", const char name1="Par1", const char name2="Par2", const char name3="Par3", const char name4="Par4", const char name5="Par5", const char name6="Par6", const char name7="Par7", const char name8="Par8", const char name9="Par9")
	Set names of first 10 parameters.
void	SetParsValues (Double_t par0=0., Double_t par1=0., Double_t par2=0., Double_t par3=0., Double_t par4=0., Double_t par5=0., Double_t par6=0., Double_t par7=0., Double_t par8=0., Double_t par9=0.)
	Set values for first 10 parameters.
virtual void	MemorizePars ()
	Memorize values of all parameters.
virtual bool	CanRollbackPars ()
	Return true if parameters can be safely restored from memorized values;.
virtual void	RememberPars ()
	Restore parameters values, which were stored by MemorizePars() routine;.
Bool_t	IsAllParsFixed ()
	Returns true, if all parameters in list fixed;.
TGo4FitParameter *	CreatePar (const char ParName, const char Title, Double_t iValue=0)
	Create new TGo4FitParameter object with given name, title and parameter value, and put this object to the list.
Bool_t	RemovePar (const char *name)
	Remove parameter from list with given name.
Bool_t	RemovePar (TGo4FitParameter *par)
	Remove parameter from list.
virtual void	Print (Option_t *option) const
	Default print method.
void	PrintPars () const
	Print only value and error of all parameters in list.
virtual void	CollectParsTo (TGo4FitParsList &list)
	Add all parameters to provided TGo4FitParsList object.
void	ClearPars ()
	Remove all parameters from list.
Protected Member Functions
TGo4FitParameter *	AddPar (TGo4FitParameter *par)
TGo4FitParameter *	InsertPar (TGo4FitParameter *par, Int_t indx)
void	SetParsOwner (TGo4FitNamed *iOwner)
void	ClearParsBlocking ()
virtual TGo4FitParameter *	Get (Int_t n)
TGo4FitParameter *	Find (const char *ParName)
TGo4FitParameter *	Find (const char OwnerFullName, const char ParName)
TGo4FitParameter *	Find (TGo4FitParameter *par)
Bool_t	RemoveParByIndex (Int_t indx)
Private Attributes
TOrdCollection	fxPars
Bool_t	fbCanRollbackPars
	If true, parameters can be safely rollback.

Detailed Description

List of TGo4FitParameter objects.

Contain list of parameters and provides access to parameters properties via names. Parameters objects may owned or not owned by TGo4FitParsList object.

Definition at line 28 of file TGo4FitParsList.h.

Constructor & Destructor Documentation

TGo4FitParsList::TGo4FitParsList ( )

Default constructor.

Definition at line 21 of file TGo4FitParsList.cxx.

Referenced by TGo4FitModel::Initialize().

TGo4FitParsList::TGo4FitParsList ( Bool_t IsParsOwned )

Create TGo4FitParsList object and set flag of ownership of parameters object.

Definition at line 25 of file TGo4FitParsList.cxx.

References fxPars.

TGo4FitParsList::TGo4FitParsList	(	const char *	Name,
		const char *	Title,
		Bool_t	IsParsOwned
	)

Create TGo4FitParsList object, set it's name and title, and ownership flag of parameters pbjects.

Definition at line 29 of file TGo4FitParsList.cxx.

References fxPars.

TGo4FitParsList::~TGo4FitParsList ( ) [virtual]

Destroy TGo4FitParsList object.

Definition at line 33 of file TGo4FitParsList.cxx.

Member Function Documentation

virtual Int_t TGo4FitParsList::NumPars ( ) [inline, virtual]

Return number of parameters in list.

Reimplemented in TGo4FitModel, and TGo4FitterAbstract.

Definition at line 54 of file TGo4FitParsList.h.

References fxPars.

Referenced by ClearParsBlocking(), CollectParsTo(), Find(), Get(), TGo4FitModel::Get(), TGo4FitMatrixTrans::GetNumAxis(), TGo4FitModelFormula::GetNumberOfExprPar(), TGo4FitModelFunction::GetNumberOfFuncPar(), GetParIndex(), GetParsValues(), TGo4FitModel::Initialize(), IsAllParsFixed(), MemorizePars(), TGo4FitComponent::NewAmplitude(), NumFixedPars(), NumFreePars(), TGo4FitterAbstract::NumPars(), TGo4FitModel::NumPars(), Print(), PrintPars(), TGo4FitModel::RebuildShape(), RememberPars(), RemoveParByIndex(), TGo4FitMatrixTrans::SetNumAxis(), SetParsOwner(), and SetParsValues().

TGo4FitParameter* TGo4FitParsList::GetPar ( Int_t n ) [inline]

Return parameter according given index.

If index out of valid range, return 0.

Definition at line 60 of file TGo4FitParsList.h.

References Get().

Referenced by TGo4FitModelGauss2::BeforeEval(), TGo4FitModelGauss1::BeforeEval(), TGo4FitModelFormula::BeforeEval(), TGo4FitModelGaussN::FillMuVector(), TGo4FitModelGaussN::FillSigmaMatrix(), TGo4FitComponent::GetAmplPar(), TGo4FitLinearTrans::GetCoefB(), TGo4FitLinearTrans::GetCoefK(), TGo4FitModelFormula::GetExprPar(), TGo4FitModelFunction::GetFuncPar(), GetParIndex(), TGo4FitModelGauss1::Integral(), Print(), PrintPars(), TGo4FitModel::RebuildShape(), TGo4FitLinearTrans::SetCoef(), TGo4FitLinearTrans::SetCoefB(), TGo4FitLinearTrans::SetCoefK(), and TGo4FitMatrixTrans::Transformation().

Int_t TGo4FitParsList::GetParIndex ( const TGo4FitParameter * par )

Return index of given parameter in list.

If parameter not in list, return -1.

Definition at line 36 of file TGo4FitParsList.cxx.

References GetPar(), and NumPars().

Referenced by CollectParsTo(), TGo4FitModelFunction::GetPosParIndex(), TGo4FitModelFormula::GetPosParIndex(), TGo4FitModelFunction::GetWidthParIndex(), TGo4FitModelFormula::GetWidthParIndex(), TGo4FitterAbstract::InitializeDependencies(), TGo4FitModelGaussN::SetAxisNumbers(), and TGo4FitModelPolynom::SetMaxNumAxis().

TGo4FitParameter* TGo4FitParsList::FindPar ( const char * ParName ) [inline]

Find parameter object with given name.

Name can be both name or full name of TGo4FitParameter object. If no such parameters exists, return 0.

Definition at line 72 of file TGo4FitParsList.h.

References Find().

Referenced by TGo4FitterAbstract::CopyParsValuesFrom(), TGo4FitModelPolynom::GetMaxNumAxis(), TGo4FitModelPolynom::GetPolynomOrder(), TGo4FitterConfig::MakeParForProperties(), RemovePar(), TGo4FitModelGaussN::SetAxisNumbers(), and TGo4FitModelPolynom::SetMaxNumAxis().

TGo4FitParameter* TGo4FitParsList::FindPar	(	const char *	OwnerFullName,
		const char *	ParName
	)			`[inline]`

Find parameter with given owner full name and parameter name.

If no such parameters exists, return 0.

Definition at line 78 of file TGo4FitParsList.h.

References Find().

TGo4FitParameter* TGo4FitParsList::FindPar ( TGo4FitParameter * par ) [inline]

Find parameter in list.

If no such parameters exists, return 0.

Definition at line 84 of file TGo4FitParsList.h.

References Find().

Double_t TGo4FitParsList::GetParValue ( const char * ParName )

Return value of parameter with given name.

If no such parameter, return 0.

Definition at line 42 of file TGo4FitParsList.cxx.

References Find(), and TGo4FitParameter::GetValue().

Referenced by TGo4FitMinuit::DoAction().

Bool_t TGo4FitParsList::SetParValue	(	const char *	ParName,
		Double_t	iValue
	)

Set value of parameter with given name.

Return kTRUE in case of success, otherwise 0.

Definition at line 48 of file TGo4FitParsList.cxx.

References Find(), and TGo4FitParameter::SetValue().

Referenced by TGo4FitMinuit::DoAction().

void TGo4FitParsList::GetParsValues ( Double_t * pars )

Copy values of all parameters in list to provided array.

Array should have at lest NumPars() elements, otherwise routine can cause error.

Definition at line 54 of file TGo4FitParsList.cxx.

References Get(), TGo4FitParameter::GetValue(), and NumPars().

Referenced by TGo4FitterAbstract::ApplyConfig(), TGo4FitModel::BeforeEval(), TGo4FitterAbstract::Finalize(), TGo4FitModel::Initialize(), and TGo4FitMatrixTrans::SetNumAxis().

void TGo4FitParsList::SetParsValues ( Double_t * pars )

Set value for all parameters from array.

Definition at line 59 of file TGo4FitParsList.cxx.

References Get(), NumPars(), and TGo4FitParameter::SetValue().

Referenced by TGo4FitterAbstract::ApplyConfig(), TGo4FitterAbstract::CalculateFitFunction(), and TGo4Fitter::CalculateFitFunction().

Double_t TGo4FitParsList::GetParError ( const char * ParName )

Get error value for parameter with given name.

If no such parameters, return 0.

Definition at line 65 of file TGo4FitParsList.cxx.

References Find(), and TGo4FitParameter::GetError().

Bool_t TGo4FitParsList::SetParError	(	const char *	ParName,
		Double_t	iError
	)

Set error value for parameter with given name.

If such parameters exists, return kTRUE, otherwise kFALSE.

Definition at line 71 of file TGo4FitParsList.cxx.

References Find(), and TGo4FitParameter::SetError().

Referenced by TGo4FitMinuit::DoAction().

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

Set for parameter with given name, is it fixed or not.

Definition at line 77 of file TGo4FitParsList.cxx.

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

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

Return status for parameter with given name, is it fixed or not.

If parameter not exist, return kFALSE.

Reimplemented in TGo4FitterAbstract.

Definition at line 83 of file TGo4FitParsList.cxx.

References Find(), and TGo4FitParameter::GetFixed().

Referenced by TGo4FitterConfig::GetParFixed(), and TGo4FitterAbstract::GetParFixed().

Int_t TGo4FitParsList::NumFixedPars ( )

Return number of fixed pars.

Definition at line 89 of file TGo4FitParsList.cxx.

References Get(), and NumPars().

Referenced by NumFreePars().

Int_t TGo4FitParsList::NumFreePars ( )

Return number of free pars.

Definition at line 96 of file TGo4FitParsList.cxx.

References NumFixedPars(), and NumPars().

Referenced by TGo4Fitter::CalculateNDF().

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

Set range limits for parameter with given name.

Return kTRUE, if parameter exist.

Definition at line 101 of file TGo4FitParsList.cxx.

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

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

Get range limits for parameter with given name.

If succesfull, return kTRUE.

Reimplemented in TGo4FitterAbstract.

Definition at line 107 of file TGo4FitParsList.cxx.

References Find(), and TGo4FitParameter::GetRange().

Referenced by TGo4FitterConfig::GetParRange(), and TGo4FitterAbstract::GetParRange().

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

Set epsilon value for parameter with given name.

Return kTRUE, if parameter exist.

Definition at line 113 of file TGo4FitParsList.cxx.

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

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

Get epsilon value for parameter with given name.

Return kTRUE, is succesfull.

Reimplemented in TGo4FitterAbstract.

Definition at line 119 of file TGo4FitParsList.cxx.

References Find(), and TGo4FitParameter::GetEpsilon().

Referenced by TGo4FitterConfig::GetParEpsilon(), and TGo4FitterAbstract::GetParEpsilon().

void TGo4FitParsList::SetParName	(	Int_t	n,
		const char *	name
	)

Set new name for parameter object with provided index.

Definition at line 126 of file TGo4FitParsList.cxx.

References Get().

Referenced by SetParsNames().

const char * TGo4FitParsList::GetParName ( Int_t n )

Return name of parameter with given index.

If index out of valid range, return 0.

Definition at line 130 of file TGo4FitParsList.cxx.

References Get().

Referenced by TGo4FitModelFormula::CompileFormula().

const char * TGo4FitParsList::GetParFullName ( Int_t n )

Return full name of parameter with given index.

If index out of valid range, return 0.

Definition at line 135 of file TGo4FitParsList.cxx.

References Get(), and TGo4FitNamed::GetFullName().

Referenced by TGo4FitMinuit::DoAction(), TGo4FitterAbstract::InitializeDependencies(), PrintPars(), and TGo4FitterAbstract::ProcessObjects().

void TGo4FitParsList::SetParsNames	(	const char *	name0 = `"Par0"`,
		const char *	name1 = `"Par1"`,
		const char *	name2 = `"Par2"`,
		const char *	name3 = `"Par3"`,
		const char *	name4 = `"Par4"`,
		const char *	name5 = `"Par5"`,
		const char *	name6 = `"Par6"`,
		const char *	name7 = `"Par7"`,
		const char *	name8 = `"Par8"`,
		const char *	name9 = `"Par9"`
	)

Set names of first 10 parameters.

For instance: list->SetParsNames("CoefK","CoefB","Const"). If there are more then 3 parameters in list, for the rest parameters standard names will be applied: "Par3", "Par4" and so on.

Definition at line 140 of file TGo4FitParsList.cxx.

References SetParName().

void TGo4FitParsList::SetParsValues	(	Double_t	par0 = `0.`,
		Double_t	par1 = `0.`,
		Double_t	par2 = `0.`,
		Double_t	par3 = `0.`,
		Double_t	par4 = `0.`,
		Double_t	par5 = `0.`,
		Double_t	par6 = `0.`,
		Double_t	par7 = `0.`,
		Double_t	par8 = `0.`,
		Double_t	par9 = `0.`
	)

Set values for first 10 parameters.

For instance, list->SetParsValues(1,345,23); If more than 3 parameters in list, for rest 0 values will be set.

Definition at line 154 of file TGo4FitParsList.cxx.

References Get(), and TGo4FitParameter::SetValue().

void TGo4FitParsList::MemorizePars ( ) [virtual]

Memorize values of all parameters.

This values can be restore later by RemeberedPars().

Definition at line 168 of file TGo4FitParsList.cxx.

References fbCanRollbackPars, Get(), TGo4FitParameter::MemorizeValue(), and NumPars().

Referenced by TGo4FitterAbstract::ProcessObjects().

virtual bool TGo4FitParsList::CanRollbackPars ( ) [inline, virtual]

Return true if parameters can be safely restored from memorized values;.

Definition at line 213 of file TGo4FitParsList.h.

References fbCanRollbackPars.

void TGo4FitParsList::RememberPars ( ) [virtual]

Restore parameters values, which were stored by MemorizePars() routine;.

Definition at line 174 of file TGo4FitParsList.cxx.

References Get(), NumPars(), and TGo4FitParameter::RememberValue().

Referenced by TGo4FitterAbstract::ProcessObjects().

Bool_t TGo4FitParsList::IsAllParsFixed ( )

Returns true, if all parameters in list fixed;.

Definition at line 179 of file TGo4FitParsList.cxx.

References Get(), and NumPars().

TGo4FitParameter * TGo4FitParsList::CreatePar	(	const char *	ParName,
		const char *	Title,
		Double_t	iValue = `0`
	)

Create new TGo4FitParameter object with given name, title and parameter value, and put this object to the list.

Return created parameter object.

Definition at line 210 of file TGo4FitParsList.cxx.

References AddPar(), and Find().

Referenced by TGo4FitterConfig::AddParNew(), TGo4FitterConfig::MakeParForProperties(), and TGo4FitMatrixTrans::SetNumAxis().

Bool_t TGo4FitParsList::RemovePar ( const char * name )

Remove parameter from list with given name.

If parameter owned by list, parameter will be destroyed. Return kTRUE if succesfull.

Definition at line 246 of file TGo4FitParsList.cxx.

References FindPar().

Referenced by RemoveParByIndex(), TGo4FitModelGaussN::SetAxisNumbers(), TGo4FitModelPolynom::SetMaxNumAxis(), TGo4FitModelFormula::SetNumberOfExprPar(), and TGo4FitModelFunction::SetNumberOfFuncPar().

Bool_t TGo4FitParsList::RemovePar ( TGo4FitParameter * par )

Remove parameter from list.

If parameter owned by list, parameter will be destroyed. Return kTRUE if succesfull.

Definition at line 250 of file TGo4FitParsList.cxx.

References fbCanRollbackPars, and fxPars.

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

Default print method.

Call print method for every parameter object in list.

Reimplemented from TGo4FitNamed.

Reimplemented in TGo4FitComponent, TGo4FitData, TGo4FitDataGraph, TGo4FitDataHistogram, TGo4FitDataProfile, TGo4FitDataRidge, TGo4FitLinearTrans, TGo4FitMatrixTrans, TGo4FitModel, TGo4FitModelFormula, TGo4FitModelFromData, TGo4FitModelFunction, TGo4FitModelGauss1, TGo4FitModelGauss2, TGo4FitModelGaussN, TGo4FitModelPolynom, TGo4Fitter, and TGo4FitterAbstract.

Definition at line 185 of file TGo4FitParsList.cxx.

References fxPars, GetPar(), NumPars(), and TGo4FitParameter::Print().

Referenced by TGo4FitterConfig::Print(), TGo4FitterAbstract::Print(), TGo4FitMatrixTrans::Print(), TGo4FitLinearTrans::Print(), and TGo4FitComponent::Print().

void TGo4FitParsList::PrintPars ( ) const

Print only value and error of all parameters in list.

Definition at line 194 of file TGo4FitParsList.cxx.

References TGo4FitParameter::GetError(), GetPar(), GetParFullName(), TGo4FitParameter::GetValue(), and NumPars().

Referenced by TGo4Fitter::Print().

void TGo4FitParsList::CollectParsTo ( TGo4FitParsList & list ) [virtual]

Add all parameters to provided TGo4FitParsList object.

User should take care, that both source and destination have not ownership flag at same time, otherwise it can cause error during these lists destroyment.

Reimplemented in TGo4FitComponent.

Definition at line 259 of file TGo4FitParsList.cxx.

References AddPar(), Get(), GetParIndex(), and NumPars().

Referenced by TGo4FitterAbstract::CollectAllPars(), and TGo4FitComponent::CollectParsTo().

void TGo4FitParsList::ClearPars ( )

Remove all parameters from list.

If parameters owned by list, they will be destroyed.

Definition at line 271 of file TGo4FitParsList.cxx.

References fbCanRollbackPars, and fxPars.

Referenced by TGo4FitterAbstract::CollectAllPars(), and TGo4FitMatrixTrans::SetNumAxis().

TGo4FitParameter * TGo4FitParsList::AddPar ( TGo4FitParameter * par ) [protected]