Detailed Description

A base class for any axion event process. Defines position, rotation and component displacement.

TOBE written

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2022-March: First concept. Javier Galan

Definition at line 30 of file TRestAxionEventProcess.h.

#include <TRestAxionEventProcess.h>

Inheritance diagram for TRestAxionEventProcess:

Public Member Functions
virtual void	BeginOfEventProcess (TRestEvent *evInput=nullptr) override
	Begin of event process, preparation work. Called right before ProcessEvent() More...

	ClassDefOverride (TRestAxionEventProcess, 3)

virtual void	EndOfEventProcess (TRestEvent *evInput=nullptr) override
	End of event process. Called directly after ProcessEvent() More...

RESTValue	GetInputEvent () const override
	Get pointer to input event. Must be implemented in the derived class. More...

RESTValue	GetOutputEvent () const override
	Get pointer to output event. Must be implemented in the derived class. More...

virtual void	InitProcess () override
	To be executed at the beginning of the run (outside event loop) More...

virtual void	PrintMetadata () override
	It prints out the process parameters stored in the metadata structure. More...

	TRestAxionEventProcess ()

	~TRestAxionEventProcess ()

Public Member Functions inherited from TRestEventProcess
virtual Bool_t	AddInputFile (const std::string &file)

bool	ApplyCut ()

virtual void	BeginOfEventProcess (TRestEvent *inputEvent=nullptr)
	Begin of event process, preparation work. Called right before ProcessEvent() More...

	ClassDefOverride (TRestEventProcess, 3)

virtual void	EndOfEventProcess (TRestEvent *inputEvent=nullptr)
	End of event process. Nothing to do. Called directly after ProcessEvent() More...

virtual void	EndProcess ()
	To be executed at the end of the run (outside event loop) More...

TRestAnalysisTree *	GetAnalysisTree () const
	Return the local analysis tree (dummy) More...

TCanvas *	GetCanvas () const
	Get canvas. More...

TRestAnalysisTree *	GetFullAnalysisTree ()

virtual RESTValue	GetInputEvent () const =0
	Get pointer to input event. Must be implemented in the derived class. More...

std::vector< std::string >	GetListOfAddedObservables ()

virtual RESTValue	GetOutputEvent () const =0
	Get pointer to output event. Must be implemented in the derived class. More...

virtual const char *	GetProcessName () const =0

TRestRun *	GetRunInfo () const
	Return the pointer of the hosting TRestRun object. More...

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. More...

virtual void	InitFromConfigFile () override
	To make settings from rml file. This method must be implemented in the derived class. More...

virtual void	InitProcess ()
	To be executed at the beginning of the run (outside event loop) More...

Bool_t	isExternal () const
	Return whether this process is external process. More...

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. More...

virtual Bool_t	OpenInputFiles (const std::vector< std::string > &files)

virtual TRestEvent *	ProcessEvent (TRestEvent *inputEvent)=0
	Process one event. More...

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. More...

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. More...

Bool_t	singleThreadOnly () const
	Return whether this process is single std::thread only. More...

	TRestEventProcess ()

	~TRestEventProcess ()

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 &sectionName="")
	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...

Protected Member Functions
void	BeginPrintProcess ()
	Pre-defined printer, can be used at the beginning in the implementation of PrintMetadata() More...

void	EndPrintProcess ()
	Adds the footer for PrintMetadata. More...

TVector3	GetCenter () const

Protected Member Functions inherited from TRestEventProcess
void	BeginPrintProcess ()
	[name, cut range]

void	CreateCanvas ()
	Create the canvas. More...

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. 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
TRestAxionEvent *	fAxionEvent
	A pointer to the specific TRestAxionEvent. More...

Protected Attributes inherited from TRestEventProcess
TRestAnalysisTree *	fAnalysisTree = nullptr

TCanvas *	fCanvas = nullptr
	< Canvas for some viewer event More...

TVector2	fCanvasSize
	Canvas size. More...

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. More...

bool	fIsExternal = false
	It defines if the process reads event data from an external source. More...

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. More...

bool	fReadOnly = false
	not used, keep for compatibility More...

TRestRun *	fRunInfo = nullptr
	< Pointer to TRestRun object where to find metadata. More...

bool	fSingleThreadOnly = false

bool	fValidateObservables = false
	It defines if observable names should be added to the validation list. 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...

Private Attributes
Double_t	fExternalPitch = 0
	The rotation angle around CenterSetup with respect to X-axis. More...

TVector3	fExternalRotationCenter = TVector3(0, 0, 0)
	The position (different than the center of the object) around which the rotation will be applied. More...

Double_t	fExternalYaw = 0
	The rotation angle around CenterSetup with respect to the Y-axis. More...

Double_t	fInternalPitch = 0
	The rotation angle with respect to X-axis. More...

Double_t	fInternalYaw = 0
	The rotation angle with respect to the Y-axis. More...

Bool_t	fLocalAxis = true
	If enabled it skips the end rotation that recovers the original axion trajectory direction. More...

TVector3	fPosition = TVector3(0, 0, 0)
	The position of the component around which the rotation will be applied. More...

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

Constructor & Destructor Documentation

◆ TRestAxionEventProcess()

TRestAxionEventProcess::TRestAxionEventProcess ( )

TRestAxionEventProcess default constructor

Definition at line 50 of file TRestAxionEventProcess.cxx.

◆ ~TRestAxionEventProcess()

TRestAxionEventProcess::~TRestAxionEventProcess ( )

TRestAxionEventProcess destructor

Definition at line 55 of file TRestAxionEventProcess.cxx.

Member Function Documentation

◆ BeginOfEventProcess()

