REST-for-Physics
v2.3
Rare Event Searches ToolKit for Physics
|
Running the processes efficiently with fantastic display.
This class implements REST's main functionality - process running. multi- thread is enabled here which improves efficiency. Pause menu and progress bar is also provided which makes the work easier!
RESTsoft - Software for Rare Event Searches with TPCs
History of developments:
2014-june: First concept. As part of conceptualization of previous REST code (REST v2) Igor G. Irastorza
2017-Aug: Major change: added for multi-thread capability Kaixiang Ni
Definition at line 28 of file TRestProcessRunner.h.
#include <TRestProcessRunner.h>
Public Member Functions | |
void | BeginOfInit () |
Reads information from rml config file. More... | |
ClassDefOverride (TRestProcessRunner, 7) | |
void | ConfigOutputFile () |
Forming an output file. More... | |
void | EndOfInit () |
Ending of the startup procedure. More... | |
void | FillThreadEventFunc (TRestThread *t) |
Calling back the FillEvent() method in TRestThread. More... | |
Long64_t | GetFileSplitSize () const |
TRestAnalysisTree * | GetInputAnalysisTree () |
TRestEvent * | GetInputEvent () |
Int_t | GetNextevtFunc (TRestEvent *targetevt, TRestAnalysisTree *targettree) |
Get next event and copy it to the address of targetevt. More... | |
int | GetNProcessedEvents () const |
int | GetNProcesses () const |
int | GetNThreads () const |
TRestAnalysisTree * | GetOutputAnalysisTree () |
TFile * | GetOutputDataFile () |
std::string | GetProcInfo (std::string infoname) |
double | GetReadingSpeed () |
ProcStatus | GetStatus () const |
void | InitFromConfigFile () override |
To make settings from rml file. This method must be implemented in the derived class. More... | |
void | Initialize () override |
REST run class. More... | |
TRestEventProcess * | InstantiateProcess (TString type, TiXmlElement *ele) |
InstantiateProcess in sequential start up. More... | |
std::string | MakeProgressBar (int progress100, int length=100) |
Make a string of progress bar with given length and percentage. More... | |
void | MergeOutputFile () |
Calls TRestRun::MergeOutputFile() to merge the main file with process's tmp file. More... | |
void | PauseMenu () |
A pause menu providing some functions during the process. More... | |
void | PrintMetadata () override |
Implemented it in the derived metadata class to print out specific metadata information. More... | |
void | PrintProcessedEvents (Int_t rateE) |
Print number of events processed, file read speed, ETA and a progress bar. More... | |
Int_t | ReadConfig (const std::string &keydeclare, TiXmlElement *e) |
method to deal with iterated child elements More... | |
void | ReadProcInfo () |
Create a process info list which used called by TRestRun::FormFormat(). More... | |
void | ResetRunTimes () |
Reset running time count to 0. More... | |
void | RunProcess () |
The main executer of event process. More... | |
bool | UseTestRun () const |
void | WriteProcessesMetadata () |
Write process metadata to fOutputDataFile. More... | |
Public Member Functions inherited from TRestMetadata | |
void | AddLog (std::string log="", bool print=true) |
Add logs to messageBuffer. More... | |
void | DoNotStore () |
If this method is called the metadata information will not be stored in disk. More... | |
TVector2 | Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1)) |
TVector3 | Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1)) |
TString | GetCommit () |
Returns the REST commit value stored in fCommit. More... | |
std::string | GetConfigBuffer () |
Returns the config section of this class. More... | |
std::string | GetDataMemberValue (std::string memberName) |
Get the value of data member as string. More... | |
std::vector< std::string > | GetDataMemberValues (std::string memberName, Int_t precision=0) |
Get the value of datamember as a vector of strings. More... | |
TString | GetDataPath () |
Returns a std::string with the path used for data storage. More... | |
Double_t | GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL) |
Gets the value of the parameter name parName, after applying unit conversion. More... | |
Bool_t | GetError () const |
It returns true if an error was identified by a derived metadata class. More... | |
TString | GetErrorMessage () |
Returns a std::string containing the error message. More... | |
TString | GetLibraryVersion () |
Returns the REST libraty version stored in fLibraryVersion. More... | |
TString | GetMainDataPath () |
Gets a std::string with the path used for data storage. More... | |
Int_t | GetNumberOfErrors () const |
Int_t | GetNumberOfWarnings () const |
std::string | GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR) |
Returns corresponding REST Metadata parameter from multiple sources. More... | |
std::string | GetSectionName () |
Returns the section name of this class, defined at the beginning of fSectionName. More... | |
TRestStringOutput::REST_Verbose_Level | GetVerboseLevel () |
returns the verboselevel in type of REST_Verbose_Level enumerator More... | |
TString | GetVerboseLevelString () |
returns the verbose level in type of TString More... | |
TString | GetVersion () |
Returns the REST version stored in fVersion. More... | |
Int_t | GetVersionCode () |
UInt_t | GetVersionMajor () const |
UInt_t | GetVersionMinor () const |
UInt_t | GetVersionPatch () const |
Bool_t | GetWarning () const |
It returns true if an error was identified by a derived metadata class. More... | |
TString | GetWarningMessage () |
Returns a std::string containing the warning message. More... | |
virtual void | Initialize () |
Making default settings. More... | |
TRestMetadata * | InstantiateChildMetadata (int index, std::string pattern="") |
This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the index given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More... | |
TRestMetadata * | InstantiateChildMetadata (std::string pattern="", std::string name="") |
This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the name given by argument. More... | |
Bool_t | isCleanState () const |
Bool_t | isOfficialRelease () const |
Int_t | LoadConfigFromBuffer () |
Initialize data from a string element buffer. More... | |
Int_t | LoadConfigFromElement (TiXmlElement *eSectional, TiXmlElement *eGlobal, std::map< std::string, std::string > envs={}) |
Main starter method. More... | |
Int_t | LoadConfigFromFile (const std::string &configFilename, const std::string §ionName="") |
Give the file name, find out the corresponding section. Then call the main starter. More... | |
virtual void | Merge (const TRestMetadata &) |
TRestMetadata & | operator= (const TRestMetadata &) |
void | Print () |
Implementing TObject::Print() method. More... | |
void | PrintConfigBuffer () |
Print the config xml section stored in the class. More... | |
void | PrintMessageBuffer () |
Print the buffered message. More... | |
virtual void | PrintMetadata () |
Implemented it in the derived metadata class to print out specific metadata information. More... | |
void | PrintTimeStamp (Double_t timeStamp) |
Print the current time on local machine. More... | |
void | SetConfigFile (std::string configFilename) |
set config file path from external More... | |
void | SetError (std::string message="", bool print=true, int maxPrint=5) |
A metadata class may use this method to signal that something went wrong. More... | |
void | SetHostmgr (TRestManager *m) |
Set the host manager for this class. More... | |
void | SetSectionName (std::string sName) |
set the section name, clear the section content More... | |
void | SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v) |
sets the verbose level More... | |
void | SetWarning (std::string message="", bool print=true, int maxPrint=5) |
A metadata class may use this method to signal that something went wrong. More... | |
void | Store () |
If this method is called the metadata information will be stored in disk. More... | |
TRestMetadata (const TRestMetadata &) | |
virtual void | UpdateMetadataMembers () |
Method to allow implementation of specific metadata members updates at inherited classes. More... | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
overwriting the write() method with fStore considered More... | |
void | WriteConfigBuffer (std::string fName) |
Writes the config buffer to a file in append mode. More... | |
~TRestMetadata () | |
TRestMetadata default destructor. More... | |
Private Attributes | |
TRestAnalysisTree * | fAnalysisTree |
Int_t | fEventsToProcess |
TTree * | fEventTree |
Int_t | fFileCompression |
Long64_t | fFileSplitSize |
Int_t | fFirstEntry |
Bool_t | fInputAnalysisStorage |
TRestEvent * | fInputEvent |
Bool_t | fInputEventStorage |
Int_t | fNBranches |
Int_t | fNFilesSplit |
Bool_t | fOutputAnalysisStorage |
TFile * | fOutputDataFile |
TString | fOutputDataFileName |
the TFile pointer being used More... | |
TRestEvent * | fOutputEvent |
Bool_t | fOutputEventStorage |
Int_t | fProcessedEvents |
std::map< std::string, std::string > | fProcessInfo |
Int_t | fProcessNumber |
ProcStatus | fProcStatus |
TRestRun * | fRunInfo |
Bool_t | fSortOutputEvents |
Int_t | fThreadNumber |
std::vector< TRestThread * > | fThreads |
Bool_t | fUsePauseMenu |
Bool_t | fUseTestRun |
Number of files being split. More... | |
Bool_t | fValidateObservables |
Additional Inherited Members | |
Protected Member Functions inherited from TRestMetadata | |
std::string | ElementToString (TiXmlElement *ele) |
Convert an TiXmlElement object to string. More... | |
TVector2 | Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1)) |
TVector3 | Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1)) |
Double_t | GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL) |
TiXmlElement * | GetElement (std::string eleDeclare, TiXmlElement *e=nullptr) |
Get an xml element from a given parent element, according to its declaration. More... | |
TiXmlElement * | GetElementFromFile (std::string configFilename, std::string NameOrDecalre="") |
Open an xml encoded file and find its element. More... | |
TiXmlElement * | GetElementWithName (std::string eleDeclare, std::string eleName) |
Get an xml element from the default location, according to its declaration and its field "name". More... | |
TiXmlElement * | GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e) |
Get an xml element from a given parent element, according to its declaration and its field "name". More... | |
std::string | GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0) |
Gets field value in an xml element string by parsing it as TiXmlElement. More... | |
std::string | GetFieldValue (std::string parName, TiXmlElement *e) |
Returns the field value of an xml element which has the specified name. More... | |
std::string | GetKEYDefinition (std::string keyName) |
Gets the first key definition for keyName found inside buffer starting at fromPosition. More... | |
std::string | GetKEYDefinition (std::string keyName, size_t &Position) |
std::string | GetKEYDefinition (std::string keyName, size_t &Position, std::string buffer) |
std::string | GetKEYDefinition (std::string keyName, std::string buffer) |
std::string | GetKEYStructure (std::string keyName) |
Gets the first key structure for keyName found inside buffer after fromPosition. More... | |
std::string | GetKEYStructure (std::string keyName, size_t &Position) |
std::string | GetKEYStructure (std::string keyName, size_t &Position, std::string buffer) |
std::string | GetKEYStructure (std::string keyName, size_t &Position, TiXmlElement *ele) |
std::string | GetKEYStructure (std::string keyName, std::string buffer) |
TiXmlElement * | GetNextElement (TiXmlElement *e) |
Get the next sibling xml element of this element, with same eleDeclare. More... | |
std::string | GetParameter (std::string parName, size_t &pos, std::string inputString) |
Returns the value for the parameter name parName found in inputString. More... | |
std::string | GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR) |
Returns the value for the parameter named parName in the given section. More... | |
std::pair< std::string, std::string > | GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr) |
Returns the unit string of the given parameter of the given xml section. More... | |
std::map< std::string, std::string > | GetParametersList () |
It retrieves a map of all parameter:value found in the metadata class. More... | |
TString | GetSearchPath () |
virtual void | InitFromConfigFile () |
To make settings from rml file. This method must be implemented in the derived class. More... | |
virtual void | InitFromRootFile () |
Method called after the object is retrieved from root file. More... | |
virtual Int_t | LoadSectionMetadata () |
This method does some preparation of xml section. More... | |
void | ReadAllParameters () |
Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More... | |
void | ReadParametersList (std::map< std::string, std::string > &list) |
It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. More... | |
std::string | ReplaceConstants (const std::string buffer) |
Identifies "constants" in the input buffer, and replace them with corresponding value. More... | |
std::string | ReplaceVariables (const std::string buffer) |
Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More... | |
void | ReSetVersion () |
Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. More... | |
std::string | SearchFile (std::string filename) |
Search files in current directory and directories specified in "searchPath" section. More... | |
void | SetLibraryVersion (TString version) |
Set the library version of this metadata class. More... | |
TiXmlElement * | StringToElement (std::string definition) |
Parsing a string into TiXmlElement object. More... | |
TRestMetadata () | |
TRestMetadata default constructor. More... | |
TRestMetadata (const char *configFilename) | |
constructor More... | |
void | UnSetVersion () |
Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. More... | |
Protected Attributes inherited from TRestMetadata | |
std::string | configBuffer |
The buffer where the corresponding metadata section is stored. Filled only during Write() More... | |
std::string | fConfigFileName |
Full name of the rml file. More... | |
std::map< std::string, std::string > | fConstants |
Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only. More... | |
TiXmlElement * | fElement |
Saving the sectional element together with global element. More... | |
TiXmlElement * | fElementGlobal |
Saving the global element, to be passed to the resident class, if necessary. More... | |
Bool_t | fError = false |
It can be used as a way to identify that something went wrong using SetError method. More... | |
TString | fErrorMessage = "" |
A std::string to store an optional error message through method SetError. More... | |
TRestManager * | fHostmgr |
All metadata classes can be initialized and managed by TRestManager. More... | |
Int_t | fNErrors = 0 |
It counts the number of errors notified. More... | |
Int_t | fNWarnings = 0 |
It counts the number of warnings notified. More... | |
std::string | fSectionName |
Section name given in the constructor of the derived metadata class. More... | |
Bool_t | fStore |
This variable is used to determine if the metadata structure should be stored in the ROOT file. More... | |
std::map< std::string, std::string > | fVariables |
Saving a list of rml variables. name-value std::pair. More... | |
TRestStringOutput::REST_Verbose_Level | fVerboseLevel |
Verbose level used to print debug info. More... | |
Bool_t | fWarning = false |
It can be used as a way to identify that something went wrong using SetWarning method. More... | |
TString | fWarningMessage = "" |
It can be used as a way to identify that something went wrong using SetWarning method. More... | |
std::string | messageBuffer |
The buffer to store the output message through TRestStringOutput in this class. More... | |
endl_t | RESTendl |
Termination flag object for TRestStringOutput. More... | |
TRestProcessRunner::TRestProcessRunner | ( | ) |
Definition at line 66 of file TRestProcessRunner.cxx.
TRestProcessRunner::~TRestProcessRunner | ( | ) |
Definition at line 68 of file TRestProcessRunner.cxx.
void TRestProcessRunner::BeginOfInit | ( | ) |
Reads information from rml config file.
It first checks if a friendly TRestRun object is initialized in TRestManager, if so, it reads the following configuration items:
Definition at line 114 of file TRestProcessRunner.cxx.
void TRestProcessRunner::ConfigOutputFile | ( | ) |
Forming an output file.
Merge all the process's file together, write TRestRun metadata, and then save process metadata to that file
Definition at line 951 of file TRestProcessRunner.cxx.
void TRestProcessRunner::EndOfInit | ( | ) |
Ending of the startup procedure.
It first sets input event as the first event in process chain, and then do a Validation of the process chain. Finally it calls ReadProcInfo() and create a process info list
Definition at line 282 of file TRestProcessRunner.cxx.
void TRestProcessRunner::FillThreadEventFunc | ( | TRestThread * | t | ) |
Calling back the FillEvent() method in TRestThread.
This method is locked by mutex. There can never be two of it running simultaneously in two threads. As a result threads will not write their files together, thus preventing segmentaion violation.
Definition at line 792 of file TRestProcessRunner.cxx.
|
inline |
Definition at line 124 of file TRestProcessRunner.h.
TRestAnalysisTree * TRestProcessRunner::GetInputAnalysisTree | ( | ) |
Definition at line 1172 of file TRestProcessRunner.cxx.
TRestEvent * TRestProcessRunner::GetInputEvent | ( | ) |
Definition at line 1170 of file TRestProcessRunner.cxx.
Int_t TRestProcessRunner::GetNextevtFunc | ( | TRestEvent * | targetevt, |
TRestAnalysisTree * | targettree | ||
) |
Get next event and copy it to the address of targetevt.
If can, it will also set the observal value of targettree according to the local analysis tree.
This method is locked by mutex. There can never be two of it running simultaneously in two threads.
If there is a single thread process, the local input event will be set to the out put of this process. The targettree will not be changed.
If not, the local input event and analysis tree will be updated after calling TTree::GetEntry(). The observables in the local tree will be copyed to the targettree.
Finally the data in the input event will get cloned to the targetevt by root streamer.
If the current entry is the last entry of the input tree, or the single thread process stops to give a concret pointer as the output, the process is over. This method returns -1.
Definition at line 759 of file TRestProcessRunner.cxx.
|
inline |
Definition at line 120 of file TRestProcessRunner.h.
|
inline |
Definition at line 119 of file TRestProcessRunner.h.
|
inline |
Definition at line 118 of file TRestProcessRunner.h.
|
inline |
Definition at line 113 of file TRestProcessRunner.h.
|
inline |
Definition at line 114 of file TRestProcessRunner.h.
|
inline |
Definition at line 115 of file TRestProcessRunner.h.
double TRestProcessRunner::GetReadingSpeed | ( | ) |
Definition at line 1062 of file TRestProcessRunner.cxx.
|
inline |
Definition at line 123 of file TRestProcessRunner.h.
|
inlineoverridevirtual |
To make settings from rml file. This method must be implemented in the derived class.
Reimplemented from TRestMetadata.
Definition at line 73 of file TRestProcessRunner.h.
|
overridevirtual |
REST run class.
Setting default values of class' data member.
Reimplemented from TRestMetadata.
Definition at line 73 of file TRestProcessRunner.cxx.
TRestEventProcess * TRestProcessRunner::InstantiateProcess | ( | TString | type, |
TiXmlElement * | ele | ||
) |
InstantiateProcess in sequential start up.
It instantiates a the object by the method TClass::GetClass(), giving it type name. Then it asks the process object to LoadConfigFromFile() with an xml section.
Definition at line 1049 of file TRestProcessRunner.cxx.
string TRestProcessRunner::MakeProgressBar | ( | int | progress100, |
int | length = 100 |
||
) |
Make a string of progress bar with given length and percentage.
Definition at line 1158 of file TRestProcessRunner.cxx.
void TRestProcessRunner::MergeOutputFile | ( | ) |
Calls TRestRun::MergeOutputFile() to merge the main file with process's tmp file.
After this operation, fOutputDataFile will be set to TRestRun's output file
Definition at line 1006 of file TRestProcessRunner.cxx.
void TRestProcessRunner::PauseMenu | ( | ) |
A pause menu providing some functions during the process.
It can:
Definition at line 554 of file TRestProcessRunner.cxx.
|
overridevirtual |
Implemented it in the derived metadata class to print out specific metadata information.
Prints metadata content on screen. Usually overloaded by the derived metadata class.
Reimplemented from TRestMetadata.
Definition at line 1174 of file TRestProcessRunner.cxx.
void TRestProcessRunner::PrintProcessedEvents | ( | Int_t | rateE | ) |
Print number of events processed, file read speed, ETA and a progress bar.
Definition at line 1073 of file TRestProcessRunner.cxx.
Int_t TRestProcessRunner::ReadConfig | ( | const std::string & | keydeclare, |
TiXmlElement * | e | ||
) |
method to deal with iterated child elements
If child element is declared as "addProcess", then multiple new process will be instantiated using sequential startup method, by calling InstantiateProcess() The processes will be added into each TRestThread instance. If the process is external process, then it will be sent to TRestRun.
Definition at line 213 of file TRestProcessRunner.cxx.
void TRestProcessRunner::ReadProcInfo | ( | ) |
Create a process info list which used called by TRestRun::FormFormat().
Items: FirstProcess, LastProcess, ProcNumber
Definition at line 314 of file TRestProcessRunner.cxx.
void TRestProcessRunner::ResetRunTimes | ( | ) |
Reset running time count to 0.
Definition at line 1033 of file TRestProcessRunner.cxx.
void TRestProcessRunner::RunProcess | ( | ) |
The main executer of event process.
Things doing in this method:
!!!!!!!!!!!Important!!!!!!!!!!!!
Definition at line 342 of file TRestProcessRunner.cxx.
|
inline |
Definition at line 122 of file TRestProcessRunner.h.
void TRestProcessRunner::WriteProcessesMetadata | ( | ) |
Write process metadata to fOutputDataFile.
Definition at line 989 of file TRestProcessRunner.cxx.
|
private |
Definition at line 43 of file TRestProcessRunner.h.
|
private |
Definition at line 60 of file TRestProcessRunner.h.
|
private |
indicates the name of the first file created as output data file. The actual output file maybe changed if tree is too large
Definition at line 42 of file TRestProcessRunner.h.
|
private |
Definition at line 64 of file TRestProcessRunner.h.
|
private |
Definition at line 63 of file TRestProcessRunner.h.
|
private |
Definition at line 59 of file TRestProcessRunner.h.
|
private |
Definition at line 53 of file TRestProcessRunner.h.
|
private |
Definition at line 34 of file TRestProcessRunner.h.
|
private |
Definition at line 54 of file TRestProcessRunner.h.
|
private |
Definition at line 45 of file TRestProcessRunner.h.
|
private |
Definition at line 46 of file TRestProcessRunner.h.
|
private |
Definition at line 56 of file TRestProcessRunner.h.
|
private |
Definition at line 39 of file TRestProcessRunner.h.
|
private |
the TFile pointer being used
Definition at line 40 of file TRestProcessRunner.h.
|
private |
Definition at line 35 of file TRestProcessRunner.h.
|
private |
Definition at line 55 of file TRestProcessRunner.h.
|
private |
Definition at line 61 of file TRestProcessRunner.h.
|
private |
Definition at line 65 of file TRestProcessRunner.h.
|
private |
Definition at line 58 of file TRestProcessRunner.h.
|
private |
Definition at line 44 of file TRestProcessRunner.h.
|
private |
Definition at line 31 of file TRestProcessRunner.h.
|
private |
Definition at line 52 of file TRestProcessRunner.h.
|
private |
Definition at line 57 of file TRestProcessRunner.h.
|
private |
Definition at line 38 of file TRestProcessRunner.h.
|
private |
Definition at line 50 of file TRestProcessRunner.h.
|
private |
Number of files being split.
Definition at line 49 of file TRestProcessRunner.h.
|
private |
Definition at line 51 of file TRestProcessRunner.h.