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

Base class to read output files for simulation and create tree using KVSimEvent class.

Created by KVClassFactory on Wed Jun 30 17:45:01 2010 Author: bonnet

Specific classes derived from this one can be used to read a variety of simulation output files and transform them into ROOT files containing a TTree with KVSimEvent objects in a branch called 'Simulated_events'.

To see the list of available classes/models:

kaliveda[0] KVBase::GetListOfPlugins("KVSimReader")
(const Char_t *) "KVSimReader_ELIE KVSimReader_ELIE_asym KVSimReader_HIPSE KVSimReader_HIPSE_asym ... "
char Char_t
static const Char_t * GetListOfPlugins(const Char_t *base)
Definition: KVBase.cpp:1260

Usually for each model there is a class [XXX] and a class [XXX]_asym. The first one is for reading "primary" events (e.g. before secondary decay), the second one is for converting "asymptotic" events (e.g. just before detection).

To generate an instance of the appropriate reader object, use the static method KVSimReader::MakeReader("[model name]_[asym]")

Example 1

To convert asymptotic events from an MMM simulation in file "mmm.out", do:

kaliveda[0] KVSimReader::MakeReader("MMM_asym")->ConvertAndSaveEventsInFile("mmm.out")

Example 2

To convert primary events (before secondary decay) from an ELIE simulation in file "elie.out", do:

kaliveda[0] KVSimReader::MakeReader("ELIE")->ConvertAndSaveEventsInFile("elie.out")

Definition at line 57 of file KVSimReader.h.

Public Member Functions

 KVSimReader ()
 Default constructor. More...
 
virtual ~KVSimReader ()
 Destructor. More...
 
void AddInfo (const Char_t *name, const Char_t *val)
 
void AddInfo (TNamed *named)
 
void AddObject (TObject *obj)
 
void CleanAll ()
 
virtual void ConvertAndSaveEventsInFile (KVString filename)
 Read events, convert and save in ROOT file. More...
 
virtual void ConvertEventsInFile (KVString filename)
 Method called by constructors with KVString filename argument. More...
 
void CreateInfoList ()
 
void CreateObjectList ()
 
void DeclareTree (Option_t *option)
 
virtual void FillTree ()
 
virtual KVString GetDate ()
 
KVListGetLinkedObjects ()
 
Int_t GetNumberOfEvents ()
 
const char * GetROOTFileName ()
 
KVListGetSimuInfo ()
 
TTreeGetTree ()
 
virtual Bool_t HasToFill ()
 
virtual Bool_t ReadEvent ()
 
virtual void ReadFile ()
 
virtual Bool_t ReadHeader ()
 
virtual Bool_t ReadNucleus ()
 
void Run (Option_t *option="recreate")
 
virtual void SaveTree ()
 
void SetBranchName (const Char_t *n)
 
void SetFileIndex (Int_t i)
 
void SetFillingMode (Bool_t mode=kTRUE)
 
void SetMultiFiles (Bool_t on=kTRUE)
 
void SetOutputDirectory (const TString &where)
 
void SetROOTFileName (const Char_t *n)
 
void SetTreeName (const Char_t *n)
 
void SetTreeTitle (const Char_t *n)
 
void WriteInfo ()
 
void WriteObjects ()
 
- Public Member Functions inherited from KVFileReader
 KVFileReader (const KVString &comments="")
 
void Clear (Option_t *="")
 Clear object properties : name, type/title, number, label. More...
 
void CloseFile ()
 
KVString GetCurrentLine ()
 
Double_t GetDoubleReadPar (Int_t pos) const
 
KVString GetFileName ()
 
Int_t GetIntReadPar (Int_t pos) const
 
Int_t GetNlineRead () const
 
Int_t GetNparRead () const
 
KVString GetReadPar (Int_t pos) const
 
KVString GetReadStatus (ReadStatus s)
 
Bool_t IsOK ()
 
Bool_t OpenFileToRead (const KVString &filename)
 
Bool_t PreparForReadingAgain ()
 
ReadStatus ReadLine (const KVString &pattern="")
 
ReadStatus ReadLineAndAdd (const KVString &pattern="")
 
ReadStatus ReadLineAndCheck (Int_t nexpect, const KVString &pattern)
 
ReadStatus ReuseLineAndCheck (Int_t nexpect, const KVString &pattern)
 
- 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 Copy (TObject &) const
 Make a copy of this object. More...
 
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 KVSimReaderMakeSimReader (const char *model_uri)
 
- 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

KVString branch_name
 
KVSimEventevt
 
Int_t fFileIndex
 
TFilefile
 
