Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

TGo4FitParameter Class Reference

Model and data objects parameter. More...

#include <TGo4FitParameter.h>

Inheritance diagram for TGo4FitParameter:

TGo4FitNamed List of all members.

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 26 of file TGo4FitParameter.h.

Constructor & Destructor Documentation

TGo4FitParameter::TGo4FitParameter (   ) 
 

Default constructor.

Definition at line 22 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 26 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 31 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 37 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 43 of file TGo4FitParameter.cxx.

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

TGo4FitParameter::~TGo4FitParameter (   )  [virtual]
 

Destroy TGo4FitParameter object.

Definition at line 59 of file TGo4FitParameter.cxx.

Member Function Documentation

Double_t TGo4FitParameter::GetValue (   )  const [inline]
 

Return parameter value.

Definition at line 62 of file TGo4FitParameter.h.

References fdValue.

Referenced by TGo4FitterAbstract::CopyParsValuesFrom(), TGo4FitParsList::GetParValue(), TGo4FitModelPolynom::GetPolynomOrder(), and TGo4FitAssignment::RatioValue().

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

Set parameter value.

Definition at line 67 of file TGo4FitParameter.h.

References fdValue.

Referenced by TGo4FitterAbstract::CopyParsValuesFrom(), and TGo4FitParsList::SetParValue().

Double_t TGo4FitParameter::GetError (   )  const [inline]
 

Get value of parameter error.

Definition at line 72 of file TGo4FitParameter.h.

References fdError.

Referenced by TGo4FitParsList::GetParError().

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

Set value of parameter error.

Definition at line 77 of file TGo4FitParameter.h.

References fdError.

Referenced by TGo4FitParsList::SetParError().

Bool_t TGo4FitParameter::GetFixed (   )  const [inline]
 

Return status, if parameter fixed or not.

Definition at line 82 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 87 of file TGo4FitParameter.h.

References fbFixed.

Referenced by TGo4FitModel::AssignToData(), 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 94 of file TGo4FitParameter.h.

References fbBlocked.

Referenced by TGo4FitterAbstract::InitializeDependencies().

void TGo4FitParameter::ClearBlocked (   )  [inline]
 

Release blocking of parameter.

Definition at line 99 of file TGo4FitParameter.h.

References fbBlocked.

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 106 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 111 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 117 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 123 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 129 of file TGo4FitParameter.h.

References fbEpsilon.

Bool_t TGo4FitParameter::GetRange (  Double_t &  min,
Double_t &  max
)  const [inline]
 

Return range left (minimum) and right (maximum) values.

If range was not specified before, return kFALSE.

Definition at line 135 of file TGo4FitParameter.h.

References fbRange, fdRangeMax, and fdRangeMin.

Referenced by TGo4FitParsList::GetParRange().

void TGo4FitParameter::SetRange (  Double_t  iRangeMin,
Double_t  iRangeMax
) 
 

Set range minimum and maximum values.

Definition at line 50 of file TGo4FitParameter.cxx.

References fbFixed, fbRange, fdRangeMax, fdRangeMin, and fdValue.

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

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

Change status, is range was specified or not.

Not change range values themself. Designed for usage in GUI.

Definition at line 146 of file TGo4FitParameter.h.

References fbRange.

void TGo4FitParameter::ChangeRangeMin (  Double_t  iRangeMin  )  [inline]
 

Change value of range minimum.

Definition at line 151 of file TGo4FitParameter.h.

References fbRange, and fdRangeMin.

void TGo4FitParameter::ChangeRangeMax (  Double_t  iRangeMax  )  [inline]
 

Cahnge value of range maximum.

Definition at line 156 of file TGo4FitParameter.h.

References fbRange, and fdRangeMax.

Double_t TGo4FitParameter::GetRangeMin (   )  [inline]
 

Return value of range minimum.

Definition at line 161 of file TGo4FitParameter.h.

References fdRangeMin.

Double_t TGo4FitParameter::GetRangeMax (   )  [inline]
 

Return value of range maximum.

