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:
- an associated list of parameters, accessible through the GetParameters() and SetParameter() methods;
- iterators for looping over all or a subset of the particles of the event;
- methods for defining named subsets ('groups') of particles according to various selection criteria;
- methods for defining/modifying different relativistic reference frames in which to 'view' the particles of the event
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):
auto p =
e.AddParticle();
if(n) {
std::cout << "Event contains objects derived from KVNucleus" << std::endl;
assert(
n->InheritsFrom(KVNucleus::Class()));
}
else {
std::cout << "n == nullptr : Event contains objects NOT derived from KVNucleus" << std::endl;
assert(!(p->InheritsFrom(KVNucleus::Class())));
}
Abstract base class container for multi-particle events.
The number of particles in the event, its size or multiplicity, is given by 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.
|
| KVEvent (const TClass *particle_class, Int_t mult=50) |
|
virtual | ~KVEvent () |
|
KVNucleus * | AddNucleus () |
|
virtual KVParticle * | AddParticle ()=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_t * | GetFrameName () const |
|
virtual void | GetMasses (std::vector< Double_t > &)=0 |
|
Int_t | GetMinimumOKMultiplicity () const |
|
virtual Int_t | GetMult (Option_t *opt="") const |
|
KVNucleus * | GetNextNucleus (Option_t *opt="") const |
|
virtual KVParticle * | GetNextParticle (Option_t *="") const =0 |
|
KVNucleus * | GetNucleus (Int_t npart) const |
|
KVNameValueList * | GetParameters () const |
|
virtual KVParticle * | GetParticle (Int_t npart) const =0 |
|
const TClonesArray * | GetParticleArray () 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 |
|
| 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_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) |
|
| 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 |
|
| 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 KVEvent * | Factory (const char *plugin) |
|
template<typename T > |
static void | MakeEventBranch (TTree *tree, const TString &branchname, T &event, Int_t bufsize=10000000) |
|
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 () |
|
static Longptr_t | GetDtorOnly () |
|
static Bool_t | GetObjectStat () |
|
static void | SetDtorOnly (void *obj) |
|
static void | SetObjectStat (Bool_t stat) |
|
- 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.