Abstract base class for global variables which calculate a mean value.

This class is a base class for the management of global variables with a mean value and a standard deviation.

A call to the GetValue() method returns the mean value of the variable.

Other values can be retrieved by index or by name. The correspondance between indexes and names is as follows:

Name	Index	Meaning
Mean	0	Mean value of var = SumVar/SumOfWeights
RMS	1	Standard deviation of var = sqrt(SumVarSquared/SumOfWeights-Mean*Mean)
SumVar	2	Sum of weighted var values
SumVarSquared	3	Sum of weighted squared var values
SumOfWeights	4	Sum of weights
Min	5	Minimum value
Max	6	Maximum value

By default, only Mean and RMS branches are added to TTrees (see KVGVList::MakeBranches).

Author: D. Cussol (LPC Caen), J.D. Frankland (GANIL)

Date: 2004-2020

Definition at line 34 of file KVVarGlobMean.h.

Public Member Functions
	KVVarGlobMean ()

	KVVarGlobMean (const Char_t *nom)

virtual	~KVVarGlobMean ()

void	Calculate ()

void	Copy (TObject &obj) const
	Copy this to a. More...

void	Init ()

void	Reset ()

Public Member Functions inherited from KVVarGlob
	KVVarGlob ()

	KVVarGlob (const Char_t *nom)

virtual	~KVVarGlob (void)

void	AddSelection (const KVParticleCondition &sel)

Double_t	AsDouble () const

void	DefineNewFrame (KVEvent *e) const

void	Fill (const KVNucleus *c)

void	Fill2 (const KVNucleus n1, const KVNucleus n2)

virtual void	FillN (const KVEvent *)

const TString &	GetFrame () const

Int_t	GetNameIndex (const Char_t *name) const

Double_t	GetNormalization () const

Int_t	GetNumberOfBranches () const

virtual Int_t	GetNumberOfValues () const

TString	GetOptionString (const Char_t *opt) const

Double_t	GetParameter (const Char_t *par) const

Double_t	GetValue (const Char_t *name) const

Double_t	GetValue (Int_t i) const

Double_t	GetValue (void) const

virtual TString	GetValueName (Int_t i) const

virtual Char_t	GetValueType (Int_t) const

virtual std::vector< Double_t >	GetValueVector (void) const

virtual Bool_t	IsGlobalVariable () const

Bool_t	IsNBody () const

Bool_t	IsOneBody () const

Bool_t	IsOptionGiven (const Char_t *opt)

Bool_t	IsParameterSet (const Char_t *par)

Bool_t	IsTwoBody () const

void	ListInit ()

	operator double () const

Double_t	operator() (const Char_t *name) const

Double_t	operator() (Int_t i) const

Double_t	operator() (void) const

void	Print (Option_t *="") const

void	SetEventSelection (const EventSelector &f)

void	SetFrame (const Char_t *ref)

void	SetMaxNumBranches (Int_t n)

void	SetNewFrameDefinition (const FrameSetter &f)

void	SetNormalization (Double_t norm)

void	SetOption (const Char_t option, const Char_t value)

void	SetParameter (const Char_t *par, Double_t value)

void	SetSelection (const KVParticleCondition &sel)

bool	TestEventSelection () const

void	UnsetOption (const Char_t *opt)

void	UnsetParameter (const Char_t *par)

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...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

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...

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)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()

virtual TObject *	Clone (const char *newname="") const

virtual Int_t	Compare (const TObject *obj) const

virtual void	FillBuffer (char *&buffer)

virtual const char *	GetName () const

virtual const char *	GetTitle () const

virtual ULong_t	Hash () const

virtual Bool_t	IsSortable () const

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

TNamed &	operator= (const TNamed &rhs)

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	Dump () const

virtual void	Error (const char method, const char msgfmt,...) const

virtual void	Execute (const char method, const char params, Int_t *error=0)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

virtual void	Fatal (const char method, const char msgfmt,...) const

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

virtual void	Info (const char method, const char msgfmt,...) const

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const

void	operator delete (void *ptr)

void	operator delete[] (void *ptr)

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

virtual void	SysError (const char method, const char msgfmt,...) const

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

virtual void	Warning (const char method, const char msgfmt,...) const

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const

Static Public Member Functions
static void	MakeClass (const Char_t classname, const Char_t classdesc, int type=KVVarGlob::kOneBody)

Static Public Member Functions inherited from KVVarGlob
static void	MakeClass (const Char_t classname, const Char_t classdesc, int type=kOneBody)

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 date. 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, 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 ()

Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Protected Member Functions
void	FillVar (Double_t v, Double_t w=1.)

virtual Double_t	getvalue_int (Int_t i) const

Protected Member Functions inherited from KVVarGlob
void	ClearNameIndex ()

virtual void	fill (const KVNucleus *)

virtual void	fill2 (const KVNucleus , const KVNucleus )

int	GetIndexAtListPosition (int pos) const

TString	GetNameAtListPosition (int pos) const

KVNameValueList &	GetParameters ()

const KVNameValueList &	GetParameters () const

virtual Double_t	getvalue_char (const Char_t *name) const

virtual Double_t	getvalue_void () const

void	SetNameIndex (const Char_t *name, Int_t index)

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Static Protected Member Functions
static void	FillMethodBody (KVString &body, int type)

Static Protected Member Functions inherited from KVVarGlob
static void	AddFillMethod (KVClassFactory &cf, int type)

static void	AddFillMethodBody (KVClassFactory &cf, KVString &body, int type)

static void	AddInitMethod (KVClassFactory &cf, KVString &body)