void TRestAxionEventProcess::BeginOfEventProcess ( TRestEvent * inEv = nullptr )

overridevirtual

Begin of event process, preparation work. Called right before ProcessEvent()

This method is called before calling ProcessEvent(). We initialize the process's output event if not null and not same as input event. The event's basic info (ID, timestamp, etc.) will also be set to the same as input event

Reimplemented from TRestEventProcess.

Definition at line 64 of file TRestAxionEventProcess.cxx.

◆ BeginPrintProcess()

void TRestAxionEventProcess::BeginPrintProcess ( )

protected

Pre-defined printer, can be used at the beginning in the implementation of PrintMetadata()

Prints process type, name, title, verboselevel, outputlevel, input/output event type, and several separators

Definition at line 121 of file TRestAxionEventProcess.cxx.

◆ EndOfEventProcess()

void TRestAxionEventProcess::EndOfEventProcess ( TRestEvent * evInput = nullptr )

overridevirtual

End of event process. Called directly after ProcessEvent()

End of event process. Validate the updated observable number matches total defined observable number.

Reimplemented from TRestEventProcess.

Definition at line 91 of file TRestAxionEventProcess.cxx.

◆ EndPrintProcess()

void TRestAxionEventProcess::EndPrintProcess ( )

protected

Adds the footer for PrintMetadata.

Definition at line 150 of file TRestAxionEventProcess.cxx.

◆ GetCenter()

TVector3 TRestAxionEventProcess::GetCenter ( ) const

inlineprotected

Definition at line 60 of file TRestAxionEventProcess.h.

◆ GetInputEvent()

RESTValue TRestAxionEventProcess::GetInputEvent ( ) const

inlineoverridevirtual

Get pointer to input event. Must be implemented in the derived class.

Implements TRestEventProcess.

Reimplemented in TRestAxionFieldPropagationProcess.

Definition at line 63 of file TRestAxionEventProcess.h.

◆ GetOutputEvent()

RESTValue TRestAxionEventProcess::GetOutputEvent ( ) const

inlineoverridevirtual

Get pointer to output event. Must be implemented in the derived class.

Implements TRestEventProcess.

Reimplemented in TRestAxionFieldPropagationProcess.

Definition at line 64 of file TRestAxionEventProcess.h.

◆ InitProcess()

virtual void TRestAxionEventProcess::InitProcess ( )

inlineoverridevirtual

To be executed at the beginning of the run (outside event loop)

Reimplemented from TRestEventProcess.

Reimplemented in TRestAxionDeviationProcess, TRestAxionFieldPropagationProcess, TRestAxionOpticsProcess, TRestAxionTransmissionProcess, and TRestAxionTransportProcess.

Definition at line 66 of file TRestAxionEventProcess.h.

◆ PrintMetadata()

virtual void TRestAxionEventProcess::PrintMetadata ( )

inlineoverridevirtual

It prints out the process parameters stored in the metadata structure.

Reimplemented from TRestMetadata.

Reimplemented in TRestAxionDeviationProcess, TRestAxionFieldPropagationProcess, TRestAxionTransmissionProcess, and TRestAxionTransportProcess.

Definition at line 69 of file TRestAxionEventProcess.h.

Field Documentation

◆ fAxionEvent

TRestAxionEvent* TRestAxionEventProcess::fAxionEvent

protected

A pointer to the specific TRestAxionEvent.

Definition at line 55 of file TRestAxionEventProcess.h.

◆ fExternalPitch

Double_t TRestAxionEventProcess::fExternalPitch = 0

private

The rotation angle around CenterSetup with respect to X-axis.

Definition at line 48 of file TRestAxionEventProcess.h.

◆ fExternalRotationCenter

TVector3 TRestAxionEventProcess::fExternalRotationCenter = TVector3(0, 0, 0)

private

The position (different than the center of the object) around which the rotation will be applied.

Definition at line 42 of file TRestAxionEventProcess.h.

◆ fExternalYaw

Double_t TRestAxionEventProcess::fExternalYaw = 0

private

The rotation angle around CenterSetup with respect to the Y-axis.

Definition at line 45 of file TRestAxionEventProcess.h.

◆ fInternalPitch

Double_t TRestAxionEventProcess::fInternalPitch = 0

private

The rotation angle with respect to X-axis.

Definition at line 39 of file TRestAxionEventProcess.h.

◆ fInternalYaw

Double_t TRestAxionEventProcess::fInternalYaw = 0

private

The rotation angle with respect to the Y-axis.

Definition at line 36 of file TRestAxionEventProcess.h.

◆ fLocalAxis

Bool_t TRestAxionEventProcess::fLocalAxis = true

private

If enabled it skips the end rotation that recovers the original axion trajectory direction.

Definition at line 51 of file TRestAxionEventProcess.h.

◆ fPosition

TVector3 TRestAxionEventProcess::fPosition = TVector3(0, 0, 0)

private

The position of the component around which the rotation will be applied.

Definition at line 33 of file TRestAxionEventProcess.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestAxionEventProcess()

◆ ~TRestAxionEventProcess()

Member Function Documentation

◆ BeginOfEventProcess()

◆ BeginPrintProcess()

◆ EndOfEventProcess()

◆ EndPrintProcess()

◆ GetCenter()

◆ GetInputEvent()

◆ GetOutputEvent()

◆ InitProcess()

◆ PrintMetadata()

Field Documentation

◆ fAxionEvent

◆ fExternalPitch

◆ fExternalRotationCenter

◆ fExternalYaw

◆ fInternalPitch

◆ fInternalYaw

◆ fLocalAxis

◆ fPosition