REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Public Member Functions | Protected Member Functions | Protected Attributes
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 continuous 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:
TRestEventProcess TRestMetadata TRestRawAFTERToSignalProcess TRestRawBiPoToSignalProcess TRestRawFEUDreamToSignalProcess TRestRawMultiCoBoAsAdToSignalProcess TRestRawMultiFEMINOSToSignalProcess TRestRawTDSToSignalProcess TRestRawUSTCToSignalProcess

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. More...
 
RESTValue GetOutputEvent () const override
 Get pointer to output event. Must be implemented in the derived class. More...
 
TRestMetadataGetProcessMetadata () 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. More...
 
Bool_t GoToNextFile ()
 
void Initialize () override
 Making default settings. More...
 
virtual void InitProcess () override
 To be executed at the beginning of the run (outside event loop) More...
 
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
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 ()
 

Protected Member Functions

void InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class. More...
 
void LoadDefaultConfig ()
 
- 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

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 More...
 
TRestRawSignalEventfSignalEvent = nullptr
 
Int_t fSubRunOrigin
 
Int_t iCurFile
 
Int_t nFiles
 
unsigned int payload
 
Long64_t totalBytes
 
Long64_t totalbytesRead
 
Double_t tStart
 
- 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...
 

Additional Inherited Members

- Protected Types inherited from TRestEventProcess
enum  REST_Process_Output { No_Output , Observable , Internal_Var , Full_Output }
 

Constructor & Destructor Documentation

◆ TRestRawToSignalProcess() [1/2]

TRestRawToSignalProcess::TRestRawToSignalProcess ( )

Definition at line 69 of file TRestRawToSignalProcess.cxx.

◆ TRestRawToSignalProcess() [2/2]

TRestRawToSignalProcess::TRestRawToSignalProcess ( const char *  configFilename)

Definition at line 71 of file TRestRawToSignalProcess.cxx.

◆ ~TRestRawToSignalProcess()

TRestRawToSignalProcess::~TRestRawToSignalProcess ( )

Definition at line 77 of file TRestRawToSignalProcess.cxx.

Member Function Documentation

◆ AddInputFile()

Bool_t TRestRawToSignalProcess::AddInputFile ( const std::string &  file)
overridevirtual

Reimplemented from TRestEventProcess.

Definition at line 159 of file TRestRawToSignalProcess.cxx.

◆ GetElectronicsType()

virtual std::string TRestRawToSignalProcess::GetElectronicsType ( ) const
inlinevirtual

Definition at line 85 of file TRestRawToSignalProcess.h.

◆ GetInputEvent()

RESTValue TRestRawToSignalProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 61 of file TRestRawToSignalProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawToSignalProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 62 of file TRestRawToSignalProcess.h.

◆ GetProcessMetadata()

TRestMetadata * TRestRawToSignalProcess::GetProcessMetadata ( ) const
inline

Definition at line 71 of file TRestRawToSignalProcess.h.

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

◆ GetTotalBytesRead()

Long64_t TRestRawToSignalProcess::GetTotalBytesRead ( ) const
inlineoverridevirtual

Interface to external file reading, get the read bytes. To be implemented in external processes.

Reimplemented from TRestEventProcess.

Definition at line 83 of file TRestRawToSignalProcess.h.

◆ GoToNextFile()

Bool_t TRestRawToSignalProcess::GoToNextFile ( )

Definition at line 214 of file TRestRawToSignalProcess.cxx.

◆ InitFromConfigFile()

void TRestRawToSignalProcess::InitFromConfigFile ( )
overrideprotectedvirtual

To make settings from rml file. This method must be implemented in the derived class.

Reimplemented from TRestEventProcess.

Definition at line 108 of file TRestRawToSignalProcess.cxx.

◆ Initialize()

void TRestRawToSignalProcess::Initialize ( )
overridevirtual

Making default settings.

Reimplemented from TRestMetadata.

Reimplemented in TRestRawUSTCToSignalProcess.

Definition at line 89 of file TRestRawToSignalProcess.cxx.

◆ InitProcess()