static void	FillMethodBody (KVString &body, int type)

static void	ImplementInitMethod (KVClassFactory &cf, KVString &body, int type)

Private Member Functions
void	init ()

Private Attributes
Int_t	calc

Double_t	ect

Double_t	max

Double_t	min

Double_t	svar

Double_t	svar2

Double_t	sw

Double_t	var

Additional Inherited Members
Public Types inherited from KVVarGlob
enum	{ kOneBody , kTwoBody , kNBody }

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

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

Protected Attributes inherited from KVVarGlob
Int_t	fType
	type of variable global; = kOneBody, kTwoBody or kNBody More...

Char_t	fValueType
	type (='I' integer or 'D' double) of global variable value More...

Protected Attributes inherited from KVBase
TString	fLabel
	label for the object More...

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

#include <KVVarGlobMean.h>

Inheritance diagram for KVVarGlobMean:

[legend]

Constructor & Destructor Documentation

◆ KVVarGlobMean() [1/2]

KVVarGlobMean::KVVarGlobMean ( )

inline

Definition at line 54 of file KVVarGlobMean.h.

◆ KVVarGlobMean() [2/2]

KVVarGlobMean::KVVarGlobMean ( const Char_t * nom )

inline

Definition at line 58 of file KVVarGlobMean.h.

◆ ~KVVarGlobMean()

virtual KVVarGlobMean::~KVVarGlobMean ( )

inlinevirtual

Definition at line 64 of file KVVarGlobMean.h.

Member Function Documentation

◆ Calculate()

void KVVarGlobMean::Calculate ( void )

virtual

Implements KVVarGlob.

Definition at line 41 of file KVVarGlobMean.cpp.

◆ Copy()

void KVVarGlobMean::Copy ( TObject & obj ) const

virtual

Copy this to a.

Reimplemented from KVVarGlob.

Definition at line 66 of file KVVarGlobMean.cpp.

◆ FillMethodBody()

void KVVarGlobMean::FillMethodBody	(	KVString &	body,
		int	type
	)

staticprotected

PRIVATE method used by MakeClass. body of 'Fill', 'Fill2', or 'FillN' method

Definition at line 204 of file KVVarGlobMean.cpp.

◆ FillVar()

void KVVarGlobMean::FillVar	(	Double_t	v,
		Double_t	w = `1.`
	)

protected

Definition at line 27 of file KVVarGlobMean.cpp.

◆ getvalue_int()

Double_t KVVarGlobMean::getvalue_int ( Int_t i ) const

protectedvirtual

Implements KVVarGlob.

Reimplemented in KVVGSum.

Definition at line 110 of file KVVarGlobMean.cpp.

◆ init()

void KVVarGlobMean::init ( void )

private

Definition at line 10 of file KVVarGlobMean.cpp.

◆ Init()

void KVVarGlobMean::Init ( void )

virtual

Implements KVVarGlob.

Reimplemented in KVVGSum.

Definition at line 101 of file KVVarGlobMean.cpp.

◆ MakeClass()

void KVVarGlobMean::MakeClass	(	const Char_t *	classname,
		const Char_t *	classdesc,
		int	type = `KVVarGlob::kOneBody`
	)

static

Creates skeleton '.h' and '.cpp' files for a new global variable class which inherits from this class. Give a name for the new class and a short description which will be used to document the class.

By default the new class will be of type 1-body. A Fill(KVNucleus*) method will be generated which the user should complete. For a 2-body variable, call MakeClass with type = KVVarGlob::kTwoBody. A skeleton Fill2(KVNucleus*,KVNucleus*) method will be generated. For a N-body variable, call MakeClass with type = KVVarGlob::kNBody. A skeleton FillN(KVEvent*) method will be generated. basic class template

Definition at line 164 of file KVVarGlobMean.cpp.

◆ Reset()

void KVVarGlobMean::Reset ( void )

virtual

Implements KVVarGlob.

Definition at line 85 of file KVVarGlobMean.cpp.

Member Data Documentation

◆ calc

Int_t KVVarGlobMean::calc

private

Definition at line 43 of file KVVarGlobMean.h.

◆ ect

Double_t KVVarGlobMean::ect

private

Definition at line 37 of file KVVarGlobMean.h.

◆ max

Double_t KVVarGlobMean::max

private

Definition at line 42 of file KVVarGlobMean.h.

◆ min

Double_t KVVarGlobMean::min

private

Definition at line 41 of file KVVarGlobMean.h.

◆ svar

Double_t KVVarGlobMean::svar

private

Definition at line 39 of file KVVarGlobMean.h.

◆ svar2

Double_t KVVarGlobMean::svar2

private

Definition at line 38 of file KVVarGlobMean.h.

◆ sw

Double_t KVVarGlobMean::sw

private

Definition at line 40 of file KVVarGlobMean.h.

◆ var

Double_t KVVarGlobMean::var

private

Definition at line 36 of file KVVarGlobMean.h.

The documentation for this class was generated from the following files:

kaliveda.doxygen/KVMultiDet/globvars/KVVarGlobMean.h
kaliveda.doxygen/KVMultiDet/globvars/KVVarGlobMean.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVVarGlobMean() [1/2]

◆ KVVarGlobMean() [2/2]

◆ ~KVVarGlobMean()

Member Function Documentation

◆ Calculate()

◆ Copy()

◆ FillMethodBody()

◆ FillVar()

◆ getvalue_int()

◆ init()

◆ Init()

◆ MakeClass()

◆ Reset()

Member Data Documentation

◆ calc

◆ ect

◆ max

◆ min

◆ svar

◆ svar2

◆ sw

◆ var