REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Loading...
Searching...
No Matches
TRestRawTDSToSignalProcess Class Reference

Detailed Description

A process to read binary files produced with TDS (Tektronix oscilloscope) DAQ.

The TRestRawTDSToSignalProcess is a process used to read a binary file produced by the read binary files produced with TDS (Tektronix oscilloscope) DAQ, The results are stores following TRestRawSignalEvent format ,and then it processing can continue inside with the REST framework libraries.

Parameters

Inherits from TRestRawToSignalProcess, only electronics type is required:

  • electronics: You need to write here TDS

Examples

Similar to TRestRawToSignalProcess, we just define the electronics parameter as TDS

<addProcess type="TRestRawTDSToSignalProcess" name="tdsDAQ" electronics="TDS"/>

REST-for-Physics - Software for Rare Event Searches Toolkit

History of developments:

2022-05: First implementation of TRestRawTDSToSignalProcess JuanAn Garcia

Author
: JuanAn Garcia juana.nosp@m.ngp@.nosp@m.uniza.nosp@m.r.es

Definition at line 49 of file TRestRawTDSToSignalProcess.h.

#include <TRestRawTDSToSignalProcess.h>

Inheritance diagram for TRestRawTDSToSignalProcess:
TRestRawToSignalProcess TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawTDSToSignalProcess, 1)
TRestMetadata * GetProcessMetadata () const
const char * GetProcessName () const override
void Initialize () override
 Function to initialize input/output event members and define the section name, calls parent TRestRawToSignalProcess::Initialize().
void InitProcess () override
 Process initialization. Read first header block and initializes several variables such as: nSamples, nChannels, fRate, pulseDepth, fScale and negPolarity. It also sets the start timeStamp for the run.
Bool_t isExternal ()
TRestEvent * ProcessEvent (TRestEvent *inputEvent) override
 The main processing event function.
 TRestRawTDSToSignalProcess ()
 Default constructor.
 ~TRestRawTDSToSignalProcess ()
 Default destructor.
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.
RESTValue GetOutputEvent () const override
 Get pointer to output event. Must be implemented in the derived class.
TRestMetadata * GetProcessMetadata () 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.
Bool_t GoToNextFile ()
void Initialize () override
 Making default settings.
void LoadConfig (const std::string &configFilename, const std::string &name="")
Bool_t OpenInputFiles (const std::vector< std::string > &files) override
 Interface to external file reading, open input file. To be implemented in external processes.
virtual void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information.
Bool_t ResetEntry () override
void SetRunOrigin (Int_t runOrigin)
void SetSubRunOrigin (Int_t subRunOrigin)
 TRestRawToSignalProcess (const char *configFilename)
Public Member Functions inherited from TRestEventProcess
bool ApplyCut ()
 Apply cut according to the cut conditions saved in fCut.
virtual void BeginOfEventProcess (TRestEvent *inputEvent=nullptr)
 Begin of event process, preparation work. Called right before ProcessEvent().
 ClassDefOverride (TRestEventProcess, 3)
virtual void EndOfEventProcess (TRestEvent *inputEvent=nullptr)
 End of event process. Nothing to do. Called directly after ProcessEvent().
virtual void EndProcess ()
 To be executed at the end of the run (outside event loop).
TRestAnalysisTree * GetAnalysisTree () const
 Return the local analysis tree (dummy).
TCanvas * GetCanvas () const
 Get canvas.
TRestAnalysisTree * GetFullAnalysisTree ()
 Get the full analysis tree from TRestRun, with non-empty entries.
std::vector< std::string > GetListOfAddedObservables ()
 Get list of observables, convert map to vector.
TRestRun * GetRunInfo () const
 Return the pointer of the hosting TRestRun object.
Bool_t isExternal () const
 Return whether this process is external process.
Int_t LoadSectionMetadata () override
 Load extra section metadata: outputlevel after calling TRestMetadata::LoadSectionMetadata().
virtual void NotifyAnalysisTreeReset ()
 In case the analysis tree is reset(switched to new file), some process needs to have action.
std::vector< std::string > ReadObservables ()
void RegisterAllObservables (Bool_t value=true)
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.
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.
Bool_t singleThreadOnly () const
 Return whether this process is single std::thread only.
 TRestEventProcess ()
 ~TRestEventProcess ()

Protected Attributes

double fRate = 0
double fScale [4] = {0, 0, 0, 0}
int nChannels
bool negPolarity [4]
int nEvents = 0
int nSamples
int pulseDepth
double tNow = 0
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
TRestRawSignalEvent * fSignalEvent = nullptr
Int_t fSubRunOrigin
Int_t iCurFile
Int_t nFiles
unsigned int payload
Long64_t totalBytes
Long64_t totalBytesReaded
Double_t tStart
Protected Attributes inherited from TRestEventProcess
TRestAnalysisTree * fAnalysisTree = nullptr
TCanvas * fCanvas = nullptr
 < Canvas for some viewer event
