v2.10-0 (21000JUN2005)

Go4Fit
Class TGo4FitComponent

Direct Known Subclasses:
TGo4FitData, TGo4FitModel

class TGo4FitComponent
derived from TGo4FitParsList, TGo4FitSlotList

Basic absrtact class, combining common properties of data and model.


Field Summary
 private Bool_tfbUseBuffers
          Specify usage of buffers after initialization
 private Int_tfiAmplIndex
          Index of amplitude parameter (-1 if none)
 private TObjArrayfxCuts
          Array of TCutG objects, used for range selection.
 private TArrayIfxRangeAxis
          Array for range conditions storage (axis indexes)
 private TArrayDfxRangeValue
          Array for range values storaging.

Fields inherited from class TNamed
fName, fTitle

Fields inherited from class Go4Fit.TGo4FitSlotList
fbUpdateSlotList, fxSlotList

Constructor Summary
TGo4FitComponent()
          Default constructor.
TGo4FitComponent(const char * iName, const char * iTitle)
          Creates TGo4FitComponent object.

Destructor Summary
 virtual synchronized ~TGo4FitComponent()
          Destroys TGo4FitComponent object.

Method Summary
 voidAddRangeCondition(Int_t typ, Int_t naxis, Double_t left, Double_t right)
          Add new range condition.
 voidAddRangeCut(TCutG* cut, Bool_t exclude)
          Add TCutG object as range condition for two-dimensional case.
 virtual Bool_tCanAmplTouch()
          Signals, if amplitude parameter can be removed from or introduced to object.
 Bool_tCheckRangeConditions(const Double_t* values, Int_t numaxis)
          Check all range conditions for specified point.
 voidClearRanges(Int_t naxis)
          Clear all range conditions for given axis.
 virtual voidCollectParsTo(TGo4FitParsList& list)
          Collect all parameters to provided parameters list object.
 voidExcludeRange(Int_t naxis, Double_t min, Double_t max)
          Exclude axis range from consideration.
 Double_tGetAmplError()
          Return error of amplitude parameter.
 const const char *GetAmplFullName()
          Returns full name of amplitude parameter.
 protected Int_tGetAmplIndex()
          Returns index of amplitude parameter.
 const const char *GetAmplName()
          Returns name of amplitude parameter.
 TGo4FitParameter*GetAmplPar()
          Return ampltide parameter object.
 Double_tGetAmplValue()
          Return value of amplitude parameter.
 const Int_tGetNumRangeCondition()
          Returns number of range condition (exclude range cuts).
 const Int_tGetNumRangeCut()
          Returns number of range cuts, assigned to object.
 const voidGetRangeCondition(Int_t n, Int_t& typ, Int_t& naxis, Double_t& left, Double_t& right)
          Return value for specified range condition.

 const TCutG*GetRangeCut(Int_t n)
          Returns specified range cut.
 Bool_tGetRangeMax(Int_t naxis, Double_t& value)
          Defines maximum allowed value for given range.
 Bool_tGetRangeMin(Int_t naxis, Double_t& value)
          Defines minimum allowed value for given range.
 Bool_tGetUseBuffers()
          Returns flag of usage of additional buffers.
 Bool_tIsAnyRangeLimits()
          Return kTRUE, if any range conditions were introduced.
 Bool_tIsRangeCutExcluding(Int_t n)
          Return kTRUE if cut eclude range
 Bool_tMakeAmpl(Bool_t isFixed)
          Create amplitude parameter and adds it to parameters list.
 protected TGo4FitParameter*NewAmplitude(const char * Name, Double_t iValue, Bool_t IsFixed, Int_t AtIndx)
          Create amplitude parameter with specified properties.
 protected TGo4FitParameter*NewParameter(const char * Name, const char * Title, Double_t iValue, Bool_t Fixed, Int_t AtIndx)
          Create new parameter with provided properties and add to parameters list.
 virtual const voidPrint(Option_t* option)
          Print info about object on standard output.
 Bool_tRemoveAmpl()
          Remove amplitude parameter from parameters list.
 voidRemoveRangeCondition(Int_t n)
          Removes specified range condition.
 voidRemoveRangeCut(Int_t n)
          Delete range cut with specified index.
 voidSetAmplError(Double_t iError)
          Set error of amplitude parameter.
 protected voidSetAmplIndex(Int_t iAmplIndex)
          Set index of amplitude parameter.
 voidSetAmplValue(Double_t iAmpl)
          Set value of amplitude parameter.
 voidSetRange(Int_t naxis, Double_t min, Double_t max)
          Includes axis range in consideration.
 voidSetRangeCondition(Int_t n, Int_t typ, Int_t naxis, Double_t left, Double_t right)
          Change specified range condition.
 voidSetRangeCutExcluding(Int_t n, Bool_t exclude)
          Set type of range cut (excluding or including)
 voidSetRangeMax(Int_t naxis, Double_t value)
          Set maximum axis value, taken into consideration.
 voidSetRangeMin(Int_t naxis, Double_t value)
          Set minimum axis value, taken into consideration.
 voidSetUseBuffers(Bool_t iUse)
          Sets usage of additional buffers.

