Detailed Description

Fit of E-DE functional.

Created by KVClassFactory on Mon Apr 21 09:26:24 2008 Author: franklan

Author: Laurent TASSAN-GOT 17/03/2001

This class interfaces the Fortran package written by Laurent Tassan-Got to fit KVIDGrid objects using his functionals (see Nucl.Instrum.Meth. B194 (2002) 503-512). The following is the documentation from Laurent's code.


                       Automatic fit *


  globede  : user-friendly routine in which only the data have to be supplied.
             The routine estimates good initial values, reasonnable limits,
             automatically from the data and manages the whole fit procedure

      call globede(npts,zd,ad,xd,yd,ixt,ih,par,istate,irc)

 INPUT :
   npts : [I] number of data points really used in zd, ad, xd, yd
    zd  : [R] array of Z's (npts values)
    ad  : [R] array of A's (npts values)
    xd  : [R] array of E's (npts values)
    yd  : [R] array of DE's (npts values)
   ixt  : [I] =0->basic functional       <>0->extended functional
         For the basic formula :
         yy = ((g*E)**(mu+1)+lambda**(mu+1)*Z**2*A**mu)**(1/(mu+1))-g*E + pdy
         For the extended formula :
         yy = ((g*E)**(mu+nu+1)+(lambda*Z**alpha*A**beta)**(mu+nu+1)+
                  xi*Z**2*A**mu*(g*E)**nu)**(1/(mu+nu+1))-g*E + pdy

          If ih=0  no non-linear light response : E=xx-pdx
          If ih<>0 non-linear light response included :
           E = sqrt(h**2+2*rho*h*(1+log(1+h/rho)))
          rho=eta*Z**2*A    and   h=xx-pdx
    ih  : [I]  =0->no non-linear light response
              <>0->non-linear light response included
 OUTPUT :
    par : [R] array of parameters resulting from the fit, according to the
              ixt, ih combination the numbers and orders of parameters are :
              ixt=0  ih=0   5 parameters: lambda, mu, g, pdx, pdy
              ixt=0  ih<>0  6 parameters: lambda, mu, g, pdx, pdy, eta
              ixt<>0 ih=0   9 parameters: lambda, alpha, beta, mu, nu,
                                         xi, g, pdx, pdy
              ixt<>0 ih<>0 10 parameters: lambda, alpha, beta, mu, nu,
                                         xi, g, pdx, pdy, eta
  istate : [I] array of status of parameters
                 =0 -> free parameter
                 =1 -> parameter constrained by the lower limit
                 =2 -> parameter constrained by the upper limit
                 =3 -> constant parameter (bl(i)=bu(i)=par(i))
    irc  : [I] return code of the fit :
              0 -> convergence reached
              1 -> convergence reached, but not well marked minimum
              2 -> too many iterations, convergence not reached
             -1 -> no identification line with at least 2 points
             -2 -> too few data points
             -3 -> addressing problem between Fortran and C

Definition at line 81 of file KVTGIDFitter.h.

#include <KVTGIDFitter.h>

Inheritance diagram for KVTGIDFitter:

[legend]

Public Member Functions
	KVTGIDFitter ()
	Default constructor. More...

virtual	~KVTGIDFitter ()
	Destructor. More...

virtual void	Fit (KVIDGraph *)

void	FitPanel (Int_t functional_type=1, Bool_t with_csi_light_energy=kTRUE, Int_t first_Z=-1, Int_t last_Z=-1, Double_t xmin=0.0, Double_t xmax=0.0)

Int_t	GetFitStatus () const

const Char_t *	GetFitStatusString () const
	String with meaning of fit status codes (see GetFitStatus) More...

Int_t	GetFunctionalType () const

Int_t	GetLight () const

Float_t *	GetParameters () const

Int_t *	GetStatusOfParameters () const

KVTGID *	GetTGID () const

void	SetFunctionalType (Int_t t)

void	SetLight (Int_t ih)

Public Member Functions inherited from KVVirtualIDFitter
	KVVirtualIDFitter ()
	Default constructor. More...

virtual	~KVVirtualIDFitter ()
	Destructor. More...

KVIDGraph *	GetGrid () const

TVirtualPad *	GetPad () const

void	SetGrid (KVIDGraph *g)

void	SetPad (TVirtualPad *p)

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor. More...

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type. More...

	KVBase (const KVBase &)
	copy ctor More...

