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

Detailed Description

A process to draw analysis plots during processing, in case the process chain takes long time while we want to see the result instantly.

TRestRealTimeDrawingProcess might be added at any stage of the data processing chain.

This process will draw and save analysis plots during processing, in case the process chain takes long time to run while we want to see the result instantly. Supports multithread.

For example, when the detector is taking data and we are using REST to process data in real time. Then, for example, if we want to quickly know the baseline RMS, we can add this process to the process chain. It will generate plot files every several events, in which histogram will continuously grow.

drawInterval: How many events should passed when it starts next drawing, refreshing the plots. =0 will draw only once at the end of the process.

threadWaitTimeout: In case the event triggering the draw operation is the last event in the input file, processes of other threads may never get into ProcessEvent() and flag themselves as paused, which will cause the process chian to never end. To prevent this, we need to set a timeout.

TRestAnalysisPlot: sections to define TRestAnalysisPlot

The following code shows an example of implementation inside a TRestProcessRunner RML section.

<addProcess type="TRestRealTimeDrawingProcess" name="rD" value="ON" drawInterval="1000" >
<TRestAnalysisPlot name="BaselinePlot" title="Basic Plots" previewPlot="false">
<canvas size="(1000,800)" divide="(1,1)" save=""/>
<plot name="Baseline" title="Baseline average" xlabel="Baseline [ADC units]" ylabel="Counts"
logscale="false" value="ON" save="Baseline.png" >
<variable name="sAna_BaseLineMean" range="(0,1000)" nbins="100" />
</plot>
<TRestAnalysisPlot name="SpectrumPlot" title="Basic Plots" previewPlot="false">
<canvas size="(1000,800)" divide="(1,1)" save=""/>
<plot name="Spectrum" title="ADC energy spectrum" xlabel="Threshold integral energy [ADC units]"
ylabel="Counts"
logscale="false" value="ON" save="Spectrum.png" >
<variable name="sAna_ThresholdIntegral" range="(0,300000)" nbins="100" />
</plot>
</addProcess>

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2020-Aug: First implementation and concept Ni Kaixiang

Author
Ni Kaixiang

Definition at line 32 of file TRestRealTimeDrawingProcess.h.

#include <TRestRealTimeDrawingProcess.h>

Inheritance diagram for TRestRealTimeDrawingProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRealTimeDrawingProcess, 3)
 
void DrawOnce ()
 
void DrawWithNotification ()
 Returns a new instance of this class. 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
 Returns the name of this process. More...
 
void PrintMetadata () override
 It prints out the process parameters stored in the metadata structure. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestRealTimeDrawingProcess ()
 Default constructor. More...
 
 ~TRestRealTimeDrawingProcess ()
 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

void EndProcess () override
 Function to use when all events have been processed. More...
 
void Initialize () override
 Function to initialize input/output event members and define the section name and library version. More...
 
void InitProcess () override
 Function to use in initialization of process members before starting to process the event. More...
 

Private Attributes

int fDrawInterval
 How many events passed when it starts next drawing. More...
 
TRestEventfEvent = nullptr
 The event pointer is not used in this process. More...
 
Int_t fThreadWaitTimeoutMs
 How many events passed when it starts next drawing. More...
 

Static Private Attributes

static Long64_t fLastDrawnEntry = 0
 Last drawn entry of analysis tree. More...
 
static bool fPauseInvoke
 Pause signal send for other threads when start drawing. More...
 
static std::map< TRestRealTimeDrawingProcess *, bool > fPauseResponse
 Pause response flag from other threads when recieving pause signal. More...
 
static std::vector< TRestAnalysisPlot * > fPlots
 TRestAnalysisPlot object called for drawing. More...
 
static std::vector< std::string > fProcessesToDraw
 TRestAnalysisPlot object called for drawing. 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 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

◆ TRestRealTimeDrawingProcess()

TRestRealTimeDrawingProcess::TRestRealTimeDrawingProcess ( )

Default constructor.

Definition at line 103 of file TRestRealTimeDrawingProcess.cxx.

