KaliVeda
Toolkit for HIC analysis
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
KVSimReader Class Reference
Modelling and Simulation Tools

Detailed Description

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 ... "
KVBase::GetListOfPlugins
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 51 of file KVSimReader.h.

#include <KVSimReader.h>

Inheritance diagram for KVSimReader:
Inheritance graph
[legend]

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 ()
 
KVList * GetLinkedObjects ()
 
Int_t GetNumberOfEvents ()
 
const char * GetROOTFileName ()
 
KVList * GetSimuInfo ()
 
TTree * GetTree ()
 
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 *="")
 
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_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)
 

Static Public Member Functions

static KVSimReader * MakeSimReader (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_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 ()
 

Private Member Functions

void init ()
 

Private Attributes

KVString branch_name
 
KVSimEvent * evt
 
Int_t fFileIndex
 
TFile * file
 
Bool_t fMultiFiles
 
TString fOutputDirectory
 where to save converted events More...
 
Bool_t kmode
 
KVList * linked_info
 Liste d'info (TNamed) enregistree dans l arbre. More...
 
KVList * linked_objects
 liste d'objets a enregistree avec l'arbre More...
 
Int_t nevt
 
KVSimNucleus * nuc
 
KVNameValueList * nv
 
KVString root_file_name
 
TTree * tree
 
KVString tree_name
 
KVString tree_title
 

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 Attributes inherited from KVFileReader
std::ifstream f_in
 

Constructor & Destructor Documentation

◆ KVSimReader()

KVSimReader::KVSimReader ( )

Default constructor.

Definition at line 46 of file KVSimReader.cpp.

◆ ~KVSimReader()

KVSimReader::~KVSimReader ( )
virtual

Destructor.

Definition at line 72 of file KVSimReader.cpp.

Member Function Documentation

◆ AddInfo() [1/2]

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

Definition at line 351 of file KVSimReader.cpp.

◆ AddInfo() [2/2]

void KVSimReader::AddInfo ( TNamed *  named)

Definition at line 360 of file KVSimReader.cpp.

◆ AddObject()

void KVSimReader::AddObject ( TObject *  obj)

Definition at line 404 of file KVSimReader.cpp.

◆ CleanAll()

void KVSimReader::CleanAll ( )

Definition at line 87 of file KVSimReader.cpp.

◆ ConvertAndSaveEventsInFile()

void KVSimReader::ConvertAndSaveEventsInFile ( KVString  filename)
virtual

Read events, convert and save in ROOT file.

Definition at line 259 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 57 of file KVSimReader.cpp.

◆ CreateInfoList()

void KVSimReader::CreateInfoList ( )

Definition at line 383 of file KVSimReader.cpp.

◆ CreateObjectList()

void KVSimReader::CreateObjectList ( )

Definition at line 428 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 106 of file KVSimReader.cpp.

◆ FillTree()

virtual void KVSimReader::FillTree ( )
inlinevirtual

Definition at line 123 of file KVSimReader.h.

◆ GetDate()

virtual KVString KVSimReader::GetDate ( )
inlinevirtual

Definition at line 97 of file KVSimReader.h.

◆ GetLinkedObjects()

KVList * KVSimReader::GetLinkedObjects ( )

Definition at line 395 of file KVSimReader.cpp.

◆ GetNumberOfEvents()

Int_t KVSimReader::GetNumberOfEvents ( )
inline

Definition at line 153 of file KVSimReader.h.

◆ GetROOTFileName()

const char* KVSimReader::GetROOTFileName ( )
inline

Definition at line 175 of file KVSimReader.h.

◆ GetSimuInfo()

KVList * KVSimReader::GetSimuInfo ( )

Definition at line 341 of file KVSimReader.cpp.

◆ GetTree()

TTree* KVSimReader::GetTree ( )
inline

Definition at line 119 of file KVSimReader.h.

◆ HasToFill()

virtual Bool_t KVSimReader::HasToFill ( )
inlinevirtual

Definition at line 127 of file KVSimReader.h.

◆ init()

void KVSimReader::init ( void  )
private

Definition at line 16 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 272 of file KVSimReader.cpp.

◆ ReadEvent()

Bool_t KVSimReader::ReadEvent ( )
virtual

Reimplemented in KVSimReader_SMF_asym, KVSimReader_SMF, KVSimReader_MMM_asym, KVSimReader_MMM, KVSimReader_HIPSE_asym, KVSimReader_HIPSE, KVSimReader_ELIE2023, KVSimReader_ELIE, and KVSimReader_DIT.

Definition at line 183 of file KVSimReader.cpp.

◆ ReadFile()

void KVSimReader::ReadFile ( )
virtual

Reimplemented in KVSimReader_SMF_asym, KVSimReader_SMF, KVSimReader_MMM_asym, KVSimReader_MMM, KVSimReader_HIPSE, KVSimReader_ELIE, and KVSimReader_DIT.

Definition at line 131 of file KVSimReader.cpp.

◆ ReadHeader()

Bool_t KVSimReader::ReadHeader ( )
virtual

Reimplemented in KVSimReader_SMF_asym, KVSimReader_SMF, KVSimReader_HIPSE, KVSimReader_ELIE2023, and KVSimReader_ELIE.

Definition at line 154 of file KVSimReader.cpp.

◆ ReadNucleus()

Bool_t KVSimReader::ReadNucleus ( )
virtual

Reimplemented in KVSimReader_SMF_asym, KVSimReader_SMF, KVSimReader_MMM_asym, KVSimReader_MMM, KVSimReader_HIPSE_asym, KVSimReader_HIPSE, KVSimReader_ELIE_asym, KVSimReader_ELIE2023, and KVSimReader_ELIE.

Definition at line 223 of file KVSimReader.cpp.

◆ Run()

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

Definition at line 289 of file KVSimReader.cpp.

◆ SaveTree()

void KVSimReader::SaveTree ( )
virtual

Definition at line 324 of file KVSimReader.cpp.

◆ SetBranchName()

void KVSimReader::SetBranchName ( const Char_t *  n)
inline

Definition at line 170 of file KVSimReader.h.

◆ SetFileIndex()

void KVSimReader::SetFileIndex ( Int_t  i)
inline

Definition at line 88 of file KVSimReader.h.

◆ SetFillingMode()

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

Definition at line 113 of file KVSimReader.h.

◆ SetMultiFiles()

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

Definition at line 84 of file KVSimReader.h.

◆ SetOutputDirectory()

void KVSimReader::SetOutputDirectory ( const TString &  where)
inline

Definition at line 92 of file KVSimReader.h.

◆ SetROOTFileName()

void KVSimReader::SetROOTFileName ( const Char_t *  n)
inline

Definition at line 166 of file KVSimReader.h.

◆ SetTreeName()

void KVSimReader::SetTreeName ( const Char_t *  n)
inline

Definition at line 158 of file KVSimReader.h.

◆ SetTreeTitle()

void KVSimReader::SetTreeTitle ( const Char_t *  n)
inline

Definition at line 162 of file KVSimReader.h.

◆ WriteInfo()

void KVSimReader::WriteInfo ( )

Definition at line 370 of file KVSimReader.cpp.

◆ WriteObjects()

void KVSimReader::WriteObjects ( )

Definition at line 413 of file KVSimReader.cpp.

Member Data Documentation

◆ branch_name

KVString KVSimReader::branch_name
private

Definition at line 63 of file KVSimReader.h.

◆ evt

KVSimEvent* KVSimReader::evt
private

Definition at line 59 of file KVSimReader.h.

◆ fFileIndex

Int_t KVSimReader::fFileIndex
private

Definition at line 66 of file KVSimReader.h.

◆ file

TFile* KVSimReader::file
private

Definition at line 58 of file KVSimReader.h.

◆ fMultiFiles

Bool_t KVSimReader::fMultiFiles
private

Definition at line 65 of file KVSimReader.h.

◆ fOutputDirectory

TString KVSimReader::fOutputDirectory
private

where to save converted events

Definition at line 67 of file KVSimReader.h.

◆ kmode

Bool_t KVSimReader::kmode
private

Definition at line 64 of file KVSimReader.h.

◆ linked_info

KVList* KVSimReader::linked_info
private

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

infos ou objets specifiques a une simulation

Definition at line 71 of file KVSimReader.h.

◆ linked_objects

KVList* KVSimReader::linked_objects
private

liste d'objets a enregistree avec l'arbre

Definition at line 72 of file KVSimReader.h.

◆ nevt

Int_t KVSimReader::nevt
private

Definition at line 62 of file KVSimReader.h.

◆ nuc

KVSimNucleus* KVSimReader::nuc
private

Definition at line 60 of file KVSimReader.h.

◆ nv

KVNameValueList* KVSimReader::nv
private

Definition at line 74 of file KVSimReader.h.

◆ root_file_name

KVString KVSimReader::root_file_name
private

Definition at line 63 of file KVSimReader.h.

◆ tree

TTree* KVSimReader::tree
private

Definition at line 57 of file KVSimReader.h.

◆ tree_name

KVString KVSimReader::tree_name
private

Definition at line 63 of file KVSimReader.h.

◆ tree_title

KVString KVSimReader::tree_title
private

Definition at line 63 of file KVSimReader.h.