TGo4FitParameter Class Reference

Model and data objects parameter. More...

#include <TGo4FitParameter.h>

Inheritance diagram for TGo4FitParameter:


Public Member Functions
	TGo4FitParameter ()
	Default constructor.
	TGo4FitParameter (const char name, const char title, Double_t iValue)
	Create TGo4FitParameter object with given name, title and initial value.
	TGo4FitParameter (const char name, const char title, Double_t iValue, Double_t iRangeMin, Double_t iRangeMax)
	Create TGo4FitParameter object with given name, title, initial value and given range limits.
	TGo4FitParameter (const char name, const char title, Double_t iValue, Double_t iEpsilon)
	Create TGo4FitParameter object with given name, title, initial value and given epsilon.
	TGo4FitParameter (const char name, const char title, Double_t iValue, Double_t iRangeMin, Double_t iRangeMax, Double_t iEpsilon)
	Create TGo4FitParameter object with given name, title, initial value, given range and epsilon.
virtual	~TGo4FitParameter ()
	Destroy TGo4FitParameter object.
Double_t	GetValue () const
	Return parameter value.
void	SetValue (Double_t iValue)
	Set parameter value.
Double_t	GetError () const
	Get value of parameter error.
void	SetError (Double_t iError)
	Set value of parameter error.
Bool_t	GetFixed () const
	Return status, if parameter fixed or not.
void	SetFixed (Bool_t iFixed)
	Set status of parameter fixed or not.
void	SetBlocked ()
	Blocks parameter value.
void	ClearBlocked ()
	Release blocking of parameter.
Bool_t	GetEpsilon (Double_t &eps) const
	Return value of parameter epsilon.
void	SetEpsilon (Double_t iEpsilon)
	Return epsilon value of parameter.
void	SetEpsilonUse (Bool_t use)
	Set status, if epsilon value was specified or not.
void	ChangeEpsilon (Double_t iEpsilon)
	Change epsilon value.
void	ClearEpsilon ()
	Set status, what epsilon is not specified.
Bool_t	GetRange (Double_t &min, Double_t &max) const
	Return range left (minimum) and right (maximum) values.
void	SetRange (Double_t iRangeMin, Double_t iRangeMax)
	Set range minimum and maximum values.
void	SetRangeUse (Bool_t use)
	Change status, is range was specified or not.
void	ChangeRangeMin (Double_t iRangeMin)
	Change value of range minimum.
void	ChangeRangeMax (Double_t iRangeMax)
	Cahnge value of range maximum.
Double_t	GetRangeMin ()
	Return value of range minimum.
Double_t	GetRangeMax ()
	Return value of range maximum.
void	ClearRange ()
	Clear status, that range was psecified.
void	MemorizeValue ()
	Memorize value of parameter.
void	RememberValue ()
	Restore value, which was previosly memorized.
virtual void	Print (Option_t *option) const
	Print TGo4FitParameter object to standard output.
Protected Member Functions
void	Reset ()
Protected Attributes
Double_t	fdValue
Double_t	fdError
Bool_t	fbFixed
Bool_t	fbEpsilon
Double_t	fdEpsilon
Bool_t	fbRange
Double_t	fdRangeMin
Double_t	fdRangeMax
Private Attributes
Bool_t	fbBlocked
Double_t	fdRememberedValue

Detailed Description

Model and data objects parameter.

Has value, error, range and epsilon attributes. From TGo4FitNamed class obtains full name, which consist of owner name (name of data object or model component) and name of parameter like "Gauss1.Width".

Definition at line 24 of file TGo4FitParameter.h.

Constructor & Destructor Documentation

TGo4FitParameter::TGo4FitParameter ( )

Default constructor.

Definition at line 20 of file TGo4FitParameter.cxx.

References Reset().

TGo4FitParameter::TGo4FitParameter	(	const char *	name,
		const char *	title,
		Double_t	iValue
	)

Create TGo4FitParameter object with given name, title and initial value.

Definition at line 24 of file TGo4FitParameter.cxx.

References fdValue, and Reset().

TGo4FitParameter::TGo4FitParameter	(	const char *	name,
		const char *	title,
		Double_t	iValue,
		Double_t	iRangeMin,
		Double_t	iRangeMax
	)

Create TGo4FitParameter object with given name, title, initial value and given range limits.

Definition at line 29 of file TGo4FitParameter.cxx.

References fdValue, Reset(), and SetRange().

TGo4FitParameter::TGo4FitParameter	(	const char *	name,
		const char *	title,
		Double_t	iValue,
		Double_t	iEpsilon
	)

Create TGo4FitParameter object with given name, title, initial value and given epsilon.

Definition at line 35 of file TGo4FitParameter.cxx.

References fdValue, Reset(), and SetEpsilon().

TGo4FitParameter::TGo4FitParameter	(	const char *	name,
		const char *	title,
		Double_t	iValue,
		Double_t	iRangeMin,
		Double_t	iRangeMax,
		Double_t	iEpsilon
	)

Create TGo4FitParameter object with given name, title, initial value, given range and epsilon.

Definition at line 41 of file TGo4FitParameter.cxx.

References fdValue, Reset(), SetEpsilon(), and SetRange().

TGo4FitParameter::~TGo4FitParameter ( ) [virtual]

Destroy TGo4FitParameter object.

Definition at line 57 of file TGo4FitParameter.cxx.

Member Function Documentation

