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

Detailed Description

A process allowing to remove selected channels from a TRestRawSignalEvent.

The TRestRawSignalRemoveChannelsProcess allows to remove a selection daq channels ids from a TRestRawSignalEvent. The channels should be provided through the corresponding section at the RML configuration file.

An application of this process is to evaluate the impact on the detector response due to the absence of signal on some channels, or dead channels.

The following example will remove the channels with signal ids 17,19,27 and all the signals between 67 and 76 from the TRestRawSignalEvent output.

<TRestRawSignalRemoveChannelsProcess name="rmChannels" title="Removing few
channels" verboseLevel="debug" >
<removeChannel id="17" />
<removeChannel id="19" />
<removeChannel id="27" />
<removeChannels range="(67,76)" />
A process allowing to remove selected channels from a TRestRawSignalEvent.

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:

2017-November: First implementation of TRestRawSignalRemoveChannelsProcess. Javier Galan

Author
Javier Galan

Definition at line 32 of file TRestRawSignalRemoveChannelsProcess.h.

#include <TRestRawSignalRemoveChannelsProcess.h>

Inheritance diagram for TRestRawSignalRemoveChannelsProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalRemoveChannelsProcess, 3)
 
std::vector< Int_t > GetChannelIds () const
 
std::vector< std::string > GetChannelTypes () 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...
 
const char * GetProcessName () const override
 Returns the name of this process. More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 Function to load the configuration from an external configuration file. More...
 
TRestEventProcessMaker ()
 Returns a new instance of this class. 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...
 
 TRestRawSignalRemoveChannelsProcess ()
 Default constructor. More...
 
 TRestRawSignalRemoveChannelsProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestRawSignalRemoveChannelsProcess ()
 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 ()
 

Protected Attributes

std::vector< Int_t > fChannelIds
 
std::vector< std::string > fChannelTypes
 
std::map< Int_t, std::string > fChannelTypesToRemove
 
- 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...
 

Private Member Functions

void InitFromConfigFile () override
 Function reading input parameters from the RML TRestDetectorSignalToRawSignalProcess metadata section. More...
 
void Initialize () override
 Function to initialize input/output event members and define the section name. More...
 
void LoadDefaultConfig ()
 Function to load the default config in absence of RML input. More...
 

Private Attributes

TRestRawSignalEventfInputEvent
 A pointer to the specific TRestDetectorSignalEvent input. More...
 
TRestRawSignalEventfOutputEvent
 A pointer to the specific TRestRawSignalEvent input. More...
 
TRestRawReadoutMetadatafReadoutMetadata = nullptr
 A pointer to the readout metadata. 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...
 

Constructor & Destructor Documentation

◆ TRestRawSignalRemoveChannelsProcess() [1/2]

TRestRawSignalRemoveChannelsProcess::TRestRawSignalRemoveChannelsProcess ( )

Default constructor.

Definition at line 78 of file src/TRestRawSignalRemoveChannelsProcess.cxx.

◆ TRestRawSignalRemoveChannelsProcess() [2/2]

TRestRawSignalRemoveChannelsProcess::TRestRawSignalRemoveChannelsProcess ( const char *  configFilename)

Constructor loading data from a config file.

If no configuration path is defined using TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

The default behaviour is that the config file must be specified with full path, absolute or relative.

Parameters
configFilenameA const char* giving the path to an RML file.

Definition at line 92 of file src/TRestRawSignalRemoveChannelsProcess.cxx.

◆ ~TRestRawSignalRemoveChannelsProcess()

TRestRawSignalRemoveChannelsProcess::~TRestRawSignalRemoveChannelsProcess ( )

Default destructor.

Definition at line 105 of file src/TRestRawSignalRemoveChannelsProcess.cxx.

Member Function Documentation

◆ GetChannelIds()

std::vector< Int_t > TRestRawSignalRemoveChannelsProcess::GetChannelIds ( ) const
inline

Definition at line 64 of file TRestRawSignalRemoveChannelsProcess.h.

◆ GetChannelTypes()

std::vector< std::string > TRestRawSignalRemoveChannelsProcess::GetChannelTypes ( ) const
inline

Definition at line 63 of file TRestRawSignalRemoveChannelsProcess.h.

◆ GetInputEvent()

RESTValue TRestRawSignalRemoveChannelsProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 56 of file TRestRawSignalRemoveChannelsProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalRemoveChannelsProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 57 of file TRestRawSignalRemoveChannelsProcess.h.

◆ GetProcessName()

const char * TRestRawSignalRemoveChannelsProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 73 of file TRestRawSignalRemoveChannelsProcess.h.

◆ InitFromConfigFile()

void TRestRawSignalRemoveChannelsProcess::InitFromConfigFile ( )
overrideprivatevirtual

Function reading input parameters from the RML TRestDetectorSignalToRawSignalProcess metadata section.

Reimplemented from TRestEventProcess.

Definition at line 222 of file src/TRestRawSignalRemoveChannelsProcess.cxx.

◆ Initialize()

void TRestRawSignalRemoveChannelsProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 119 of file src/TRestRawSignalRemoveChannelsProcess.cxx.

◆ LoadConfig()

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

Function to load the configuration from an external configuration file.

If no configuration path is defined in TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

Parameters
configFilenameA const char* giving the path to an RML file.
nameThe name of the specific metadata. It will be used to find the corresponding TRestGeant4AnalysisProcess section inside the RML.

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

◆ LoadDefaultConfig()

void TRestRawSignalRemoveChannelsProcess::LoadDefaultConfig ( )
private

Function to load the default config in absence of RML input.

Definition at line 110 of file src/TRestRawSignalRemoveChannelsProcess.cxx.

◆ Maker()

TRestEventProcess * TRestRawSignalRemoveChannelsProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 70 of file TRestRawSignalRemoveChannelsProcess.h.

◆ PrintMetadata()

void TRestRawSignalRemoveChannelsProcess::PrintMetadata ( )
overridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 257 of file src/TRestRawSignalRemoveChannelsProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestRawSignalRemoveChannelsProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 148 of file src/TRestRawSignalRemoveChannelsProcess.cxx.

Field Documentation

◆ fChannelIds

std::vector<Int_t> TRestRawSignalRemoveChannelsProcess::fChannelIds
protected

Definition at line 50 of file TRestRawSignalRemoveChannelsProcess.h.

◆ fChannelTypes

std::vector<std::string> TRestRawSignalRemoveChannelsProcess::fChannelTypes
protected

Definition at line 51 of file TRestRawSignalRemoveChannelsProcess.h.

◆ fChannelTypesToRemove

std::map<Int_t, std::string> TRestRawSignalRemoveChannelsProcess::fChannelTypesToRemove
protected

Definition at line 53 of file TRestRawSignalRemoveChannelsProcess.h.

◆ fInputEvent

TRestRawSignalEvent* TRestRawSignalRemoveChannelsProcess::fInputEvent
private

A pointer to the specific TRestDetectorSignalEvent input.

Definition at line 35 of file TRestRawSignalRemoveChannelsProcess.h.

◆ fOutputEvent

TRestRawSignalEvent* TRestRawSignalRemoveChannelsProcess::fOutputEvent
private

A pointer to the specific TRestRawSignalEvent input.

Definition at line 38 of file TRestRawSignalRemoveChannelsProcess.h.

◆ fReadoutMetadata

TRestRawReadoutMetadata* TRestRawSignalRemoveChannelsProcess::fReadoutMetadata = nullptr
private

A pointer to the readout metadata.

Definition at line 41 of file TRestRawSignalRemoveChannelsProcess.h.


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