Bool_t fMultiFiles
 
TString fOutputDirectory
 where to save converted events More...
 
Bool_t kmode
 
KVListlinked_info
 Liste d'info (TNamed) enregistree dans l arbre. More...
 
KVListlinked_objects
 liste d'objets a enregistree avec l'arbre More...
 
Int_t nevt
 
KVSimNucleusnuc
 
KVNameValueListnv
 
KVString root_file_name
 
TTreetree
 
KVString tree_name
 
KVString tree_title
 
- Protected Attributes inherited from KVFileReader
KVString comment_string
 
KVString file_name
 
std::vector< std::string > items
 
Int_t nline
 
KVString reading_line
 
Bool_t skip_comments = false
 
Bool_t status
 
- 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
 

Private Member Functions

void init ()
 

Additional Inherited Members

- Public Types inherited from KVFileReader
enum class  ReadStatus {
  EmptyLine , OK , ParamMismatch , CommentLine ,
  EndOfFile
}
 status returned by each method used to read a line in the file More...
 
- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 
- Public Types inherited from TObject
enum  EDeprecatedStatusBits
 
enum  EStatusBits
 
- Public Attributes inherited from KVFileReader
std::ifstream f_in
 
- 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 <KVSimReader.h>

Inheritance diagram for KVSimReader:
Inheritance graph
[legend]

Constructor & Destructor Documentation

◆ KVSimReader()

KVSimReader::KVSimReader ( )

Default constructor.

Definition at line 45 of file KVSimReader.cpp.

◆ ~KVSimReader()

KVSimReader::~KVSimReader ( )
virtual

Destructor.

Definition at line 71 of file KVSimReader.cpp.

Member Function Documentation

◆ AddInfo() [1/2]

void KVSimReader::AddInfo ( const Char_t name,
const Char_t val 
)

Definition at line 350 of file KVSimReader.cpp.

◆ AddInfo() [2/2]

void KVSimReader::AddInfo ( TNamed named)

Definition at line 359 of file KVSimReader.cpp.

◆ AddObject()

void KVSimReader::AddObject ( TObject obj)

Definition at line 403 of file KVSimReader.cpp.

◆ CleanAll()

void KVSimReader::CleanAll ( )

Definition at line 86 of file KVSimReader.cpp.

◆ ConvertAndSaveEventsInFile()

void KVSimReader::ConvertAndSaveEventsInFile ( KVString  filename)
virtual

Read events, convert and save in ROOT file.

Definition at line 258 of file KVSimReader.cpp.

◆ ConvertEventsInFile()

void KVSimReader::ConvertEventsInFile ( KVString  filename)
virtual

Method called by constructors with KVString filename argument.

Reimplemented in KVSimReader_DIT, KVSimReader_HIPSE_asym, KVSimReader_HIPSE, and KVSimReader_ELIE.

Definition at line 56 of file KVSimReader.cpp.

◆ CreateInfoList()

void KVSimReader::CreateInfoList ( )

Definition at line 382 of file KVSimReader.cpp.

◆ CreateObjectList()

void KVSimReader::CreateObjectList ( )

Definition at line 427 of file KVSimReader.cpp.

◆ DeclareTree()

void KVSimReader::DeclareTree ( Option_t option)

Use root_file_name as basename for file If multiple files are being read, they will be named [root_file_name].1 [root_file_name].2 [root_file_name].etc Files are written in fOutputDirectory (default: "./")

Definition at line 105 of file KVSimReader.cpp.

◆ FillTree()

virtual void KVSimReader::FillTree ( )
inlinevirtual

Definition at line 129 of file KVSimReader.h.

◆ GetDate()

virtual KVString KVSimReader::GetDate ( )
inlinevirtual

Definition at line 103 of file KVSimReader.h.

◆ GetLinkedObjects()

KVList * KVSimReader::GetLinkedObjects ( )

Definition at line 394 of file KVSimReader.cpp.

◆ GetNumberOfEvents()

Int_t KVSimReader::GetNumberOfEvents ( )
inline

Definition at line 159 of file KVSimReader.h.

◆ GetROOTFileName()

const char* KVSimReader::GetROOTFileName ( )
inline

Definition at line 181 of file KVSimReader.h.

◆ GetSimuInfo()

KVList * KVSimReader::GetSimuInfo ( )

Definition at line 340 of file KVSimReader.cpp.

◆ GetTree()

TTree* KVSimReader::GetTree ( )
inline

Definition at line 125 of file KVSimReader.h.

◆ HasToFill()

virtual Bool_t KVSimReader::HasToFill ( )
inlinevirtual

Definition at line 133 of file KVSimReader.h.