Double_t TGo4FitParameter::GetValue ( ) const [inline]

Return parameter value.

Definition at line 60 of file TGo4FitParameter.h.

References fdValue.

Referenced by TGo4FitModelGauss2::BeforeEval(), TGo4FitModelGauss1::BeforeEval(), TGo4FitterAbstract::CopyParsValuesFrom(), TGo4FitComponent::GetAmplValue(), TGo4FitLinearTrans::GetCoefB(), TGo4FitLinearTrans::GetCoefK(), TGo4FitParsList::GetParsValues(), TGo4FitParsList::GetParValue(), TGo4FitModelPolynom::GetPolynomOrder(), TGo4FitModel::GetPosition(), TGo4FitModel::GetWidth(), TGo4FitModelGauss1::Integral(), TGo4FitParsList::PrintPars(), TGo4FitAssignment::RatioValue(), and TGo4FitModel::RebuildShape().

void TGo4FitParameter::SetValue ( Double_t iValue ) [inline]

Set parameter value.

Definition at line 65 of file TGo4FitParameter.h.

References fdValue.

Referenced by TGo4FitterAbstract::CopyParsValuesFrom(), TGo4FitComponent::SetAmplValue(), TGo4FitLinearTrans::SetCoef(), TGo4FitLinearTrans::SetCoefB(), TGo4FitLinearTrans::SetCoefK(), TGo4FitParsList::SetParsValues(), TGo4FitParsList::SetParValue(), TGo4FitModel::SetPosition(), and TGo4FitModel::SetWidth().

Double_t TGo4FitParameter::GetError ( ) const [inline]

Get value of parameter error.

Definition at line 70 of file TGo4FitParameter.h.

References fdError.

Referenced by TGo4FitComponent::GetAmplError(), TGo4FitParsList::GetParError(), and TGo4FitParsList::PrintPars().

void TGo4FitParameter::SetError ( Double_t iError ) [inline]

Set value of parameter error.

Definition at line 75 of file TGo4FitParameter.h.

References fdError.

Referenced by TGo4FitComponent::SetAmplError(), and TGo4FitParsList::SetParError().

Bool_t TGo4FitParameter::GetFixed ( ) const [inline]

Return status, if parameter fixed or not.

Definition at line 80 of file TGo4FitParameter.h.

References fbBlocked, and fbFixed.

Referenced by TGo4FitParsList::GetParFixed(), and Print().

void TGo4FitParameter::SetFixed ( Bool_t iFixed ) [inline]

Set status of parameter fixed or not.

Definition at line 85 of file TGo4FitParameter.h.

References fbFixed.

Referenced by TGo4FitModel::AssignToData(), TGo4FitComponent::MakeAmpl(), TGo4FitComponent::NewAmplitude(), TGo4FitComponent::NewParameter(), TGo4FitterConfig::SetParFixed(), TGo4FitParsList::SetParFixed(), and TGo4FitLinearTrans::TGo4FitLinearTrans().

void TGo4FitParameter::SetBlocked ( ) [inline]

Blocks parameter value.

This means, that parameter can not be changed during minimization routine. If parameter block, GetFixed() method returns kTRUE value. This method is used by fitter, when parameter not fixed, but for it dependency calculation is created. Thus, it can not be changed directly by minimization routine, but changing by fitter itself.

Definition at line 92 of file TGo4FitParameter.h.

References fbBlocked.

Referenced by TGo4FitterAbstract::InitializeDependencies().

void TGo4FitParameter::ClearBlocked ( ) [inline]

Release blocking of parameter.

Definition at line 97 of file TGo4FitParameter.h.

References fbBlocked.

Referenced by TGo4FitParsList::ClearParsBlocking().

Bool_t TGo4FitParameter::GetEpsilon ( Double_t & eps ) const [inline]

Return value of parameter epsilon.

If epsilon was not specified (by default), return kFALSE. Epsilon means minimum step of parameter value, which can be used during minimization process.

Definition at line 104 of file TGo4FitParameter.h.

References fbEpsilon, and fdEpsilon.

Referenced by TGo4FitParsList::GetParEpsilon().

void TGo4FitParameter::SetEpsilon ( Double_t iEpsilon ) [inline]

Return epsilon value of parameter.

Definition at line 109 of file TGo4FitParameter.h.

References fbEpsilon, and fdEpsilon.

Referenced by TGo4FitterConfig::SetParEpsilon(), TGo4FitParsList::SetParEpsilon(), and TGo4FitParameter().

void TGo4FitParameter::SetEpsilonUse ( Bool_t use ) [inline]

Set status, if epsilon value was specified or not.

Did not change epsilon value itself. Designed for usage in GUI.

Definition at line 115 of file TGo4FitParameter.h.

References fbEpsilon.

void TGo4FitParameter::ChangeEpsilon ( Double_t iEpsilon ) [inline]

Change epsilon value.

This is not affect on status of epsilon - if epsilon was not specified before, GetEpsilon() method still return kFALSE. Method should not used in normal program. Designed for usage in GUI.

Definition at line 121 of file TGo4FitParameter.h.

References fdEpsilon.

void TGo4FitParameter::ClearEpsilon ( ) [inline]

Set status, what epsilon is not specified.

Not affect on epsilon value, therefore after SetEpsilonUse(kTRUE) GetEpsilon() method return old epsilon value.

Definition at line 127 of file TGo4FitParameter.h.

References fbEpsilon.