TRestRawToSignalProcess Class Reference

Detailed Description

A base class for any process reading a binary external file as input to REST.

The TRestRawToSignalProcess ... is NOT documented.

DOCUMENTATION TO BE WRITTEN (main description, methods, data members)

---

Warning

⚠ REST is under continous 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:

2015-June: First implementation of abstract class for binary format reading Juanan Garcia

Author

Juanan Garcia

---

Definition at line 30 of file TRestRawToSignalProcess.h.

#include <TRestRawToSignalProcess.h>

Inheritance diagram for TRestRawToSignalProcess:

Public Member Functions
virtual Bool_t	AddInputFile (const std::string &file) override
	ClassDefOverride (TRestRawToSignalProcess, 1)
virtual std::string	GetElectronicsType () const
RESTValue	GetInputEvent () const override
	Get pointer to input event. Must be implemented in the derived class.
RESTValue	GetOutputEvent () const override
	Get pointer to output event. Must be implemented in the derived class.
TRestMetadata *	GetProcessMetadata () const
Long64_t	GetTotalBytes () const override
Long64_t	GetTotalBytesRead () const override
	Interface to external file reading, get the read bytes. To be implemented in external processes.
Bool_t	GoToNextFile ()
void	Initialize () override
	Making default settings.
virtual void	InitProcess () override
	To be executed at the beginning of the run (outside event loop)
void	LoadConfig (const std::string &configFilename, const std::string &name="")
Bool_t	OpenInputFiles (const std::vector< std::string > &files) override
virtual void	PrintMetadata () override
	Implemented it in the derived metadata class to print out specific metadata information. More...
Bool_t	ResetEntry () override
void	SetRunOrigin (Int_t runOrigin)
void	SetSubRunOrigin (Int_t subRunOrigin)
	TRestRawToSignalProcess (const char *configFilename)
Public Member Functions inherited from TRestEventProcess
bool	ApplyCut ()
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()
virtual void	EndProcess ()
	To be executed at the end of the run (outside event loop)
TRestAnalysisTree *	GetAnalysisTree () const
	Return the local analysis tree (dummy)
TCanvas *	GetCanvas () const
	Get canvas.
TRestAnalysisTree *	GetFullAnalysisTree ()
std::vector< std::string >	GetListOfAddedObservables ()
virtual const char *	GetProcessName () const =0
TRestRun *	GetRunInfo () const
	Return the pointer of the hosting TRestRun object.
Bool_t	isExternal () const
	Return whether this process is external process.
Int_t	LoadSectionMetadata () override
	This method does some preparation of xml section. More...
virtual void	NotifyAnalysisTreeReset ()
	In case the analysis tree is reset(switched to new file), some process needs to have action.
virtual TRestEvent *	ProcessEvent (TRestEvent *inputEvent)=0
	Process one event.
std::vector< std::string >	ReadObservables ()
void	RegisterAllObservables (Bool_t value=true)
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 ()
Public Member Functions inherited from TRestMetadata
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. 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.
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.
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. More...
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 More...
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. 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 &sectionName="")
	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. More...
void	PrintMessageBuffer ()
	Print the buffered message.
void	PrintTimeStamp (Double_t timeStamp)
	Print the current time on local machine. More...
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.

Protected Member Functions
void	InitFromConfigFile () override
	To make settings from rml file. This method must be implemented in the derived class.
void	LoadDefaultConfig ()
Protected Member Functions inherited from TRestEventProcess
void	BeginPrintProcess ()
	[name, cut range]
void	CreateCanvas ()
	Create the canvas.
void	EndPrintProcess ()
TRestEventProcess *	GetFriend (const std::string &nameOrType)
TRestEventProcess *	GetFriendLive (const std::string &nameOrType)
template<class T >
T *	GetMetadata ()
	Get a metadata object from the host TRestRun. More...
TRestMetadata *	GetMetadata (const std::string &nameOrType)
size_t	GetNumberOfParallelProcesses () const
template<class T >
T	GetObservableValue (const std::string &name)
TRestEventProcess *	GetParallel (int i)
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. More...
template<class T >
void	SetObservableValue (const std::string &name, const T &value)
	Set observable value for AnalysisTree. More...
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.
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".
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. 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.
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.
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. 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.
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.
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.
TiXmlElement *	StringToElement (std::string definition)
	Parsing a string into TiXmlElement object. More...
	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.

Protected Attributes
std::string	fElectronicsType
bool	fgKeepFileOpen
FILE *	fInputBinFile
std::vector< std::string >	fInputFileNames
std::vector< FILE * >	fInputFiles
Int_t	fMinPoints
unsigned int	frameBits
Int_t	fRunOrigin
Int_t	fShowSamples
	true if need to open all raw files at the beginning
TRestRawSignalEvent *	fSignalEvent = nullptr
Int_t	fSubRunOrigin
Int_t	iCurFile
Int_t	nFiles
unsigned int	payload
Long64_t	totalBytes
Long64_t	totalBytesReaded
Double_t	tStart
Protected Attributes inherited from TRestEventProcess
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. More...
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. More...
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.
Protected Attributes inherited from TRestMetadata
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. 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.
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.

Additional Inherited Members
Protected Types inherited from TRestEventProcess
enum	REST_Process_Output { No_Output , Observable , Internal_Var , Full_Output }

Member Function Documentation

GetTotalBytes()

Long64_t TRestRawToSignalProcess::GetTotalBytes ( ) const

inlineoverridevirtual

Interface to external file reading, get the total bytes of input binary file. To be implemented in external processes.

Reimplemented from TRestEventProcess.

Definition at line 84 of file TRestRawToSignalProcess.h.

PrintMetadata()

void TRestRawToSignalProcess::PrintMetadata ( )

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.

Reimplemented in TRestRawBiPoToSignalProcess.

Definition at line 198 of file TRestRawToSignalProcess.cxx.

---

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

• TRestRawToSignalProcess.h
• TRestRawToSignalProcess.cxx