◆ init()

void KVSimReader::init ( void  )
private

Definition at line 15 of file KVSimReader.cpp.

◆ MakeSimReader()

KVSimReader * KVSimReader::MakeSimReader ( const char *  model_uri)
static

Static method Returns an instance of a child class specific to given model.

Definition at line 271 of file KVSimReader.cpp.

◆ ReadEvent()

Bool_t KVSimReader::ReadEvent ( )
virtual

◆ ReadFile()

void KVSimReader::ReadFile ( )
virtual

◆ ReadHeader()

Bool_t KVSimReader::ReadHeader ( )
virtual

◆ ReadNucleus()

Bool_t KVSimReader::ReadNucleus ( )
virtual

◆ Run()

void KVSimReader::Run ( Option_t option = "recreate")

Definition at line 288 of file KVSimReader.cpp.

◆ SaveTree()

void KVSimReader::SaveTree ( )
virtual

Definition at line 323 of file KVSimReader.cpp.

◆ SetBranchName()

void KVSimReader::SetBranchName ( const Char_t n)
inline

Definition at line 176 of file KVSimReader.h.

◆ SetFileIndex()

void KVSimReader::SetFileIndex ( Int_t  i)
inline

Definition at line 94 of file KVSimReader.h.

◆ SetFillingMode()

void KVSimReader::SetFillingMode ( Bool_t  mode = kTRUE)
inline

Definition at line 119 of file KVSimReader.h.

◆ SetMultiFiles()

void KVSimReader::SetMultiFiles ( Bool_t  on = kTRUE)
inline

Definition at line 90 of file KVSimReader.h.

◆ SetOutputDirectory()

void KVSimReader::SetOutputDirectory ( const TString where)
inline

Definition at line 98 of file KVSimReader.h.

◆ SetROOTFileName()

void KVSimReader::SetROOTFileName ( const Char_t n)
inline

Definition at line 172 of file KVSimReader.h.

◆ SetTreeName()

void KVSimReader::SetTreeName ( const Char_t n)
inline

Definition at line 164 of file KVSimReader.h.

◆ SetTreeTitle()

void KVSimReader::SetTreeTitle ( const Char_t n)
inline

Definition at line 168 of file KVSimReader.h.

◆ WriteInfo()

void KVSimReader::WriteInfo ( )

Definition at line 369 of file KVSimReader.cpp.

◆ WriteObjects()

void KVSimReader::WriteObjects ( )

Definition at line 412 of file KVSimReader.cpp.

Member Data Documentation

◆ branch_name

KVString KVSimReader::branch_name
protected

Definition at line 69 of file KVSimReader.h.

◆ evt

KVSimEvent* KVSimReader::evt
protected

Definition at line 65 of file KVSimReader.h.

◆ fFileIndex

Int_t KVSimReader::fFileIndex
protected

Definition at line 72 of file KVSimReader.h.

◆ file

TFile* KVSimReader::file
protected

Definition at line 64 of file KVSimReader.h.

◆ fMultiFiles

Bool_t KVSimReader::fMultiFiles
protected

Definition at line 71 of file KVSimReader.h.

◆ fOutputDirectory

TString KVSimReader::fOutputDirectory
protected

where to save converted events

Definition at line 73 of file KVSimReader.h.

◆ kmode

Bool_t KVSimReader::kmode
protected

Definition at line 70 of file KVSimReader.h.

◆ linked_info

KVList* KVSimReader::linked_info
protected

Liste d'info (TNamed) enregistree dans l arbre.

infos ou objets specifiques a une simulation

Definition at line 77 of file KVSimReader.h.

◆ linked_objects

KVList* KVSimReader::linked_objects
protected

liste d'objets a enregistree avec l'arbre

Definition at line 78 of file KVSimReader.h.

◆ nevt

Int_t KVSimReader::nevt
protected

Definition at line 68 of file KVSimReader.h.

◆ nuc

KVSimNucleus* KVSimReader::nuc
protected

Definition at line 66 of file KVSimReader.h.

◆ nv

KVNameValueList* KVSimReader::nv
protected

Definition at line 80 of file KVSimReader.h.

◆ root_file_name

KVString KVSimReader::root_file_name
protected

Definition at line 69 of file KVSimReader.h.

◆ tree

TTree* KVSimReader::tree
protected

Definition at line 63 of file KVSimReader.h.

◆ tree_name

KVString KVSimReader::tree_name
protected

Definition at line 69 of file KVSimReader.h.

◆ tree_title

KVString KVSimReader::tree_title
protected

Definition at line 69 of file KVSimReader.h.


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