Methods inherited from class Go4Fit.TGo4FitParsList
AddPar, CanRollbackPars, ClearPars, ClearParsBlocking, CreatePar, Find, Find, Find, FindPar, FindPar, FindPar, Get, GetPar, GetParEpsilon, GetParError, GetParFixed, GetParFullName, GetParIndex, GetParName, GetParRange, GetParsValues, GetParValue, InsertPar, IsAllParsFixed, MemorizePars, NumFixedPars, NumFreePars, NumPars, 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=, Clear, 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, FillSlotList, FindSlot, GetSlot, GetSlotList, IsEmptySlots, IsObjectInSlots, NumSlots, PrepareSlotsForWriting, SetObject, SetObject, SetSaveFlagForObjects, SetUpdateSlotList

Field Detail

fbUseBuffers

private Bool_t fbUseBuffers
Specify usage of buffers after initialization

fiAmplIndex

private Int_t fiAmplIndex
Index of amplitude parameter (-1 if none)

fxCuts

private TObjArray fxCuts
Array of TCutG objects, used for range selection.

fxRangeAxis

private TArrayI fxRangeAxis
Array for range conditions storage (axis indexes)

fxRangeValue

private TArrayD fxRangeValue
Array for range values storaging.
Constructor Detail

TGo4FitComponent

public TGo4FitComponent()
Default constructor.

TGo4FitComponent

public TGo4FitComponent(const char * iName, const char * iTitle)
Creates TGo4FitComponent object.
Method Detail

~TGo4FitComponent

public virtual synchronized ~TGo4FitComponent()
Destroys TGo4FitComponent object.
Method Detail

AddRangeCondition

public void AddRangeCondition(Int_t typ, Int_t naxis, Double_t left, Double_t right)
Add new range condition.
For exact meaning of parameters see GetRangeCondition() method.

AddRangeCut

public void AddRangeCut(TCutG* cut, Bool_t exclude)
Add TCutG object as range condition for two-dimensional case.
Region, defined by TCutG object, can be included or excluded from consideration according value of exclude flag.

CanAmplTouch

public virtual Bool_t CanAmplTouch()
Signals, if amplitude parameter can be removed from or introduced to object.

CheckRangeConditions

public Bool_t CheckRangeConditions(const Double_t* values, Int_t numaxis)
Check all range conditions for specified point.

ClearRanges

public void ClearRanges(Int_t naxis)
Clear all range conditions for given axis.
If naxis=-1, all range conditions will be removed.

CollectParsTo

public virtual void CollectParsTo(TGo4FitParsList& list)
Collect all parameters to provided parameters list object.
Not only parameters of TGo4FitComponent copies to list.
All parameters, which are situated in incpsulated objects, also will be copied to this list.

ExcludeRange

public void ExcludeRange(Int_t naxis, Double_t min, Double_t max)
Exclude axis range from consideration.

GetAmplError

public Double_t GetAmplError()
Return error of amplitude parameter.
If none, return 0.

GetAmplFullName

public const const char * GetAmplFullName()
Returns full name of amplitude parameter.
If none, return 0.

GetAmplIndex

protected Int_t GetAmplIndex()
Returns index of amplitude parameter.

GetAmplName

public const const char * GetAmplName()
Returns name of amplitude parameter.
If none, return 0.

GetAmplPar

public TGo4FitParameter* GetAmplPar()
Return ampltide parameter object.
If amplitude not exists, return 0.

