KaliVeda  1.13/01
Heavy-Ion Analysis Toolkit
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
KVEvent Class Referenceabstract

Abstract base class container for multi-particle events.

This base class defines the basic functionality and interface for all event classes, which in addition to handling a collection of massive particles, also have in common the following functionality:

Concrete implementations of event classes (which define the type of particle objects used) derive from child class KVTemplateEvent. Note that any class derived from KVParticle can be used in an event (representing relativistic massive particles), not only KVNucleus and daughter classes.

Adding particles to an event

Particles are added to an event using methods AddParticle() or AddNucleus(). The first method returns a KVParticle pointer to the added particle while the latter casts to a KVNucleus pointer for classes which derive from KVNucleus, returning nullptr if not (but a particle is still created and added to the event):

KVEvent& e; // base reference to some event class
auto p = e.AddParticle(); // KVParticle* p
auto n = e.AddNucleus(); // KVNucleus* n
if(n) {
std::cout << "Event contains objects derived from KVNucleus" << std::endl;
assert(n->InheritsFrom(KVNucleus::Class())); // check using ROOT runtime inspection
}
else {
std::cout << "n == nullptr : Event contains objects NOT derived from KVNucleus" << std::endl;
assert(!(p->InheritsFrom(KVNucleus::Class()))); // check using ROOT runtime inspection
}
#define e(i)
Abstract base class container for multi-particle events.
Definition: KVEvent.h:66
const Int_t n

The number of particles in the event, its size or multiplicity, is given by GetMult():

auto mult = e.GetMult();

Iterating over particles in an event

See Nuclei & Events

See also
KVTemplateEvent, Nuclei & Events
Examples
ExampleINDRAAnalysis.cpp, and KVEvent_iterator_example.C.

Definition at line 66 of file KVEvent.h.

Public Member Functions

 KVEvent (const TClass *particle_class, Int_t mult=50)
 
virtual ~KVEvent ()
 
KVNucleusAddNucleus ()
 
virtual KVParticleAddParticle ()=0
 
virtual void ChangeDefaultFrame (const Char_t *, const Char_t *="")=0
 
void Clear (Option_t *opt="")
 Clear object properties : name, type/title, number, label. More...
 
void Copy (TObject &obj) const
 
void CustomStreamer ()
 
virtual Double_t GetChannelQValue () const =0
 
const Char_tGetFrameName () const
 
virtual void GetMasses (std::vector< Double_t > &)=0
 
Int_t GetMinimumOKMultiplicity () const
 
virtual Int_t GetMult (Option_t *opt="") const
 
KVNucleusGetNextNucleus (Option_t *opt="") const
 
virtual KVParticleGetNextParticle (Option_t *="") const =0
 
KVNucleusGetNucleus (Int_t npart) const
 
KVNameValueListGetParameters () const
 
virtual KVParticleGetParticle (Int_t npart) const =0
 
const TClonesArrayGetParticleArray () const
 
virtual KVString GetPartitionName ()=0
 
virtual Double_t GetSum (const Char_t *, Option_t *="")=0
 
virtual Bool_t IsOK () const
 
virtual void MergeEventFragments (TCollection *events, Option_t *opt="")
 
void ResetGetNextNucleus () const
 
virtual void ResetGetNextParticle () const =0
 
virtual void SetFrame (const Char_t *, const Char_t *, const KVFrameTransform &)=0
 
virtual void SetFrame (const Char_t *, const KVFrameTransform &)=0
 
virtual void SetFrameName (const KVString &name)=0
 
void SetMinimumOKMultiplicity (Int_t x)
 
template<typename ValType >
void SetParameter (const Char_t *name, ValType value) const
 
- 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 ()
 
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 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)
 
- 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 TObjectClone (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
 
TNamedoperator= (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 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=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 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)
 
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)
 
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)
 
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 KVEventFactory (const char *plugin)
 
template<typename T >
static void MakeEventBranch (TTree *tree, const TString &branchname, T &event, Int_t bufsize=10000000)
 
- 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_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.) More...
 
static const Char_tGetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetKVBuildDate ()
 Returns KaliVeda build date. More...
 
static const Char_tGetKVBuildDir ()
 Returns top-level directory used for build. More...
 
static const Char_tGetKVBuildTime ()
 Returns KaliVeda build time. More...
 
static const Char_tGetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...
 
static const Char_tGetKVBuildUser ()
 Returns username of person who performed build. More...
 
static const Char_tGetKVSourceDir ()
 Returns top-level directory of source tree used for build. More...
 
static const Char_tGetKVVersion ()
 Returns KaliVeda version string. More...
 
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. More...
 
static const Char_tgitCommit ()
 Returns last git commit of sources. More...
 
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. 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_tWorkingDirectory ()
 
- 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 Attributes

KVNameValueList fParameters
 general-purpose list of parameters More...
 
