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

Detailed Description

A process to reduce the range of values of the signals to emulate a realistic ADC. Using Short_t (default) is equivalent to using a 16 bit ADC, we can use this process to go from a 16 bit signal to a 12 bit signal (between 0 and 4095) for example.

Definition at line 33 of file TRestRawSignalRangeReductionProcess.h.

#include <TRestRawSignalRangeReductionProcess.h>

Inheritance diagram for TRestRawSignalRangeReductionProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalRangeReductionProcess, 2)
Double_t ConvertFromStartingRangeToTargetRange (Double_t value) const
Double_t ConvertFromTargetRangeToStartingRange (Double_t value) const
TVector2 GetDigitizationInputRange () 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
const char * GetProcessName () const override
Double_t GetResolutionInNumberOfBits () const
void Initialize () override
 Making default settings.
void InitProcess () override
 To be executed at the beginning of the run (outside event loop).
void LoadConfig (const std::string &configFilename, const std::string &name="")
void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information.
TRestEvent * ProcessEvent (TRestEvent *inputEvent) override
 Process one event.
void SetDigitizationInputRange (const TVector2 &range)
void SetResolutionInNumberOfBits (UShort_t nBits)
 TRestRawSignalRangeReductionProcess (const char *configFilename)
Public Member Functions inherited from TRestEventProcess
virtual Bool_t AddInputFile (const std::string &file)
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.
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.
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.
virtual Bool_t OpenInputFiles (const std::vector< std::string > &files)
 Interface to external file reading, open input file. To be implemented in external processes.
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.
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 ()

Private Member Functions

void InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class.
void LoadDefaultConfig ()

Private Attributes

TVector2 fDigitizationInputRange
TVector2 fDigitizationOutputRange
TRestRawSignalEvent * fInputRawSignalEvent
TRestRawSignalEvent * fOutputRawSignalEvent
UShort_t fResolutionInBits = 12

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

Constructor & Destructor Documentation

◆ TRestRawSignalRangeReductionProcess() [1/2]

TRestRawSignalRangeReductionProcess::TRestRawSignalRangeReductionProcess ( )

Definition at line 29 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ TRestRawSignalRangeReductionProcess() [2/2]

TRestRawSignalRangeReductionProcess::TRestRawSignalRangeReductionProcess ( const char * configFilename)

Definition at line 31 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ ~TRestRawSignalRangeReductionProcess()

TRestRawSignalRangeReductionProcess::~TRestRawSignalRangeReductionProcess ( )

Definition at line 38 of file src/TRestRawSignalRangeReductionProcess.cxx.

Member Function Documentation

◆ ConvertFromStartingRangeToTargetRange()

Double_t TRestRawSignalRangeReductionProcess::ConvertFromStartingRangeToTargetRange ( Double_t value) const

Definition at line 124 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ ConvertFromTargetRangeToStartingRange()

Double_t TRestRawSignalRangeReductionProcess::ConvertFromTargetRangeToStartingRange ( Double_t value) const

Definition at line 139 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ GetDigitizationInputRange()

TVector2 TRestRawSignalRangeReductionProcess::GetDigitizationInputRange ( ) const
inline

Definition at line 53 of file TRestRawSignalRangeReductionProcess.h.

◆ GetInputEvent()

RESTValue TRestRawSignalRangeReductionProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 56 of file TRestRawSignalRangeReductionProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalRangeReductionProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 57 of file TRestRawSignalRangeReductionProcess.h.

◆ GetProcessMetadata()

TRestMetadata * TRestRawSignalRangeReductionProcess::GetProcessMetadata ( ) const
inline

Definition at line 77 of file TRestRawSignalRangeReductionProcess.h.

◆ GetProcessName()

const char * TRestRawSignalRangeReductionProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 79 of file TRestRawSignalRangeReductionProcess.h.

◆ GetResolutionInNumberOfBits()

Double_t TRestRawSignalRangeReductionProcess::GetResolutionInNumberOfBits ( ) const
inline

Definition at line 50 of file TRestRawSignalRangeReductionProcess.h.

◆ InitFromConfigFile()

void TRestRawSignalRangeReductionProcess::InitFromConfigFile ( )
overrideprivatevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 57 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ Initialize()

void TRestRawSignalRangeReductionProcess::Initialize ( )
overridevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 45 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ InitProcess()

void TRestRawSignalRangeReductionProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 66 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ LoadConfig()

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

Definition at line 53 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ LoadDefaultConfig()

void TRestRawSignalRangeReductionProcess::LoadDefaultConfig ( )
private

Definition at line 40 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ PrintMetadata()

void TRestRawSignalRangeReductionProcess::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 67 of file TRestRawSignalRangeReductionProcess.h.

◆ ProcessEvent()

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

Process one event.

Implements TRestEventProcess.

Definition at line 70 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ SetDigitizationInputRange()

void TRestRawSignalRangeReductionProcess::SetDigitizationInputRange ( const TVector2 & range)

Definition at line 103 of file src/TRestRawSignalRangeReductionProcess.cxx.

◆ SetResolutionInNumberOfBits()

void TRestRawSignalRangeReductionProcess::SetResolutionInNumberOfBits ( UShort_t nBits)

Definition at line 94 of file src/TRestRawSignalRangeReductionProcess.cxx.

Field Documentation

◆ fDigitizationInputRange

TVector2 TRestRawSignalRangeReductionProcess::fDigitizationInputRange
private
Initial value:
=
TVector2(std::numeric_limits<Short_t>::min(), std::numeric_limits<Short_t>::max())

Definition at line 42 of file TRestRawSignalRangeReductionProcess.h.

◆ fDigitizationOutputRange

TVector2 TRestRawSignalRangeReductionProcess::fDigitizationOutputRange
private

Definition at line 45 of file TRestRawSignalRangeReductionProcess.h.

◆ fInputRawSignalEvent

TRestRawSignalEvent* TRestRawSignalRangeReductionProcess::fInputRawSignalEvent
private

Definition at line 35 of file TRestRawSignalRangeReductionProcess.h.

◆ fOutputRawSignalEvent

TRestRawSignalEvent* TRestRawSignalRangeReductionProcess::fOutputRawSignalEvent
private

Definition at line 36 of file TRestRawSignalRangeReductionProcess.h.

◆ fResolutionInBits

UShort_t TRestRawSignalRangeReductionProcess::fResolutionInBits = 12
private

Definition at line 41 of file TRestRawSignalRangeReductionProcess.h.


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