GetAmplValue

public Double_t GetAmplValue()
Return value of amplitude parameter.
If none, return 1.

GetNumRangeCondition

public const Int_t GetNumRangeCondition()
Returns number of range condition (exclude range cuts).

GetNumRangeCut

public const Int_t GetNumRangeCut()
Returns number of range cuts, assigned to object.

GetRangeCondition

public const void GetRangeCondition(Int_t n, Int_t& typ, Int_t& naxis, Double_t& left, Double_t& right)
Return value for specified range condition.

Following procedures produces correspondent values:
typ=0: SetRange()
typ=1: ExcludeRange()
typ=2: SetRangeMin() right not defined
typ=3: SetRangeMax() left not defined

GetRangeCut

public const TCutG* GetRangeCut(Int_t n)
Returns specified range cut.

GetRangeMax

public Bool_t GetRangeMax(Int_t naxis, Double_t& value)
Defines maximum allowed value for given range.
Returns kFALSE, if no range condition were specified for given axis.

GetRangeMin

public Bool_t GetRangeMin(Int_t naxis, Double_t& value)
Defines minimum allowed value for given range.
Returns kFALSE, if no range condition were specified for given axis.

GetUseBuffers

public Bool_t GetUseBuffers()
Returns flag of usage of additional buffers.
Buffers can only be created in Initialize procedure..

IsAnyRangeLimits

public Bool_t IsAnyRangeLimits()
Return kTRUE, if any range conditions were introduced.

IsRangeCutExcluding

public Bool_t IsRangeCutExcluding(Int_t n)
Return kTRUE if cut eclude range

MakeAmpl

public Bool_t MakeAmpl(Bool_t isFixed)
Create amplitude parameter and adds it to parameters list.
Typically amplitude is situated in the beggining of parameters list.

NewAmplitude

protected TGo4FitParameter* NewAmplitude(const char * Name, Double_t iValue, Bool_t IsFixed, Int_t AtIndx)
Create amplitude parameter with specified properties.

NewParameter

protected TGo4FitParameter* NewParameter(const char * Name, const char * Title, Double_t iValue, Bool_t Fixed, Int_t AtIndx)
Create new parameter with provided properties and add to parameters list.

Print

public virtual const void Print(Option_t* option)
Print info about object on standard output.

RemoveAmpl

public Bool_t RemoveAmpl()
Remove amplitude parameter from parameters list.

RemoveRangeCondition

public void RemoveRangeCondition(Int_t n)
Removes specified range condition.

RemoveRangeCut

public void RemoveRangeCut(Int_t n)
Delete range cut with specified index.

SetAmplError

public void SetAmplError(Double_t iError)
Set error of amplitude parameter.

SetAmplIndex

protected void SetAmplIndex(Int_t iAmplIndex)
Set index of amplitude parameter.

SetAmplValue

public void SetAmplValue(Double_t iAmpl)
Set value of amplitude parameter.

SetRange

public void SetRange(Int_t naxis, Double_t min, Double_t max)
Includes axis range in consideration.
Number of axis and minium and maximum values should be specified.

SetRangeCondition

public void SetRangeCondition(Int_t n, Int_t typ, Int_t naxis, Double_t left, Double_t right)
Change specified range condition.
Range condition should already exists before calling of these procedure.
For exact meaning of parameters see GetRangeCondition() method.

SetRangeCutExcluding

public void SetRangeCutExcluding(Int_t n, Bool_t exclude)
Set type of range cut (excluding or including)

SetRangeMax

public void SetRangeMax(Int_t naxis, Double_t value)
Set maximum axis value, taken into consideration.
All lager values will be removed from consideration independently from other range conditions.

SetRangeMin

public void SetRangeMin(Int_t naxis, Double_t value)
Set minimum axis value, taken into consideration.
All smaller values will be removed from consideration independently from other range conditions.

SetUseBuffers

public void SetUseBuffers(Bool_t iUse)
Sets usage of additional buffers.
Buffers can only be created in Initialize procedure..

Association Links

to Class TArrayI

Array for range conditions storage (axis indexes)

to Class TArrayD

Array for range values storaging.

to Class TObjArray

Array of TCutG objects, used for range selection.

J.Adamczewski, M.Al-Turany, D.Bertini, H.G.Essel, S.Linev

30-06-2005