virtual void TRestRawToSignalProcess::InitProcess ( )
inlineoverridevirtual

◆ LoadConfig()

void TRestRawToSignalProcess::LoadConfig ( const std::string &  configFilename,
const std::string &  name = "" 
)

Definition at line 82 of file TRestRawToSignalProcess.cxx.

◆ LoadDefaultConfig()

void TRestRawToSignalProcess::LoadDefaultConfig ( )
protected

Definition at line 132 of file TRestRawToSignalProcess.cxx.

◆ OpenInputFiles()

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

Reimplemented from TRestEventProcess.

Definition at line 137 of file TRestRawToSignalProcess.cxx.

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

◆ ResetEntry()

Bool_t TRestRawToSignalProcess::ResetEntry ( )
overridevirtual

Reimplemented from TRestEventProcess.

Definition at line 187 of file TRestRawToSignalProcess.cxx.

◆ SetRunOrigin()

void TRestRawToSignalProcess::SetRunOrigin ( Int_t  runOrigin)
inline

Definition at line 73 of file TRestRawToSignalProcess.h.

◆ SetSubRunOrigin()

void TRestRawToSignalProcess::SetSubRunOrigin ( Int_t  subRunOrigin)
inline

Definition at line 74 of file TRestRawToSignalProcess.h.

Field Documentation

◆ fElectronicsType

std::string TRestRawToSignalProcess::fElectronicsType
protected

Definition at line 35 of file TRestRawToSignalProcess.h.

◆ fgKeepFileOpen

bool TRestRawToSignalProcess::fgKeepFileOpen
protected

Definition at line 53 of file TRestRawToSignalProcess.h.

◆ fInputBinFile

FILE* TRestRawToSignalProcess::fInputBinFile
protected

Definition at line 44 of file TRestRawToSignalProcess.h.

◆ fInputFileNames

std::vector<std::string> TRestRawToSignalProcess::fInputFileNames
protected

Definition at line 52 of file TRestRawToSignalProcess.h.

◆ fInputFiles

std::vector<FILE*> TRestRawToSignalProcess::fInputFiles
protected

Definition at line 51 of file TRestRawToSignalProcess.h.

◆ fMinPoints

Int_t TRestRawToSignalProcess::fMinPoints
protected

Definition at line 36 of file TRestRawToSignalProcess.h.

◆ frameBits

unsigned int TRestRawToSignalProcess::frameBits
protected

Definition at line 34 of file TRestRawToSignalProcess.h.

◆ fRunOrigin

Int_t TRestRawToSignalProcess::fRunOrigin
protected

Definition at line 46 of file TRestRawToSignalProcess.h.

◆ fShowSamples

Int_t TRestRawToSignalProcess::fShowSamples
protected

true if need to open all raw files at the beginning

Definition at line 55 of file TRestRawToSignalProcess.h.

◆ fSignalEvent

TRestRawSignalEvent* TRestRawToSignalProcess::fSignalEvent = nullptr
protected

Definition at line 42 of file TRestRawToSignalProcess.h.

◆ fSubRunOrigin

Int_t TRestRawToSignalProcess::fSubRunOrigin
protected

Definition at line 47 of file TRestRawToSignalProcess.h.

◆ iCurFile

Int_t TRestRawToSignalProcess::iCurFile
protected

Definition at line 50 of file TRestRawToSignalProcess.h.

◆ nFiles

Int_t TRestRawToSignalProcess::nFiles
protected

Definition at line 49 of file TRestRawToSignalProcess.h.

◆ payload

unsigned int TRestRawToSignalProcess::payload
protected

Definition at line 33 of file TRestRawToSignalProcess.h.

◆ totalBytes

Long64_t TRestRawToSignalProcess::totalBytes
protected

Definition at line 40 of file TRestRawToSignalProcess.h.

◆ totalbytesRead

Long64_t TRestRawToSignalProcess::totalbytesRead
protected

Definition at line 39 of file TRestRawToSignalProcess.h.

◆ tStart

Double_t TRestRawToSignalProcess::tStart
protected

Definition at line 38 of file TRestRawToSignalProcess.h.


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