The TRestEventTimeSelectionProcess allows processing of events that are within a certain time range. The time ranges are read from a file that contains the start and end times of the periods. The file should have the following format (it can have more columns separated by the same delimiter, but the first two columns should be the start and end times and all the other columns will be ignored):
The default delimiter is a comma, but it can be changed by setting the delimiter parameter (single character only). The time format is given by the accepted formats of the StringToTimeStamp function.
The time ranges can be active or dead periods of time. If the time ranges are active periods of time, the events that are within the time ranges will be selected. If the time ranges are dead periods of time, the events that are outside the time ranges will be selected. Set the isActiveTime parameter to true to select the events within the time ranges (they represent active periods of time) or to false to select the events outside the time ranges (they represent dead periods of time).
The number of events selected, rejected and the total time selected are stored in the metadata members. The total time selected is calculated as the sum of the time of all the time ranges, so it represents the total active time in the case of active periods of time, or the total dead time in the case of dead periods of time.
Parameters
- fileWithTimes: name of the file that contains the time ranges.
- isActiveTime: if true (default) the time ranges represent active periods of time, if false the time ranges represent dead periods of time.
- delimiter: delimiter used in the file with the time ranges (default is ,).
- offsetTimeInSeconds: offset time in seconds to be added to the event time (default is 0). This is useful to correct the time of the events if needed. This number of seconds will be added to the event time before checking if it is within the time ranges.
- startMarginTimeInSeconds: margin time in seconds to be added to the start time of the time ranges (default is 0). This is useful to consider the events that are close to the start time of the time ranges. Meant to be a positive number, as the process will take care of adding or subtracting it if the time ranges represent active or dead periods of time respectively.
- endMarginTimeInSeconds: margin time in seconds to be subtracted from the end time of the time ranges (default is 0). This is useful to consider the events that are close to the end time of the time ranges. Meant to be a positive number, as the process will take care of subtracting or adding it if the time ranges represent active or dead periods of time respectively.
useRunStartAndEndTimes: if true (default) the start and end times of the TRestRun will be used to restrict the time ranges to those involved (those that are between the run start and end times).
Observables
The process does not produce event observables but it keeps track of the number of events selected and rejected and the total time of the time ranges in the metadata members:
- nEventsRejected: number of events rejected.
- nEventsSelected: number of events selected.
Examples
Examples for rml files:
- Warning
- ** REST is under continuous development.** This documentation is offered to you by the REST community. Your HELP is needed to keep this code up to date. Your feedback will be worth to support this software, please report any problems/suggestions you may find while using it at The REST Framework forum. You are welcome to contribute fixing typos, updating information or adding/proposing new contributions. See also our Contribution Guide.
RESTsoft - Software for Rare Event Searches with TPCs
History of developments: 2025-Jan - First version of the code Alvaro Ezquerro
- Author
- Alvaro Ezquerro
Definition at line 32 of file TRestEventTimeSelectionProcess.h.
|
| void | ApplyEndRunTime (const TTimeStamp &runEndTime) |
| void | ApplyStartRunTime (const TTimeStamp &runStartTime) |
| Double_t | CalculateTotalTimeInSeconds () |
| | Function to calculate the total time in seconds of all the time ranges (active or dead periods of time). It takes into account the time offset, and both the start and end margins.
|
|
| ClassDefOverride (TRestEventTimeSelectionProcess, 2) |
| void | EndProcess () override |
| | Function to include required actions after all events have been processed.
|
| Char_t | GetDelimiter () const |
| std::string | GetFileWithTimes () const |
| RESTValue | GetInputEvent () const override |
| | Get pointer to input event. Must be implemented in the derived class.
|
| Bool_t | GetIsActiveTime () const |
| Int_t | GetNEventsRejected () const |
| Int_t | GetNEventsSelected () const |
| RESTValue | GetOutputEvent () const override |
| | Get pointer to output event. Must be implemented in the derived class.
|
| const char * | GetProcessName () const override |
| std::vector< Interval > | GetStartEndTimes () const |
| Long_t | GetTimeEndMarginInSeconds () const |
| Long_t | GetTimeOffsetInSeconds () const |
| std::string | GetTimeStampCut (std::string timeStampObsName="timeStamp", Bool_t useOffset=true, Bool_t useMargins=true, Int_t nTimes=-1) |
| | Function to get the cut string that reproduce the time selection done by this process (useful for TRestDataSet::MakeCut() for example).
|
| Long_t | GetTimeStartMarginInSeconds () const |
| Double_t | GetTotalTimeInSeconds () const |
| void | InitProcess () override |
| | Process initialization.
|
| void | PrintMetadata () override |
| | Prints on screen the process data members.
|
| TRestEvent * | ProcessEvent (TRestEvent *inputEvent) override |
| | The main processing event function.
|
| void | SetAsActiveTime () |
| void | SetAsDeadTime () |
| void | SetDelimiter (Char_t delimiter) |
| void | SetFileWithTimes (const std::string &fileWithTimes) |
| void | SetIsActiveTime (Bool_t isActiveTime) |
| void | SetStartEndTimes (const std::vector< Interval > &startEndTimes) |
| void | SetTimeEndMarginInSeconds (Long_t timeEndMarginInSeconds) |
| void | SetTimeOffsetInSeconds (Long_t timeOffsetInSeconds) |
| void | SetTimeStartMarginInSeconds (Long_t timeStartMarginInSeconds) |
| | TRestEventTimeSelectionProcess () |
| | Default constructor.
|
| virtual Bool_t | AddInputFile (const std::string &file) |
| bool | ApplyCut () |
| | Apply cut according to the cut conditions saved in fCut.
|
| virtual void | BeginOfEventProcess (TRestEvent *inputEvent=nullptr) |
| | Begin of event process, preparation work. Called right before ProcessEvent().
|
|
| ClassDefOverride (TRestEventProcess, 3) |
| virtual void | EndOfEventProcess (TRestEvent *inputEvent=nullptr) |
| | End of event process. Nothing to do. Called directly after ProcessEvent().
|
| TRestAnalysisTree * | GetAnalysisTree () const |
| | Return the local analysis tree (dummy).
|
| TCanvas * | GetCanvas () const |
| | Get canvas.
|
| TRestAnalysisTree * | GetFullAnalysisTree () |
| | Get the full analysis tree from TRestRun, with non-empty entries.
|
| std::vector< std::string > | GetListOfAddedObservables () |
| | Get list of observables, convert map to vector.
|
| TRestRun * | GetRunInfo () const |
| | Return the pointer of the hosting TRestRun object.
|
| virtual Long64_t | GetTotalBytes () const |
| virtual Long64_t | GetTotalBytesRead () const |
| | Interface to external file reading, get the read bytes. To be implemented in external processes.
|
| virtual void | InitFromConfigFile () override |
| | To make settings from rml file. This method must be implemented in the derived class.
|
| Bool_t | isExternal () const |
| | Return whether this process is external process.
|
| Int_t | LoadSectionMetadata () override |
| | Load extra section metadata: outputlevel after calling TRestMetadata::LoadSectionMetadata().
|
| virtual void | NotifyAnalysisTreeReset () |
| | In case the analysis tree is reset(switched to new file), some process needs to have action.
|
| virtual Bool_t | OpenInputFiles (const std::vector< std::string > &files) |
| | Interface to external file reading, open input file. To be implemented in external processes.
|
|
std::vector< std::string > | ReadObservables () |
| void | RegisterAllObservables (Bool_t value=true) |
| virtual Bool_t | ResetEntry () |
|
void | SetAnalysisTree (TRestAnalysisTree *tree) |
| | Set analysis tree of this process, then add observables to it.
|
| void | SetCanvasSize (Int_t x, Int_t y) |
| | Set canvas size.
|
| void | SetFriendProcess (TRestEventProcess *p) |
| | Add friendly process to this process.
|
| void | SetObservableValidation (bool validate) |
| void | SetParallelProcess (TRestEventProcess *p) |
| | Add parallel process to this process.
|
| void | SetRunInfo (TRestRun *r) |
| | Set TRestRun for this process.
|
| Bool_t | singleThreadOnly () const |
| | Return whether this process is single std::thread only.
|
| | TRestEventProcess () |
| | ~TRestEventProcess () |
| void | AddLog (std::string log="", bool print=true) |
| | Add logs to messageBuffer.
|
| void | DoNotStore () |
| | If this method is called the metadata information will not be stored in disk.
|
| 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.
|
| std::string | GetConfigBuffer () |
| | Returns the config section of this class.
|
| std::string | GetDataMemberValue (std::string memberName) |
| | Get the value of data member as string.
|
| std::vector< std::string > | GetDataMemberValues (std::string memberName, Int_t precision=0) |
| | Get the value of datamember as a vector of strings.
|
| TString | GetDataPath () |
| | Returns a std::string with the path used for data storage.
|
| 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.
|
| Bool_t | GetError () const |
| | It returns true if an error was identified by a derived metadata class.
|
| TString | GetErrorMessage () |
| | Returns a std::string containing the error message.
|
| TString | GetLibraryVersion () |
| | Returns the REST libraty version stored in fLibraryVersion.
|
| TString | GetMainDataPath () |
| | Gets a std::string with the path used for data storage.
|
| 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.
|
| std::string | GetSectionName () |
| | Returns the section name of this class, defined at the beginning of fSectionName.
|
| TRestStringOutput::REST_Verbose_Level | GetVerboseLevel () |
| | returns the verboselevel in type of REST_Verbose_Level enumerator
|
| TString | GetVerboseLevelString () |
| | returns the verbose level in type of TString
|
| TString | GetVersion () |
| | Returns the REST version stored in fVersion.
|
| 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.
|
| TString | GetWarningMessage () |
| | Returns a std::string containing the warning message.
|
| 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.
|
| 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.
|
| Bool_t | isCleanState () const |
| Bool_t | isOfficialRelease () const |
| Int_t | LoadConfigFromBuffer () |
| | Initialize data from a string element buffer.
|
| Int_t | LoadConfigFromElement (TiXmlElement *eSectional, TiXmlElement *eGlobal, std::map< std::string, std::string > envs={}) |
| | Main starter method.
|
| 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.
|
| virtual void | Merge (const TRestMetadata &) |
|
TRestMetadata & | operator= (const TRestMetadata &) |
| void | Print () |
| | Implementing TObject::Print() method.
|
| void | PrintConfigBuffer () |
| | Print the config xml section stored in the class.
|
| void | PrintMessageBuffer () |
| | Print the buffered message.
|
| void | PrintTimeStamp (Double_t timeStamp) |
| | Print the current time on local machine.
|
| void | SetConfigFile (std::string configFilename) |
| | set config file path from external
|
| void | SetError (std::string message="", bool print=true, int maxPrint=5) |
| | A metadata class may use this method to signal that something went wrong.
|
| void | SetHostmgr (TRestManager *m) |
| | Set the host manager for this class.
|
| void | SetSectionName (std::string sName) |
| | set the section name, clear the section content
|
| void | SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v) |
| | sets the verbose level
|
| void | SetWarning (std::string message="", bool print=true, int maxPrint=5) |
| | A metadata class may use this method to signal that something went wrong.
|
| void | Store () |
| | If this method is called the metadata information will be stored in disk.
|
| | TRestMetadata (const TRestMetadata &) |
| virtual void | UpdateMetadataMembers () |
| | Method to allow implementation of specific metadata members updates at inherited classes.
|
| virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
| | overwriting the write() method with fStore considered
|
| void | WriteConfigBuffer (std::string fName) |
| | Writes the config buffer to a file in append mode.
|
| | ~TRestMetadata () |
| | TRestMetadata default destructor.
|
|
| enum | REST_Process_Output { No_Output
, Observable
, Internal_Var
, Full_Output
} |
| void | BeginPrintProcess () |
| | [name, cut range]
|
| void | CreateCanvas () |
| | Create the canvas.
|
| void | EndPrintProcess () |
| | Pre-defined printer, can be used at the ending in the implementation of PrintMetadata().
|
| TRestEventProcess * | GetFriend (const std::string &nameOrType) |
| | Get friendly TRestEventProcess object.
|
| TRestEventProcess * | GetFriendLive (const std::string &nameOrType) |
| | Get friendly TRestEventProcess object.
|
| template<class T> |
| T * | GetMetadata () |
| | Get a metadata object from the host TRestRun.
|
| TRestMetadata * | GetMetadata (const std::string &nameOrType) |
| | Get a metadata object from the host TRestRun.
|
| size_t | GetNumberOfParallelProcesses () const |
| template<class T> |
| T | GetObservableValue (const std::string &name) |
| TRestEventProcess * | GetParallel (int i) |
| | Get a list of parallel processes from this process.
|
| template<class T> |
| std::vector< T > | GetParallelDataMembers (T *member_of_process) |
| | Get a list of data members from parallel processes which is same to this process's certain data member.
|
| template<class T> |
| void | SetObservableValue (const std::string &name, const T &value) |
| | Set observable value for AnalysisTree.
|
| std::string | ElementToString (TiXmlElement *ele) |
| | Convert an TiXmlElement object to string.
|
| 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.
|
| TiXmlElement * | GetElementFromFile (std::string configFilename, std::string NameOrDecalre="") |
| | Open an xml encoded file and find its element.
|
| TiXmlElement * | GetElementWithName (std::string eleDeclare, std::string eleName) |
| | Get an xml element from the default location, according to its declaration and its field "name".
|
| 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".
|
| 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.
|
| std::string | GetFieldValue (std::string parName, TiXmlElement *e) |
| | Returns the field value of an xml element which has the specified name.
|
| std::string | GetKEYDefinition (std::string keyName) |
| | Gets the first key definition for keyName found inside buffer starting at fromPosition.
|
| 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.
|
| 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.
|
| std::string | GetParameter (std::string parName, size_t &pos, std::string inputString) |
| | Returns the value for the parameter name parName found in inputString.
|
| 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.
|
| 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.
|
| std::map< std::string, std::string > | GetParametersList () |
| | It retrieves a map of all parameter:value found in the metadata class.
|
| TString | GetSearchPath () |
| virtual void | InitFromRootFile () |
| | Method called after the object is retrieved from root file.
|
| void | ReadAllParameters () |
| | Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement.
|
| void | ReadParametersList (std::map< std::string, std::string > &list) |
| | It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0.
|
| std::string | ReplaceConstants (const std::string buffer) |
| | Identifies "constants" in the input buffer, and replace them with corresponding value.
|
| std::string | ReplaceVariables (const std::string buffer) |
| | Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value.
|
| void | ReSetVersion () |
| | Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version.
|
| std::string | SearchFile (std::string filename) |
| | Search files in current directory and directories specified in "searchPath" section.
|
| void | SetLibraryVersion (TString version) |
| | Set the library version of this metadata class.
|
| TiXmlElement * | StringToElement (std::string definition) |
| | Parsing a string into TiXmlElement object.
|
| | TRestMetadata () |
| | TRestMetadata default constructor.
|
| | TRestMetadata (const char *configFilename) |
| | constructor
|
| void | UnSetVersion () |
| | Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version.
|
| TRestAnalysisTree * | fAnalysisTree = nullptr |
| TCanvas * | fCanvas = nullptr |
| | < Canvas for some viewer event
|
| TVector2 | fCanvasSize |
| | Canvas size.
|
| std::vector< std::pair< std::string, TVector2 > > | fCuts |
| | Stores cut definitions. Any listed observables should be in the range.
|
| bool | fDynamicObs = false |
| | It defines whether to use added observables only or all the observables appear in the code.
|
| bool | fIsExternal = false |
| | It defines if the process reads event data from an external source.
|
| std::map< std::string, int > | fObservablesDefined |
| | Stores the list of all the appeared process observables in the code.
|
| std::map< std::string, int > | fObservablesUpdated |
| | Stores the list of process observables updated when processing this event.
|
| bool | fReadOnly = false |
| | not used, keep for compatibility
|
| TRestRun * | fRunInfo = nullptr |
| | < Pointer to TRestRun object where to find metadata.
|
| bool | fSingleThreadOnly = false |
| bool | fValidateObservables = false |
| | It defines if observable names should be added to the validation list.
|
| std::string | configBuffer |
| | The buffer where the corresponding metadata section is stored. Filled only during Write().
|
| std::string | fConfigFileName |
| | Full name of the rml file.
|
| std::map< std::string, std::string > | fConstants |
| | Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only.
|
| TiXmlElement * | fElement |
| | Saving the sectional element together with global element.
|
| TiXmlElement * | fElementGlobal |
| | Saving the global element, to be passed to the resident class, if necessary.
|
| Bool_t | fError = false |
| | It can be used as a way to identify that something went wrong using SetError method.
|
| TString | fErrorMessage = "" |
| | A std::string to store an optional error message through method SetError.
|
| TRestManager * | fHostmgr |
| | All metadata classes can be initialized and managed by TRestManager.
|
| Int_t | fNErrors = 0 |
| | It counts the number of errors notified.
|
| Int_t | fNWarnings = 0 |
| | It counts the number of warnings notified.
|
| std::string | fSectionName |
| | Section name given in the constructor of the derived metadata class.
|
| Bool_t | fStore |
| | This variable is used to determine if the metadata structure should be stored in the ROOT file.
|
| std::map< std::string, std::string > | fVariables |
| | Saving a list of rml variables. name-value std::pair.
|
| TRestStringOutput::REST_Verbose_Level | fVerboseLevel |
| | Verbose level used to print debug info.
|
| Bool_t | fWarning = false |
| | It can be used as a way to identify that something went wrong using SetWarning method.
|
| TString | fWarningMessage = "" |
| | It can be used as a way to identify that something went wrong using SetWarning method.
|
| std::string | messageBuffer |
| | The buffer to store the output message through TRestStringOutput in this class.
|
| endl_t | RESTendl |
| | Termination flag object for TRestStringOutput.
|
1.15.0