◆ ~TRestRealTimeDrawingProcess()

TRestRealTimeDrawingProcess::~TRestRealTimeDrawingProcess ( )

Default destructor.

Definition at line 108 of file TRestRealTimeDrawingProcess.cxx.

Member Function Documentation

◆ DrawOnce()

void TRestRealTimeDrawingProcess::DrawOnce ( )

Definition at line 227 of file TRestRealTimeDrawingProcess.cxx.

◆ DrawWithNotification()

void TRestRealTimeDrawingProcess::DrawWithNotification ( )

Returns a new instance of this class.

Definition at line 238 of file TRestRealTimeDrawingProcess.cxx.

◆ EndProcess()

void TRestRealTimeDrawingProcess::EndProcess ( )
overrideprivatevirtual

Function to use when all events have been processed.

Reimplemented from TRestEventProcess.

Definition at line 218 of file TRestRealTimeDrawingProcess.cxx.

◆ GetInputEvent()

RESTValue TRestRealTimeDrawingProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 59 of file TRestRealTimeDrawingProcess.h.

◆ GetOutputEvent()

RESTValue TRestRealTimeDrawingProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 60 of file TRestRealTimeDrawingProcess.h.

◆ GetProcessName()

const char * TRestRealTimeDrawingProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 72 of file TRestRealTimeDrawingProcess.h.

◆ Initialize()

void TRestRealTimeDrawingProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 114 of file TRestRealTimeDrawingProcess.cxx.

◆ InitProcess()

void TRestRealTimeDrawingProcess::InitProcess ( )
overrideprivatevirtual

Function to use in initialization of process members before starting to process the event.

Reimplemented from TRestEventProcess.

Definition at line 127 of file TRestRealTimeDrawingProcess.cxx.

◆ PrintMetadata()

void TRestRealTimeDrawingProcess::PrintMetadata ( )
overridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 279 of file TRestRealTimeDrawingProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestRealTimeDrawingProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 164 of file TRestRealTimeDrawingProcess.cxx.

Field Documentation

◆ fDrawInterval

int TRestRealTimeDrawingProcess::fDrawInterval
private

How many events passed when it starts next drawing.

Definition at line 35 of file TRestRealTimeDrawingProcess.h.

◆ fEvent

TRestEvent* TRestRealTimeDrawingProcess::fEvent = nullptr
private

The event pointer is not used in this process.

Definition at line 50 of file TRestRealTimeDrawingProcess.h.

◆ fLastDrawnEntry

Long64_t TRestRealTimeDrawingProcess::fLastDrawnEntry = 0
staticprivate

Last drawn entry of analysis tree.

Definition at line 44 of file TRestRealTimeDrawingProcess.h.

◆ fPauseInvoke

bool TRestRealTimeDrawingProcess::fPauseInvoke
staticprivate

Pause signal send for other threads when start drawing.

Definition at line 46 of file TRestRealTimeDrawingProcess.h.

◆ fPauseResponse

map< TRestRealTimeDrawingProcess *, bool > TRestRealTimeDrawingProcess::fPauseResponse
staticprivate

Pause response flag from other threads when recieving pause signal.

Definition at line 48 of file TRestRealTimeDrawingProcess.h.

◆ fPlots

vector< TRestAnalysisPlot * > TRestRealTimeDrawingProcess::fPlots
staticprivate

TRestAnalysisPlot object called for drawing.

Definition at line 42 of file TRestRealTimeDrawingProcess.h.

◆ fProcessesToDraw

vector< string > TRestRealTimeDrawingProcess::fProcessesToDraw
staticprivate

TRestAnalysisPlot object called for drawing.

Definition at line 40 of file TRestRealTimeDrawingProcess.h.

◆ fThreadWaitTimeoutMs

Int_t TRestRealTimeDrawingProcess::fThreadWaitTimeoutMs
private

How many events passed when it starts next drawing.

Definition at line 37 of file TRestRealTimeDrawingProcess.h.


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