Definition at line 166 of file TGo4FitParameter.h.

References fdRangeMax.

void TGo4FitParameter::ClearRange (   )  [inline]
 

Clear status, that range was psecified.

Equivalent to SetRangeUse(kFALSE).

Definition at line 172 of file TGo4FitParameter.h.

References fbRange, fdRangeMax, and fdRangeMin.

void TGo4FitParameter::MemorizeValue (   )  [inline]
 

Memorize value of parameter.

Definition at line 177 of file TGo4FitParameter.h.

References fdRememberedValue, and fdValue.

void TGo4FitParameter::RememberValue (   )  [inline]
 

Restore value, which was previosly memorized.

Definition at line 182 of file TGo4FitParameter.h.

References fdRememberedValue, and fdValue.

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

Print TGo4FitParameter object to standard output.

Reimplemented from TGo4FitNamed.

Definition at line 62 of file TGo4FitParameter.cxx.

References fbEpsilon, fbRange, fdEpsilon, fdError, fdRangeMax, fdRangeMin, fdValue, GetFixed(), and TGo4FitNamed::GetFullName().

void TGo4FitParameter::Reset (   )  [protected]
 

Definition at line 72 of file TGo4FitParameter.cxx.

References fbBlocked, fbFixed, fbRange, fdEpsilon, fdError, fdRangeMax, fdRangeMin, fdRememberedValue, and fdValue.

Referenced by TGo4FitParameter().

Member Data Documentation

Double_t TGo4FitParameter::fdValue [protected]
 

Definition at line 192 of file TGo4FitParameter.h.

Referenced by GetValue(), MemorizeValue(), Print(), RememberValue(), Reset(), SetRange(), SetValue(), and TGo4FitParameter().

Double_t TGo4FitParameter::fdError [protected]
 

Definition at line 193 of file TGo4FitParameter.h.

Referenced by GetError(), Print(), Reset(), and SetError().

Bool_t TGo4FitParameter::fbFixed [protected]
 

Definition at line 194 of file TGo4FitParameter.h.

Referenced by GetFixed(), Reset(), SetFixed(), and SetRange().

Bool_t TGo4FitParameter::fbEpsilon [protected]
 

Definition at line 196 of file TGo4FitParameter.h.

Referenced by ClearEpsilon(), GetEpsilon(), Print(), SetEpsilon(), and SetEpsilonUse().

Double_t TGo4FitParameter::fdEpsilon [protected]
 

Definition at line 197 of file TGo4FitParameter.h.

Referenced by ChangeEpsilon(), GetEpsilon(), Print(), Reset(), and SetEpsilon().

Bool_t TGo4FitParameter::fbRange [protected]
 

Definition at line 199 of file TGo4FitParameter.h.

Referenced by ChangeRangeMax(), ChangeRangeMin(), ClearRange(), GetRange(), Print(), Reset(), SetRange(), and SetRangeUse().

Double_t TGo4FitParameter::fdRangeMin [protected]
 

Definition at line 200 of file TGo4FitParameter.h.

Referenced by ChangeRangeMin(), ClearRange(), GetRange(), GetRangeMin(), Print(), Reset(), and SetRange().

Double_t TGo4FitParameter::fdRangeMax [protected]
 

Definition at line 201 of file TGo4FitParameter.h.

Referenced by ChangeRangeMax(), ClearRange(), GetRange(), GetRangeMax(), Print(), Reset(), and SetRange().

Bool_t TGo4FitParameter::fbBlocked [private]
 

Definition at line 204 of file TGo4FitParameter.h.

Referenced by ClearBlocked(), GetFixed(), Reset(), and SetBlocked().

Double_t TGo4FitParameter::fdRememberedValue [private]
 

Definition at line 205 of file TGo4FitParameter.h.

Referenced by MemorizeValue(), RememberValue(), and Reset().

The documentation for this class was generated from the following files:
Generated on Fri Nov 28 13:00:58 2008 for Go4-v3.04-1 by  doxygen 1.4.2