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

Detailed Description

A generic viewer REST process to visualize raw signals and parameters obtained from the anlysisTree on the processes canvas.

The TRestRawSignalViewerProcess allows to display on screen the pulses registered inside a TRestRawSignalEvent.


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:

2017-February: First implementation of Geant4 analysis process into REST_v2. Javier Galan

Author
Javier Galan

Definition at line 32 of file TRestRawSignalViewerProcess.h.

#include <TRestRawSignalViewerProcess.h>

Inheritance diagram for TRestRawSignalViewerProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalViewerProcess, 1)
 
void EndProcess () override
 Function to include required actions after all events have been processed. 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...
 
const char * GetProcessName () const override
 
void InitProcess () override
 Process initialization. It creates the canvas available in TRestEventProcess. More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 Function to load the configuration from an external configuration file. More...
 
void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestRawSignalViewerProcess ()
 Default constructor. More...
 
 TRestRawSignalViewerProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestRawSignalViewerProcess ()
 Default destructor. More...
 
- 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

TPad * DrawObservables ()
 
TPad * DrawSignal (Int_t signal)
 A helper method to draw signals in a pad. More...
 
void InitFromConfigFile () override
 Function to read input parameters from the RML TRestRawSignalViewerProcess metadata section. More...
 
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

int eveCounter = 0
 
TVector2 fBaseLineRange
 
std::vector< TObject * > fDrawingObjects
 
Double_t fDrawRefresh
 
TRestRawSignalEventfSignalEvent
 
int sgnCounter = 0
 

Additional Inherited Members

- Protected Types inherited from TRestEventProcess
enum  REST_Process_Output { No_Output , Observable , Internal_Var , Full_Output }
 
- 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 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

◆ TRestRawSignalViewerProcess() [1/2]

TRestRawSignalViewerProcess::TRestRawSignalViewerProcess ( )

Default constructor.

Definition at line 69 of file TRestRawSignalViewerProcess.cxx.

◆ TRestRawSignalViewerProcess() [2/2]

TRestRawSignalViewerProcess::TRestRawSignalViewerProcess ( const char *  configFilename)

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
configFilenameA const char* giving the path to an RML file.

Definition at line 83 of file TRestRawSignalViewerProcess.cxx.

◆ ~TRestRawSignalViewerProcess()

TRestRawSignalViewerProcess::~TRestRawSignalViewerProcess ( )

Default destructor.

Definition at line 92 of file TRestRawSignalViewerProcess.cxx.

Member Function Documentation

◆ DrawSignal()

TPad * TRestRawSignalViewerProcess::DrawSignal ( Int_t  signal)
private

A helper method to draw signals in a pad.

Definition at line 229 of file TRestRawSignalViewerProcess.cxx.

◆ EndProcess()

void TRestRawSignalViewerProcess::EndProcess ( )
overridevirtual

Function to include required actions after all events have been processed.

Reimplemented from TRestEventProcess.

Definition at line 217 of file TRestRawSignalViewerProcess.cxx.

◆ GetInputEvent()

RESTValue TRestRawSignalViewerProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 56 of file TRestRawSignalViewerProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalViewerProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 57 of file TRestRawSignalViewerProcess.h.

◆ GetProcessName()

const char * TRestRawSignalViewerProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 73 of file TRestRawSignalViewerProcess.h.

◆ InitFromConfigFile()

void TRestRawSignalViewerProcess::InitFromConfigFile ( )
overrideprivatevirtual

Function to read input parameters from the RML TRestRawSignalViewerProcess metadata section.

Reimplemented from TRestEventProcess.

Definition at line 293 of file TRestRawSignalViewerProcess.cxx.

◆ Initialize()

void TRestRawSignalViewerProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 103 of file TRestRawSignalViewerProcess.cxx.

◆ InitProcess()

void TRestRawSignalViewerProcess::InitProcess ( )
overridevirtual

Process initialization. It creates the canvas available in TRestEventProcess.

Reimplemented from TRestEventProcess.

Definition at line 134 of file TRestRawSignalViewerProcess.cxx.

◆ LoadConfig()

void TRestRawSignalViewerProcess::LoadConfig ( const std::string &  configFilename,
const 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
configFilenameA const char* giving the path to an RML file.
nameThe name of the specific metadata. It will be used to find the corresponding TRestGeant4AnalysisProcess section inside the RML.

Definition at line 126 of file TRestRawSignalViewerProcess.cxx.

◆ LoadDefaultConfig()

void TRestRawSignalViewerProcess::LoadDefaultConfig ( )
private

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

Definition at line 97 of file TRestRawSignalViewerProcess.cxx.

◆ PrintMetadata()

void TRestRawSignalViewerProcess::PrintMetadata ( )
inlineoverridevirtual

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 65 of file TRestRawSignalViewerProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawSignalViewerProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 139 of file TRestRawSignalViewerProcess.cxx.

Field Documentation

◆ eveCounter

int TRestRawSignalViewerProcess::eveCounter = 0
private

Definition at line 40 of file TRestRawSignalViewerProcess.h.

◆ fBaseLineRange

TVector2 TRestRawSignalViewerProcess::fBaseLineRange
private

Definition at line 39 of file TRestRawSignalViewerProcess.h.

◆ fDrawingObjects

std::vector<TObject*> TRestRawSignalViewerProcess::fDrawingObjects
private

Definition at line 36 of file TRestRawSignalViewerProcess.h.

◆ fDrawRefresh

Double_t TRestRawSignalViewerProcess::fDrawRefresh
private

Definition at line 37 of file TRestRawSignalViewerProcess.h.

◆ fSignalEvent

TRestRawSignalEvent* TRestRawSignalViewerProcess::fSignalEvent
private

Definition at line 34 of file TRestRawSignalViewerProcess.h.

◆ sgnCounter

int TRestRawSignalViewerProcess::sgnCounter = 0
private

Definition at line 41 of file TRestRawSignalViewerProcess.h.


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