TVector2 fCanvasSize
 Canvas size.
std::vector< std::pair< std::string, TVector2 > > fCuts
 Stores cut definitions. Any listed observables should be in the range.
bool fDynamicObs = false
 It defines whether to use added observables only or all the observables appear in the code.
bool fIsExternal = false
 It defines if the process reads event data from an external source.
std::map< std::string, int > fObservablesDefined
 Stores the list of all the appeared process observables in the code.
std::map< std::string, int > fObservablesUpdated
 Stores the list of process observables updated when processing this event.
bool fReadOnly = false
 not used, keep for compatibility
TRestRun * fRunInfo = nullptr
 < Pointer to TRestRun object where to find metadata.
bool fSingleThreadOnly = false
bool fValidateObservables = false
 It defines if observable names should be added to the validation list.

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.
void LoadDefaultConfig ()
Protected Member Functions inherited from TRestEventProcess
void BeginPrintProcess ()
 [name, cut range]
void CreateCanvas ()
 Create the canvas.
void EndPrintProcess ()
 Pre-defined printer, can be used at the ending in the implementation of PrintMetadata().
TRestEventProcess * GetFriend (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
TRestEventProcess * GetFriendLive (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
template<class T>
T * GetMetadata ()
 Get a metadata object from the host TRestRun.
TRestMetadata * GetMetadata (const std::string &nameOrType)
 Get a metadata object from the host TRestRun.
size_t GetNumberOfParallelProcesses () const
template<class T>
T GetObservableValue (const std::string &name)
TRestEventProcess * GetParallel (int i)
 Get a list of parallel processes from this process.
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.
template<class T>
void SetObservableValue (const std::string &name, const T &value)
 Set observable value for AnalysisTree.

Constructor & Destructor Documentation

◆ TRestRawTDSToSignalProcess()

TRestRawTDSToSignalProcess::TRestRawTDSToSignalProcess ( )

Default constructor.

Definition at line 61 of file TRestRawTDSToSignalProcess.cxx.

◆ ~TRestRawTDSToSignalProcess()

TRestRawTDSToSignalProcess::~TRestRawTDSToSignalProcess ( )

Default destructor.

Definition at line 66 of file TRestRawTDSToSignalProcess.cxx.

Member Function Documentation

◆ GetProcessMetadata()

TRestMetadata * TRestRawTDSToSignalProcess::GetProcessMetadata ( ) const
inline

Definition at line 80 of file TRestRawTDSToSignalProcess.h.

◆ GetProcessName()

const char * TRestRawTDSToSignalProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 79 of file TRestRawTDSToSignalProcess.h.

◆ Initialize()

void TRestRawTDSToSignalProcess::Initialize ( )
overridevirtual

Function to initialize input/output event members and define the section name, calls parent TRestRawToSignalProcess::Initialize().

Reimplemented from TRestMetadata.

Definition at line 72 of file TRestRawTDSToSignalProcess.cxx.

◆ InitProcess()

void TRestRawTDSToSignalProcess::InitProcess ( )
overridevirtual

Process initialization. Read first header block and initializes several variables such as: nSamples, nChannels, fRate, pulseDepth, fScale and negPolarity. It also sets the start timeStamp for the run.

Reimplemented from TRestRawToSignalProcess.

Definition at line 81 of file TRestRawTDSToSignalProcess.cxx.

◆ isExternal()

Bool_t TRestRawTDSToSignalProcess::isExternal ( )
inline

Definition at line 82 of file TRestRawTDSToSignalProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawTDSToSignalProcess::ProcessEvent ( TRestEvent * inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 103 of file TRestRawTDSToSignalProcess.cxx.

Field Documentation

◆ fRate

double TRestRawTDSToSignalProcess::fRate = 0
protected

Definition at line 70 of file TRestRawTDSToSignalProcess.h.

◆ fScale

double TRestRawTDSToSignalProcess::fScale[4] = {0, 0, 0, 0}
protected

Definition at line 73 of file TRestRawTDSToSignalProcess.h.

◆ nChannels

int TRestRawTDSToSignalProcess::nChannels
protected

Definition at line 58 of file TRestRawTDSToSignalProcess.h.

◆ negPolarity

bool TRestRawTDSToSignalProcess::negPolarity[4]
protected

Definition at line 67 of file TRestRawTDSToSignalProcess.h.

◆ nEvents

int TRestRawTDSToSignalProcess::nEvents = 0
protected

Definition at line 64 of file TRestRawTDSToSignalProcess.h.

◆ nSamples

int TRestRawTDSToSignalProcess::nSamples
protected

Definition at line 55 of file TRestRawTDSToSignalProcess.h.

◆ pulseDepth

int TRestRawTDSToSignalProcess::pulseDepth
protected

Definition at line 61 of file TRestRawTDSToSignalProcess.h.

◆ tNow

double TRestRawTDSToSignalProcess::tNow = 0
protected

Definition at line 52 of file TRestRawTDSToSignalProcess.h.


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