virtual	~ KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label. More...

virtual void	Copy (TObject &) const
	Make a copy of this object. More...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator More...

virtual void	Print (Option_t *option="") const

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Private Member Functions
void	MakeTGID ()
	Make a KVTGID out of fit result, if fit converged (irc<2) More...

Private Attributes
Float_t *	ad
	array of A's More...

Int_t	fLight
	handles CsI total light-energy conversion More...

Float_t *	fPar
	array of fit parameters More...

KVTGID *	fTGID
	KVTGID object representing fit result. More...

Int_t	fType
	type of functional More...

Double_t	fXmax
	limit for fit More...

Double_t	fXmin
	limit for fit More...

Int_t	fZorA
	is grid for Z&A or only Z identification ? More...

Int_t	irc
	status code More...

Int_t *	istate
	status of parameters More...

Float_t *	xd
	array of X coordinates More...

Float_t *	yd
	array of Y coordinates More...

Float_t *	zd
	array of Z's More...

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Static Public Member Functions inherited from KVVirtualIDFitter
static KVVirtualIDFitter *	GetDefaultFitter ()

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values. More...

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date. More...

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build. More...

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time. More...

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build. More...

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build. More...

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string. More...

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources. More...

static const Char_t *	gitCommit ()
	Returns last git commit of sources. More...

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc. More...

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Constructor & Destructor Documentation

◆ KVTGIDFitter()

KVTGIDFitter::KVTGIDFitter ( )

Default constructor.

Definition at line 25 of file KVTGIDFitter.cpp.

◆ ~KVTGIDFitter()

KVTGIDFitter::~KVTGIDFitter ( )

virtual

Destructor.

Definition at line 43 of file KVTGIDFitter.cpp.

Member Function Documentation

◆ Fit()

void KVTGIDFitter::Fit ( KVIDGraph * theGrid )

virtual

Fit the grid using the functional chosen with SetType and SetLight. Status of fit after this call can be retrieved with GetFitStatus(). must inherit from KVIDZAGrid!

Implements KVVirtualIDFitter.

Definition at line 63 of file KVTGIDFitter.cpp.

◆ FitPanel()

void KVTGIDFitter::FitPanel	(	Int_t	functional_type = `1`,
		Bool_t	with_csi_light_energy = `kTRUE`,
		Int_t	first_Z = `-1`,
		Int_t	last_Z = `-1`,
		Double_t	xmin = `0.0`,
		Double_t	xmax = `0.0`
	)

GUI method used to fit grid previously set with SetGrid(KVIDGraph*). functional_type = 0 (standard) or 1 (extended functional) with_csi_light_energy = kTRUE (with) or kFALSE (without CsI light-energy relation for 'X') first_Z, last_Z: set minimum & maximum Z for which fit is valid in KVTGID object resulting from fit. (default: -1, take first and last Z of grid) xmin, xmax: only fit points with abscissa between limits [xmin,xmax] (default: use all points regardless of abscissa)

Definition at line 250 of file KVTGIDFitter.cpp.

◆ GetFitStatus()

Int_t KVTGIDFitter::GetFitStatus ( ) const

Return status code of last fit. 0 -> convergence reached 1 -> convergence reached, but not well marked minimum 2 -> too many iterations, convergence not reached -1 -> no identification line with at least 2 points -2 -> too few data points -3 -> addressing problem between Fortran and C

Definition at line 159 of file KVTGIDFitter.cpp.

◆ GetFitStatusString()

const Char_t * KVTGIDFitter::GetFitStatusString ( ) const

String with meaning of fit status codes (see GetFitStatus)

Definition at line 176 of file KVTGIDFitter.cpp.

◆ GetFunctionalType()

Int_t KVTGIDFitter::GetFunctionalType ( ) const

inline

Definition at line 119 of file KVTGIDFitter.h.

◆ GetLight()

Int_t KVTGIDFitter::GetLight ( ) const

inline

Definition at line 133 of file KVTGIDFitter.h.

◆ GetParameters()

Float_t* KVTGIDFitter::GetParameters ( ) const

inline

Definition at line 140 of file KVTGIDFitter.h.

◆ GetStatusOfParameters()

Int_t * KVTGIDFitter::GetStatusOfParameters ( ) const