TClonesArrayfParticles
 array of particles in event 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
 

Additional Inherited Members

- 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 Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 
void MakeZombie ()
 

#include <KVEvent.h>

Inheritance diagram for KVEvent:
Inheritance graph
[legend]

Constructor & Destructor Documentation

◆ KVEvent()

KVEvent::KVEvent ( const TClass particle_class,
Int_t  mult = 50 
)
inline

Definition at line 120 of file KVEvent.h.

◆ ~KVEvent()

virtual KVEvent::~KVEvent ( )
inlinevirtual

Destructor. Destroys all objects stored in TClonesArray and releases allocated memory.

Definition at line 126 of file KVEvent.h.

Member Function Documentation

◆ AddNucleus()

KVNucleus * KVEvent::AddNucleus ( )

Add a particle to the event

Returns
pointer to new particle if it inherits from KVNucleus, nullptr if not
Examples
KVEvent_iterator_example.C.

Definition at line 109 of file KVEvent.cpp.

◆ AddParticle()

virtual KVParticle* KVEvent::AddParticle ( )
pure virtual

◆ ChangeDefaultFrame()

virtual void KVEvent::ChangeDefaultFrame ( const Char_t ,
const Char_t = "" 
)
pure virtual

◆ Clear()

void KVEvent::Clear ( Option_t opt = "")
inlinevirtual

Clear object properties : name, type/title, number, label.

Reset the event to zero ready for new event. This will first call KVParticle::Clear() for each particle in the event before removing it from the event. After calling this method, GetMult() returns 0.

Parameters
[in]optoption string passed on to the KVParticle::Clear() method of each particle in the event

Reimplemented from KVBase.

Definition at line 262 of file KVEvent.h.

◆ Copy()

void KVEvent::Copy ( TObject obj) const
virtual

Copy this event into the object referenced by obj, assumed to be at least derived from KVEvent.

Reimplemented from KVBase.

Definition at line 123 of file KVEvent.cpp.

◆ CustomStreamer()

void KVEvent::CustomStreamer ( )
inline

Definition at line 198 of file KVEvent.h.

◆ Factory()

static KVEvent* KVEvent::Factory ( const char *  plugin)
inlinestatic

Create and return pointer to new event of class given by plugin

Definition at line 252 of file KVEvent.h.

◆ GetChannelQValue()

virtual Double_t KVEvent::GetChannelQValue ( ) const
pure virtual

◆ GetFrameName()

const Char_t* KVEvent::GetFrameName ( ) const
inline

Returns name of default kinematical frame for particles in event, if set (see SetFrameName())

Definition at line 213 of file KVEvent.h.

◆ GetMasses()

virtual void KVEvent::GetMasses ( std::vector< Double_t > &  )
pure virtual

◆ GetMinimumOKMultiplicity()

Int_t KVEvent::GetMinimumOKMultiplicity ( ) const
inline

Get minimum number of particles with IsOK()=kTRUE in event for it to be considered 'good' for analysis NB: if no minimum has been set, we return 1

Definition at line 187 of file KVEvent.h.

◆ GetMult()

virtual Int_t KVEvent::GetMult ( Option_t opt = "") const
inlinevirtual

Returns multiplicity (number of particles) in event.

Parameters
[in]optoptional argument which may limit multiplicity to certain nuclei:
  • opt="" (default): all nuclei of event are counted
  • opt="OK": only nuclei for which KVNucleus::IsOK() returns true are counted
  • opt="group": only nuclei belonging to given group are counted
Note
Any value given for opt is case-insensitive

Reimplemented in KVTemplateEvent< Particle >, KVTemplateEvent< KVReconstructedNucleus >, and KVTemplateEvent< KVSimNucleus >.

Definition at line 141 of file KVEvent.h.

◆ GetNextNucleus()

KVNucleus * KVEvent::GetNextNucleus ( Option_t opt = "") const
Warning
Only use with events containing objects derived from KVNucleus

Use this method to iterate over the list of nuclei in the event After the last particle GetNextNucleus() returns a null pointer and resets itself ready for a new iteration over the particle list.

If opt="" all particles are included in the iteration. If opt="ok" or "OK" only nuclei whose KVNucleus::IsOK() method returns kTRUE are included.

Any other value of opt is interpreted as a (case-insensitive) particle group name: only particles with BelongsToGroup(opt) returning kTRUE are included.

If you want to start from the beginning again before getting to the end of the list, especially if you want to change the selection criteria, call method ResetGetNextNucleus() before continuing.

If you interrupt an iteration before the end, then start another iteration without calling ResetGetNextNucleus(), even if you change the argument of the call to GetNextNucleus(), you will repeat exactly the same iteration as the previous one.

Warning
Only one iteration at a time over the event can be performed using this method. If you want/need to perform several i.e. nested iterations, see KVTemplateEvent::EventIterator

Definition at line 54 of file KVEvent.cpp.

