Detailed Description

General global variable for calculating sums of various quantities.

Created by KVClassFactory on Thu Nov 16 10:42:38 2006 Author: franklan

Most global variables involve a sum of some kind, whether it be summing up the number of times that particles meets certain criteria (multiplicity), summing some property of particles such as transverse energy or charge, or calculating the mean value of such a property for all particles.

Therefore the actual act of summing up is always the same, the difference between one global variable and another is the quantity which is summed, and the information which is finally extracted from this sum.

A KVVGSum has three modes of operation: mult, sum, mean In the first, "mult", it is used to count the number of times that a selection condition is successfully met. In "sum" mode, it is used to sum a property of all particles which meet a given selection condition. In "mean" mode, it calculates the mean value of a property of all particles which meet a given selection condition.

SETTING THE MODE OF OPERATION

Assuming a pointer to a KVVGSum, KVVGSum* vgs:

vgs->SetOption("mode", "mult");
vgs->SetOption("mode", "sum");
vgs->SetOption("mode", "mean");

SETTING THE PROPERTY TO BE SUMMED

To set the property to be summed, you must give the name of the method to be called in order to obtain the desired quantity:

vgs->SetOption("method", "GetREtran");

vgs->SetOption("method", "GetZ");

If you need to give arguments for the method call, use option "args", e.g.:

vgs->SetOption("args", "3, \"string argument\", 0");

By default, the method used must be defined in class KVNucleus or one of its base classes. If you need to access methods in some derived class, use the "class" option:

vgs->SetOption("class", "MyOwnParticleClass");

SETTING THE PARTICLE SELECTION CRITERIA

Use a KVParticleCondition to set some selection criteria, then pass it as argument to base class method KVVVarGlob::SetSelection().

Example: calculate multiplicity of nuclei with Z<3

KVParticleCondition sel("_NUC_->GetZ()<3");
vgs->SetSelection(sel);
vgs->SetOption("mode", "mult");

Example: calculate mean transverse energy of IMF with CM parallel velocities between -1.5 and +1.5 cm/ns

KVParticleCondition imf("_NUC_->GetZ()>=3 && _NUC_->GetZ()<=20");
KVParticleCondition vpar("_NUC_->GetFrame(\"CM\")->GetVpar()>=-1.5 && _NUC_->GetFrame(\"CM\")->GetVpar()<=1.5");
KVParticleCondition sel = imf && vpar;
vgs->SetSelection(sel);
vgs->SetOption("mode", "mean");
vgs->SetOption("method", "GetEtran");

Definition at line 100 of file KVVGSum.h.

#include <KVVGSum.h>

Inheritance diagram for KVVGSum:

[legend]

Public Member Functions
void	fill (const KVNucleus *c)

virtual TString	GetValueName (Int_t i) const

void	Init ()

Public Member Functions inherited from KVVarGlobMean
	KVVarGlobMean ()

	KVVarGlobMean (const Char_t *nom)

virtual	~KVVarGlobMean ()

void	Calculate ()

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

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

const KVNameValueList &	GetValueNameList () const

virtual Char_t	GetValueType (Int_t) const

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

Bool_t	HasValue (const Char_t *name) const

bool	IsDefiningNewFrame () 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	IsSelectingEvents () const

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	SetDefineGroup (const KVString &groupname="")

void	SetEventSelection (const EventSelector &f)

void	SetFrame (const Char_t *ref)

void	SetMaxNumBranches (Int_t n)

void	SetNewFrameDefinition (const FrameSetter &f)

virtual 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

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

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 Types
enum	{ kMult = BIT(14) , kSum = BIT(15) , kMean = BIT(16) , kNoFrame = BIT(17) , kInitDone = BIT(18) }

Private Member Functions
Double_t	getvalue_char (const Char_t *name) const

Double_t	getvalue_int (Int_t index) const

void	init (void)

Private Attributes
TClass *	fClass
	class used to represent particles More...

std::unique_ptr< TMethodCall >	fMethod
	method used to extract property of interest from particles More...

Double_t	fVal
	used to retrieve value of property for each particle More...

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

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

Static Public Member Functions inherited from KVVarGlobMean
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 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 ()

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
kMult
kSum
kMean
kNoFrame
kInitDone

Definition at line 106 of file KVVGSum.h.

Member Function Documentation

◆ fill()

void KVVGSum::fill ( const KVNucleus * c )

virtual

Reimplemented from KVVarGlob.

Definition at line 34 of file KVVGSum.cpp.

◆ getvalue_char()

Double_t KVVGSum::getvalue_char ( const Char_t * name ) const

inlineprivatevirtual

Reimplemented from KVVarGlob.

Definition at line 127 of file KVVGSum.h.

◆ getvalue_int()

Double_t KVVGSum::getvalue_int ( Int_t index ) const

inlineprivatevirtual

Returns value based on position in name-index list, not the actual index:

i.e. mode = mult: getvalue_int(0) returns value of "Mult" (index:4)
i.e. mode = sum: getvalue_int(0) returns value of "Sum" (index:2)
i.e. mode = mean: getvalue_int(0) returns value of "Mean" (index:0), getvalue_int(1) returns value of "RMS" (index:1)

Reimplemented from KVVarGlobMean.

Definition at line 116 of file KVVGSum.h.

◆ GetValueName()

virtual TString KVVGSum::GetValueName ( Int_t i ) const

inlinevirtual

Returns name of value associated with index 'i':

i.e. mode = mult: GetValueName(0) returns "Mult"
i.e. mode = sum: GetValueName(0) returns "Sum"
i.e. mode = mean: GetValueName(0) returns "Mean", GetValueName(1) returns "RMS"

Reimplemented from KVVarGlob.

Definition at line 138 of file KVVGSum.h.

◆ Init()

void KVVGSum::Init ( void )

virtual

Must be called at least once before beginning calculation in order to set mode of operation, get pointer to method used to calculate variable, etc. etc.

Reimplemented from KVVarGlobMean.

Definition at line 52 of file KVVGSum.cpp.

◆ init()

void KVVGSum::init ( void )

private

Definition at line 21 of file KVVGSum.cpp.

Member Data Documentation

◆ fClass

TClass* KVVGSum::fClass

private

class used to represent particles

Definition at line 102 of file KVVGSum.h.

◆ fMethod

std::unique_ptr<TMethodCall> KVVGSum::fMethod

private

method used to extract property of interest from particles

Definition at line 103 of file KVVGSum.h.

◆ fVal

Double_t KVVGSum::fVal

private

used to retrieve value of property for each particle

Definition at line 104 of file KVVGSum.h.

Detailed Description

SETTING THE MODE OF OPERATION

SETTING THE PROPERTY TO BE SUMMED

SETTING THE PARTICLE SELECTION CRITERIA

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ fill()

◆ getvalue_char()

◆ getvalue_int()

◆ GetValueName()

◆ Init()

◆ init()

Member Data Documentation

◆ fClass

◆ fMethod

◆ fVal