REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Public Member Functions | Private Member Functions | Private Attributes
TRestAxionTransmissionProcess Class Reference

Detailed Description

A process to include photon transmission using a combination of TRestAxionXrayWindow definitions.

TRestAxionTransmissionProcess will serve to include photon transmission efficiency (or response) through different media before reaching the detection detector volume.


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2019-March: First implementation Javier Galan

Author

Definition at line 31 of file TRestAxionTransmissionProcess.h.

#include <TRestAxionTransmissionProcess.h>

Inheritance diagram for TRestAxionTransmissionProcess:
TRestAxionEventProcess TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestAxionTransmissionProcess, 1)
 
const char * GetProcessName () const override
 Returns the name of this process. More...
 
void InitFromConfigFile () override
 Function reading input parameters from the RML TRestAxionTransmissionProcess metadata section. More...
 
void InitProcess () override
 Process initialization. Data members that require initialization just before start processing should be initialized here. More...
 
void LoadConfig (std::string cfgFilename, std::string name="")
 Function to load the configuration from an external configuration file. More...
 
void PrintMetadata () override
 It prints out the process parameters stored in the metadata structure. More...
 
TRestEventProcessEvent (TRestEvent *evInput) override
 The main processing event function. More...
 
 TRestAxionTransmissionProcess ()
 Default constructor. More...
 
 TRestAxionTransmissionProcess (char *cfgFileName)
 Constructor loading data from a config file. More...
 
 ~TRestAxionTransmissionProcess ()
 Default destructor. More...
 
- Public Member Functions inherited from TRestAxionEventProcess
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...
 
TRestAnalysisTreeGetAnalysisTree () const
 Return the local analysis tree (dummy) More...
 
TCanvas * GetCanvas () const
 Get canvas. More...
 
TRestAnalysisTreeGetFullAnalysisTree ()
 
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
 
TRestRunGetRunInfo () 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 TRestEventProcessEvent (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 ()
 

Private Member Functions

void Initialize () override
 Function to initialize input/output event members and define the section name. More...
 
void LoadDefaultConfig ()
 Function to load the default config in absence of RML input. More...
 

Private Attributes

std::vector< std::string > fWindowNames
 The names of the metadata TRestAxionXrayWindow that will be combined for transmission. More...
 
std::vector< TRestAxionXrayWindow * > fXrayWindows
 A list with pointers to the windows metadata descriptions. More...
 

Additional Inherited Members

- Protected Types inherited from TRestEventProcess
enum  REST_Process_Output { No_Output , Observable , Internal_Var , Full_Output }
 
- Protected Member Functions inherited from TRestAxionEventProcess
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 ()
 
TRestEventProcessGetFriend (const std::string &nameOrType)
 
TRestEventProcessGetFriendLive (const std::string &nameOrType)
 
template<class T >
T * GetMetadata ()
 Get a metadata object from the host TRestRun. More...
 
TRestMetadataGetMetadata (const std::string &nameOrType)
 
size_t GetNumberOfParallelProcesses () const
 
template<class T >
GetObservableValue (const std::string &name)
 
TRestEventProcessGetParallel (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 Attributes inherited from TRestAxionEventProcess
TRestAxionEventfAxionEvent
 A pointer to the specific TRestAxionEvent. More...
 
- Protected Attributes inherited from TRestEventProcess
TRestAnalysisTreefAnalysisTree = 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...
 
TRestRunfRunInfo = 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...
 

Constructor & Destructor Documentation

◆ TRestAxionTransmissionProcess() [1/2]

TRestAxionTransmissionProcess::TRestAxionTransmissionProcess ( )

Default constructor.

Definition at line 50 of file TRestAxionTransmissionProcess.cxx.

◆ TRestAxionTransmissionProcess() [2/2]

TRestAxionTransmissionProcess::TRestAxionTransmissionProcess ( char *  cfgFileName)

Constructor loading data from a config file.

If no configuration path is defined using TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

The default behaviour is that the config file must be specified with full path, absolute or relative.

Parameters
cfgFileNameA const char* giving the path to an RML file.

Definition at line 63 of file TRestAxionTransmissionProcess.cxx.

◆ ~TRestAxionTransmissionProcess()

TRestAxionTransmissionProcess::~TRestAxionTransmissionProcess ( )

Default destructor.

Definition at line 72 of file TRestAxionTransmissionProcess.cxx.

Member Function Documentation

◆ GetProcessName()

const char * TRestAxionTransmissionProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 68 of file TRestAxionTransmissionProcess.h.

◆ InitFromConfigFile()

void TRestAxionTransmissionProcess::InitFromConfigFile ( )
overridevirtual

Function reading input parameters from the RML TRestAxionTransmissionProcess metadata section.

Reimplemented from TRestEventProcess.

Definition at line 169 of file TRestAxionTransmissionProcess.cxx.

◆ Initialize()

void TRestAxionTransmissionProcess::Initialize ( )
overrideprivatevirtual

Function to initialize input/output event members and define the section name.

Reimplemented from TRestMetadata.

Definition at line 99 of file TRestAxionTransmissionProcess.cxx.

◆ InitProcess()

void TRestAxionTransmissionProcess::InitProcess ( )
overridevirtual

Process initialization. Data members that require initialization just before start processing should be initialized here.

Reimplemented from TRestAxionEventProcess.

Definition at line 110 of file TRestAxionTransmissionProcess.cxx.

◆ LoadConfig()

void TRestAxionTransmissionProcess::LoadConfig ( std::string  cfgFilename,
std::string  name = "" 
)

Function to load the configuration from an external configuration file.

If no configuration path is defined in TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

Parameters
cfgFileNameA const char* giving the path to an RML file.
nameThe name of the specific metadata. It will be used to find the correspondig TRestGeant4AnalysisProcess section inside the RML.

Definition at line 92 of file TRestAxionTransmissionProcess.cxx.

◆ LoadDefaultConfig()

void TRestAxionTransmissionProcess::LoadDefaultConfig ( )
private

Function to load the default config in absence of RML input.

Definition at line 77 of file TRestAxionTransmissionProcess.cxx.

◆ PrintMetadata()

void TRestAxionTransmissionProcess::PrintMetadata ( )
inlineoverridevirtual

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

Reimplemented from TRestAxionEventProcess.

Definition at line 54 of file TRestAxionTransmissionProcess.h.

◆ ProcessEvent()

TRestEvent * TRestAxionTransmissionProcess::ProcessEvent ( TRestEvent evInput)
overridevirtual

The main processing event function.

The component is placed at (0,0,0). It is TRestAxionEventProcess the responsible to translate the component (in reality the particle) according to fCenter.

Implements TRestEventProcess.

Definition at line 131 of file TRestAxionTransmissionProcess.cxx.

Field Documentation

◆ fWindowNames

std::vector<std::string> TRestAxionTransmissionProcess::fWindowNames
private

The names of the metadata TRestAxionXrayWindow that will be combined for transmission.

Definition at line 34 of file TRestAxionTransmissionProcess.h.

◆ fXrayWindows

std::vector<TRestAxionXrayWindow*> TRestAxionTransmissionProcess::fXrayWindows
private

A list with pointers to the windows metadata descriptions.

Definition at line 37 of file TRestAxionTransmissionProcess.h.


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