Returns array containing status of each parameter: =0 -> free parameter =1 -> parameter constrained by the lower limit =2 -> parameter constrained by the upper limit =3 -> constant parameter (bl(i)=bu(i)=par(i))

Definition at line 202 of file KVTGIDFitter.cpp.

◆ GetTGID()

KVTGID* KVTGIDFitter::GetTGID ( ) const

inline

Definition at line 146 of file KVTGIDFitter.h.

◆ MakeTGID()

void KVTGIDFitter::MakeTGID ( )

private

Make a KVTGID out of fit result, if fit converged (irc<2)

Definition at line 219 of file KVTGIDFitter.cpp.

◆ SetFunctionalType()

void KVTGIDFitter::SetFunctionalType ( Int_t t )

inline

Set type of functional to use: t=0->basic functional t<>0->extended functional

For the basic formula : yy = ((g*E)**(mu+1)+lambda**(mu+1)*Z**2*A**mu)**(1/(mu+1))-g*E + pdy
For the extended formula : yy = ((g*E)**(mu+nu+1)+(lambda*Z**alpha*A**beta)**(mu+nu+1)+ xi*A**mu*(g*E)**nu)**(1/(mu+mu+1))-g*E + pdy

Definition at line 108 of file KVTGIDFitter.h.

◆ SetLight()

void KVTGIDFitter::SetLight ( Int_t ih )

inline

Set whether to calculate non-linear light response or not (if X-coordinate is CsI total light response).

If ih=0 no non-linear light response : E=xx-pdx
If ih<>0 non-linear light response included : E = sqrt(h**2+2*rho*h*(1+log(1+h/rho))) rho=eta*Z**2*A and h=xx-pdx

Definition at line 123 of file KVTGIDFitter.h.

Member Data Documentation

◆ ad

Float_t* KVTGIDFitter::ad

private

array of A's

Definition at line 88 of file KVTGIDFitter.h.

◆ fLight

Int_t KVTGIDFitter::fLight

private

handles CsI total light-energy conversion

Definition at line 84 of file KVTGIDFitter.h.

◆ fPar

Float_t* KVTGIDFitter::fPar

private

array of fit parameters

Definition at line 86 of file KVTGIDFitter.h.

◆ fTGID

KVTGID* KVTGIDFitter::fTGID

private

KVTGID object representing fit result.

Definition at line 93 of file KVTGIDFitter.h.

◆ fType

Int_t KVTGIDFitter::fType

private

type of functional

Definition at line 83 of file KVTGIDFitter.h.

◆ fXmax

Double_t KVTGIDFitter::fXmax

private

limit for fit

Definition at line 95 of file KVTGIDFitter.h.

◆ fXmin

Double_t KVTGIDFitter::fXmin

private

limit for fit

Definition at line 94 of file KVTGIDFitter.h.

◆ fZorA

Int_t KVTGIDFitter::fZorA

private

is grid for Z&A or only Z identification ?

Definition at line 85 of file KVTGIDFitter.h.

◆ irc

Int_t KVTGIDFitter::irc

private

status code

Definition at line 91 of file KVTGIDFitter.h.

◆ istate

Int_t* KVTGIDFitter::istate

private

status of parameters

Definition at line 92 of file KVTGIDFitter.h.

◆ xd

Float_t* KVTGIDFitter::xd

private

array of X coordinates

Definition at line 89 of file KVTGIDFitter.h.

◆ yd

Float_t* KVTGIDFitter::yd

private

array of Y coordinates

Definition at line 90 of file KVTGIDFitter.h.

◆ zd

Float_t* KVTGIDFitter::zd

private

array of Z's

Definition at line 87 of file KVTGIDFitter.h.

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVTGIDFitter()

◆ ~KVTGIDFitter()

Member Function Documentation

◆ Fit()

◆ FitPanel()

◆ GetFitStatus()

◆ GetFitStatusString()

◆ GetFunctionalType()

◆ GetLight()

◆ GetParameters()

◆ GetStatusOfParameters()

◆ GetTGID()

◆ MakeTGID()

◆ SetFunctionalType()

◆ SetLight()

Member Data Documentation

◆ ad

◆ fLight

◆ fPar

◆ fTGID

◆ fType

◆ fXmax

◆ fXmin

◆ fZorA

◆ irc

◆ istate

◆ xd

◆ yd

◆ zd