◆ GetNextParticle()

virtual KVParticle* KVEvent::GetNextParticle ( Option_t = "") const
pure virtual

◆ GetNucleus()

KVNucleus * KVEvent::GetNucleus ( Int_t  npart) const
Warning
Only use with events containing objects derived from KVNucleus
Parameters
[in]npartindex of particle in event, which is a non-zero value from 1 to the value returned by GetMult()
Returns
pointer to the particle with index npart

Definition at line 92 of file KVEvent.cpp.

◆ GetParameters()

KVNameValueList* KVEvent::GetParameters ( ) const
inline

Definition at line 203 of file KVEvent.h.

◆ GetParticle()

virtual KVParticle* KVEvent::GetParticle ( Int_t  npart) const
pure virtual

◆ GetParticleArray()

const TClonesArray* KVEvent::GetParticleArray ( ) const
inline

Definition at line 137 of file KVEvent.h.

◆ GetPartitionName()

virtual KVString KVEvent::GetPartitionName ( )
pure virtual

◆ GetSum()

virtual Double_t KVEvent::GetSum ( const Char_t ,
Option_t = "" 
)
pure virtual

◆ IsOK()

virtual Bool_t KVEvent::IsOK ( ) const
inlinevirtual

Returns kTRUE if the event is OK for analysis.

This means there must be at least MOKmin particles for which KVNucleus::IsOK() returns kTRUE, where MOKmin is set by calling SetMinimumOKMultiplicity() (value stored in parameter MIN_OK_MULT)

Definition at line 171 of file KVEvent.h.

◆ MakeEventBranch()

template<typename T >
static void KVEvent::MakeEventBranch ( TTree tree,
const TString branchname,
T event,
Int_t  bufsize = 10000000 
)
inlinestatic

Use this method when adding a branch to a TTree to store KVEvent-derived objects.

Parameters
[in]treepointer to TTree
[in]branchnamename of branch to create
[in]eventpointer to a valid (constructed) KVEvent-derived object
[in]bufsizesize of buffer to use for branch [default: 10000000]

Example of use:

auto tree = new TTree;
auto event = new KVReconstructedEvent; // just an example: any type of event can be used
KVEvent::MakeEventBranch(tree, "ReconEventBranch", event);
static void MakeEventBranch(TTree *tree, const TString &branchname, T &event, Int_t bufsize=10000000)
Definition: KVEvent.h:234
Event containing KVReconstructedNucleus nuclei reconstructed from hits in detectors.

Definition at line 234 of file KVEvent.h.

◆ MergeEventFragments()

void KVEvent::MergeEventFragments ( TCollection events,
Option_t opt = "" 
)
virtual

Merge all events in the list into one event (this one)

We also merge/sum the parameter lists of the events

First we clear this event, then we fill it with copies of each particle in each event in the list.

If option "opt" is given, it is given as argument to each call to KVEvent::Clear() - this option is then passed on to the KVParticle::Clear() method of each particle in each event.

Parameters
[in]eventsA list of events to merge
[in]optOptional argument transmitted to KVEvent::Clear()
Note
the events in the list will be empty and useless after this!

Reimplemented in KVReconstructedEvent.

Definition at line 154 of file KVEvent.cpp.

◆ ResetGetNextNucleus()

void KVEvent::ResetGetNextNucleus ( ) const
inline

Used with GetNextNucleus() in order to reset the internal iterator to the beginning of the event

Definition at line 161 of file KVEvent.h.

◆ ResetGetNextParticle()

virtual void KVEvent::ResetGetNextParticle ( ) const
pure virtual

◆ SetFrame() [1/2]

virtual void KVEvent::SetFrame ( const Char_t ,
const Char_t ,
const KVFrameTransform  
)
pure virtual

◆ SetFrame() [2/2]

virtual void KVEvent::SetFrame ( const Char_t ,
const KVFrameTransform  
)
pure virtual

◆ SetFrameName()

virtual void KVEvent::SetFrameName ( const KVString name)
pure virtual

◆ SetMinimumOKMultiplicity()

void KVEvent::SetMinimumOKMultiplicity ( Int_t  x)
inline

Set minimum number of particles with IsOK()=kTRUE in event for it to be considered 'good' for analysis

Definition at line 181 of file KVEvent.h.

◆ SetParameter()

template<typename ValType >
void KVEvent::SetParameter ( const Char_t name,
ValType  value 
) const
inline

Set or change the value of a named paramater in the list associated with the event.

See also
KVNameValueList

Definition at line 221 of file KVEvent.h.

Member Data Documentation

◆ fParameters

KVNameValueList KVEvent::fParameters
protected

general-purpose list of parameters

Definition at line 71 of file KVEvent.h.

◆ fParticles

TClonesArray* KVEvent::fParticles
protected

array of particles in event

Definition at line 70 of file KVEvent.h.


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