KaliVeda
Toolkit for HIC analysis
Loading...
Searching...
No Matches
KVSubEventMaker Class Reference

Detailed Description

Global variable for defining random subevents.

This variable will create a group for a given fraction \(0<f<1\) of all particles in an event, chosen at random. The name of the variable is used as the name for the group. The fraction is given as a parameter.

Example of use:

KVSubEventMaker S("SubEvent1");
S.SetParameter("FRACTION", 0.5);
Global variable for defining random subevents.
RooArgSet S(Args_t &&... args)

For each event, a random subset of half of the particles will be added to the group "SubEvent1".

If the required fraction does not correspond to a whole number of particles, the number of particles included in the subevent will be drawn at random so that the mean number of particles in all subevents for a given total multiplicity \(N\) is equal to \(fN\). In other words, the probability distribution of the number of particles \(n\) in each subevent will be

\[ P(n) = \delta(n-n_0)(1-x)+\delta(n-(n_0+1))x \]

with

\[ n_0=\lfloor fN\rfloor, x=fN-n_0 \]

Author
John Frankland
Date
Fri Jun 25 17:36:45 2021

Definition at line 41 of file KVSubEventMaker.h.

#include <KVSubEventMaker.h>

Inheritance diagram for KVSubEventMaker:

Public Member Functions

 KVSubEventMaker ()
 
 KVSubEventMaker (const Char_t *nom)
 
virtual ~KVSubEventMaker ()
 
void Calculate ()
 Calculation of global variable value(s) after filling is finished.
 
void Copy (TObject &obj) const
 
void Init ()
 Initialisation of internal variables, called once before beginning treatment.
 
void Reset ()
 Reset internal variables, called before treatment of each event.
 
- 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 Copy (TObject &obj) 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 TStringGetFrame () 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
 
const KVNameValueListGetValueNameList () const
 
virtual Char_t GetValueType (Int_t) const
 
virtual std::vector< Double_tGetValueVector (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.
 
 KVBase (const Char_t *name, const Char_t *title="")
 Ctor for object with given name and type.
 
 KVBase (const KVBase &)
 copy ctor
 
virtual ~KVBase ()
 
virtual void Clear (Option_t *opt="")
 Clear object properties : name, type/title, number, label.
 
const Char_tGetLabel () const
 
UInt_t GetNumber () const
 
UInt_t GetNumberOfObjects () const
 
virtual TObjectGetObject () const
 
virtual const Char_tGetType () 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 ()
 
KVBaseoperator= (const KVBase &)
 copy assignment operator
 
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 ()
 
void Clear (Option_t *option="") override
 
TObjectClone (const char *newname="") const override
 
Int_t Compare (const TObject *obj) const override
 
void Copy (TObject &named) const override
 
virtual void FillBuffer (char *&buffer)
 
const char * GetName () const override
 
const char * GetTitle () const override
 
ULong_t Hash () const override
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 
TNamedoperator= (const TNamed &rhs)
 
void Print (Option_t *option="") const override
 
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
 
void Streamer (TBuffer &) override
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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 TObjectDrawClone (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=nullptr)
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 
virtual TObjectFindObject (const char *name) const
 
virtual TObjectFindObject (const TObject *obj) const
 
virtual Option_tGetDrawOption () const
 
virtual const char * GetIconName () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 
virtual Option_tGetOption () 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)
 
Bool_t IsDestructed () const
 
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 *vp)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, void *vp)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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)
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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=nullptr, Int_t option=0, Int_t bufsize=0)
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 

Private Member Functions

void fill (const KVNucleus *)
 add to internal list
 
Double_t getvalue_int (Int_t) const
 
void init ()
 PRIVATE method.
 

Private Attributes

std::vector< KVNucleus * > particles
 

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
 
- 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.
 
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_tFindFile (const Char_t *search, TString &wfil)
 
static const Char_tGetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetDATABASEFilePath ()
 
static const Char_tGetDATADIRFilePath (const Char_t *namefile="")
 
static Bool_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval)
 
static const Char_tGetDataSetEnv (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_tGetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.)
 
static const Char_tGetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetKVBuildDate ()
 Returns KaliVeda build date.
 
static const Char_tGetKVBuildDir ()
 Returns top-level directory used for build.
 
static const Char_tGetKVBuildTime ()
 Returns KaliVeda build time.
 
static const Char_tGetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...)
 
static const Char_tGetKVBuildUser ()
 Returns username of person who performed build.
 
static const Char_tGetKVSourceDir ()
 Returns top-level directory of source tree used for build.
 
