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

Detailed Description

TRestRawMultiCoBoAsAdToSignalProcess ...

TODO. This process might be obsolete today. It may need additional revision, validation, and documentation.


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:

Author
Unknown

Definition at line 97 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

Inheritance diagram for TRestRawMultiCoBoAsAdToSignalProcess:
TRestRawToSignalProcess TRestEventProcess TRestMetadata

Public Member Functions

Bool_t AddInputFile (const std::string &file) override
 
 ClassDefOverride (TRestRawMultiCoBoAsAdToSignalProcess, 1)
 
void EndProcess () override
 To be executed at the end of the run (outside event loop) More...
 
Bool_t EndReading ()
 
bool FillBuffer ()
 
Bool_t FillBuffer (Int_t n)
 
const char * GetProcessName () const override
 
void Initialize () override
 Making default settings. More...
 
Bool_t InitializeStartTimeStampFromFilename (TString fName)
 
void InitProcess () override
 To be executed at the beginning of the run (outside event loop) More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 Process one event. More...
 
bool ReadFrameDataF (CoBoHeaderFrame &hdr)
 
bool ReadFrameDataP (FILE *f, CoBoHeaderFrame &hdr)
 
bool ReadFrameHeader (CoBoHeaderFrame &Frame)
 
 TRestRawMultiCoBoAsAdToSignalProcess (const char *configFilename)
 
- Public Member Functions inherited from TRestRawToSignalProcess
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 ()
 

Private Attributes

int fCurrentEvent = -1
 ///reserves a header frame for each file More...
 
std::map< int, CoBoDataFrame > fDataFrame
 
std::vector< CoBoHeaderFrame > fHeaderFrame
 ///asadId, dataframe More...
 
int fNextEvent = -1
 
UChar_t frameDataF [278528]
 ///for partial readout data frame More...
 
UChar_t frameDataP [2048]
 
TTimeStamp fStartTimeStamp
 ///for full readout data frame More...
 
TRestRawSignal signal
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ TRestRawMultiCoBoAsAdToSignalProcess() [1/2]

TRestRawMultiCoBoAsAdToSignalProcess::TRestRawMultiCoBoAsAdToSignalProcess ( )

Definition at line 70 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ TRestRawMultiCoBoAsAdToSignalProcess() [2/2]

TRestRawMultiCoBoAsAdToSignalProcess::TRestRawMultiCoBoAsAdToSignalProcess ( const char *  configFilename)

Definition at line 72 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ ~TRestRawMultiCoBoAsAdToSignalProcess()

TRestRawMultiCoBoAsAdToSignalProcess::~TRestRawMultiCoBoAsAdToSignalProcess ( )

Definition at line 76 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

Member Function Documentation

◆ AddInputFile()

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

Reimplemented from TRestRawToSignalProcess.

Definition at line 142 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ EndProcess()

void TRestRawMultiCoBoAsAdToSignalProcess::EndProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 242 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ EndReading()

Bool_t TRestRawMultiCoBoAsAdToSignalProcess::EndReading ( )

Definition at line 609 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ FillBuffer()

bool TRestRawMultiCoBoAsAdToSignalProcess::FillBuffer ( )

Definition at line 255 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ GetProcessName()

const char * TRestRawMultiCoBoAsAdToSignalProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 145 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

◆ Initialize()

void TRestRawMultiCoBoAsAdToSignalProcess::Initialize ( )
overridevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 80 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ InitializeStartTimeStampFromFilename()

Bool_t TRestRawMultiCoBoAsAdToSignalProcess::InitializeStartTimeStampFromFilename ( TString  fName)

Definition at line 86 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ InitProcess()

void TRestRawMultiCoBoAsAdToSignalProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestRawToSignalProcess.

Definition at line 121 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestRawMultiCoBoAsAdToSignalProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

Process one event.

Implements TRestEventProcess.

Definition at line 177 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ ReadFrameDataF()

bool TRestRawMultiCoBoAsAdToSignalProcess::ReadFrameDataF ( CoBoHeaderFrame &  hdr)

Definition at line 547 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ ReadFrameDataP()

bool TRestRawMultiCoBoAsAdToSignalProcess::ReadFrameDataP ( FILE *  f,
CoBoHeaderFrame &  hdr 
)

Definition at line 495 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

◆ ReadFrameHeader()

bool TRestRawMultiCoBoAsAdToSignalProcess::ReadFrameHeader ( CoBoHeaderFrame &  Frame)

Definition at line 381 of file TRestRawMultiCoBoAsAdToSignalProcess.cxx.

Field Documentation

◆ fCurrentEvent

int TRestRawMultiCoBoAsAdToSignalProcess::fCurrentEvent = -1
private

///reserves a header frame for each file

Definition at line 111 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

◆ fDataFrame

std::map<int, CoBoDataFrame> TRestRawMultiCoBoAsAdToSignalProcess::fDataFrame
private

Definition at line 107 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

◆ fHeaderFrame

std::vector<CoBoHeaderFrame> TRestRawMultiCoBoAsAdToSignalProcess::fHeaderFrame
private

///asadId, dataframe

Definition at line 109 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

◆ fNextEvent

int TRestRawMultiCoBoAsAdToSignalProcess::fNextEvent = -1
private

Definition at line 112 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

◆ frameDataF

UChar_t TRestRawMultiCoBoAsAdToSignalProcess::frameDataF[278528]
private

///for partial readout data frame

Definition at line 103 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

◆ frameDataP

UChar_t TRestRawMultiCoBoAsAdToSignalProcess::frameDataP[2048]
private

Definition at line 102 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

◆ fStartTimeStamp

TTimeStamp TRestRawMultiCoBoAsAdToSignalProcess::fStartTimeStamp
private

///for full readout data frame

Definition at line 105 of file TRestRawMultiCoBoAsAdToSignalProcess.h.

◆ signal

TRestRawSignal TRestRawMultiCoBoAsAdToSignalProcess::signal
private

Definition at line 100 of file TRestRawMultiCoBoAsAdToSignalProcess.h.


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