static const Char_tGetKVVersion ()
 Returns KaliVeda version string.
 
static const Char_tGetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetListOfPlugins (const Char_t *base)
 
static const Char_tGetListOfPluginURIs (const Char_t *base)
 
static const Char_tGetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_tGetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_tgitBranch ()
 Returns git branch of sources.
 
static const Char_tgitCommit ()
 Returns last git commit of sources.
 
static void InitEnvironment ()
 
static bool is_gnuinstall ()
 
static Bool_t IsThisAPlugin (const TString &uri, TString &base)
 
static TPluginHandlerLoadPlugin (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.
 
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_tWorkingDirectory ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 
static Bool_t GetObjectStat ()
 
static void SetDtorOnly (void *obj)
 
static void SetObjectStat (Bool_t stat)
 
- Public Attributes inherited from TObject
 kBitMask
 
 kCanDelete
 
 kCannotPick
 
 kHasUUID
 
 kInconsistent
 
 kInvalidObject
 
 kIsOnHeap
 
 kIsReferenced
 
 kMustCleanup
 
 kNoContextMenu
 
 kNotDeleted
 
 kObjInCanvas
 
 kOverwrite
 
 kSingleKey
 
 kWriteDelete
 
 kZombie
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 
void MakeZombie ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TObject
 kOnlyPrepStep
 

Constructor & Destructor Documentation

◆ KVSubEventMaker() [1/2]

KVSubEventMaker::KVSubEventMaker ( )
inline

Definition at line 51 of file KVSubEventMaker.h.

◆ KVSubEventMaker() [2/2]

KVSubEventMaker::KVSubEventMaker ( const Char_t nom)
inline

Definition at line 56 of file KVSubEventMaker.h.

◆ ~KVSubEventMaker()

virtual KVSubEventMaker::~KVSubEventMaker ( )
inlinevirtual

Definition at line 64 of file KVSubEventMaker.h.

Member Function Documentation

◆ Calculate()

void KVSubEventMaker::Calculate ( void  )
virtual

Calculation of global variable value(s) after filling is finished.

Set group for required fraction of particles (starting from the first one)

Implements KVVarGlob.

Definition at line 60 of file KVSubEventMaker.cpp.

◆ Copy()

void KVSubEventMaker::Copy ( TObject a) const
virtual

Copy state of 'this' object into the KVSubEventMaker object referenced by 'a'. This is needed for the automatically generated copy constructor and copy assignment operator to work correctly.

Reimplemented from KVBase.

Definition at line 14 of file KVSubEventMaker.cpp.

◆ fill()

void KVSubEventMaker::fill ( const KVNucleus n)
privatevirtual

add to internal list

Reimplemented from KVVarGlob.

Definition at line 131 of file KVSubEventMaker.cpp.

◆ getvalue_int()

Double_t KVSubEventMaker::getvalue_int ( Int_t  index) const
privatevirtual

Protected method, called by GetValue(Int_t) and GetValue(const Char_t*) If your variable calculates several different values, this method allows to access each value based on a unique index number.

You should implement something like the following:

switch(index){ case 0: return val0; break; case 1: return val1; break; }

where 'val0' and 'val1' are the internal variables of your class corresponding to the required values.

In order for GetValue(const Char_t*) to work, you need to associate each named value with an index corresponding to the above 'switch' statement, e.g.

SetNameIndex("val0", 0);
SetNameIndex("val1", 1);

This should be done in the init() method.

Implements KVVarGlob.

Definition at line 120 of file KVSubEventMaker.cpp.

◆ Init()

void KVSubEventMaker::Init ( void  )
virtual

Initialisation of internal variables, called once before beginning treatment.

Implements KVVarGlob.

Definition at line 36 of file KVSubEventMaker.cpp.

◆ init()

void KVSubEventMaker::init ( void  )
private

PRIVATE method.

Private initialisation method called by all constructors. All member initialisations should be done here. You should also (if your variable calculates several different quantities) set up a correspondance between named values and index number using method SetNameIndex(const Char_t*,Int_t) in order for GetValue(const Char_t*) to work correctly. The index numbers should be the same as in your getvalue_int(Int_t) method.

Definition at line 151 of file KVSubEventMaker.cpp.

◆ Reset()

void KVSubEventMaker::Reset ( void  )
virtual

Reset internal variables, called before treatment of each event.

Implements KVVarGlob.

Definition at line 47 of file KVSubEventMaker.cpp.

Member Data Documentation

◆ particles

std::vector<KVNucleus*> KVSubEventMaker::particles
private

Definition at line 43 of file KVSubEventMaker.h.