Detailed Description

An analysis process to extract valuable information from a TRestRawSignalEvent.

THIS DOCUMENTATION NEEDS REVISION. TODO If possible a figure with the pulse ilustrating the different observables extracted.

The following metadata parameters might be defined at the RML to control the rawsignal analysis is performed:

baseLineRange: The bins from the rawdata samples that will be used to calculate the baseline average and fluctuation.
baseLineOption: An optional parameter. When set to "ROBUST", the baseline parameters will be calculated using TRestRawSignal's robust methods, instead of mean and standard deviation, the median and IQR sigma are used.
integralRange: The calculated observables will only consider points found inside this range.

There are 3 additional parameters that are used in combination to identify the points over threshold at each signal. Those parameters are used, for example, to calculate the number of good signals observable.

pointThreshold: The number of sigmas over baseline fluctuations to identify a point overthreshold
signalThreshold: A parameter to define a minimum signal fluctuation. Measured in sigmas.
pointsOverThreshold: The minimum number of points over threshold to identify a signal as such

Additionaly, there is a metadata parameter,signalsRange that allows to define the signal ids over which this process will have effect. This parameter may allow to define different TRestRawSignalAnalysisProcess instances at the RML operating over different signal ranges. For example:

<TRestRawSignalAnalysisProcess name="rawMM" signalsRange="(0,512)"
       baseLineRange="(5,100)" observables="all" />
 
<TRestRawSignalAnalysisProcess name="rawVETO" signalsRange="(513,1024)" >
         <parameter name="pointThreshold" value="5" />
         <parameter name="signalThreshold" value="3.5" />
         <parameter name="pointsOverThreshold" value="15" />
 
      <observable name="rawAna_max_amplitude_map" type="map<int,double>" />
</TRestRawSignalAnalysisProcess>

Observables

Number of signals and base line:

NumberOfSignals: Number of pulses recorded in an event.
NumberOfGoodSignals: Number of pulses recorded in an event that gets over the threshold. It counts the signal if GetIntegralWithThreshold (fSignal) > 0.
BaseLineMean: Average of the base line of the pulses of the event.
BaseLineSigmaMean: Average of the standard deviation from the base line in the pulses of the event.

Integrals and energy estimations:

FullIntegral: Add the integral of all pulses of the event. The integral of a pulse is the sum of all samples.
TripleMaxIntegral: Add the highest value of each pulse with the previous sample and the next, and then add this amount for all pulses in the event. It is an estimation of the deposited energy.
ThresholdIntegral: Add the integral of all the pulses in the event that pass the threshold.
SlopeIntegral: Add the integral of the rising part of each pulse of the event.
RiseSlopeAvg: Add the SlopeIntegral of all pulses in the event that pass the GetThresholdIntegralValue() > 0 condition and divides it by the number of signals that pass the cut.
IntegralBalance: (fullIntegral - thrIntegral) / (fullIntegral + thrIntegral) Balance between FullIntegral and ThresholdIntegral.
RateOfChangeAvg: RiseSlopeAvg/SlopeIntegral. The first value takes only the events that pass the threshold cut, SopeIntegral takes all the events.
xEnergySum: Add the ThresholdIntegral of all signals recorded in X direction.
yEnergySum: Add the ThresholdIntegral of all signals recorded in Y direction.

Time observables:

TimeBinsLength: MaxTime of the event - MinTime of the event. The functions GetMaxTime() and GetMinTime() take the number of points of the signal (MinTime=0 MaxTime=fSignal[0].GetNumberOfPoints()).
RiseTimeAvg: Add GetRiseTime(fSignal) for all signals that satisfy the GetThresholdIntegralValue() > 0 condition and divide it by the number of signals that pass this cut. GetRiseTime(fSignal) provides the number of bins between the fist sample that pass the threshold and the maximum of the peak.

Peak amplitude observables:

AmplitudeIntegralRatio: ThresholdIntegral/maxValueIntegral. This is the sum of the integral of all the pulses in the event that pass the threshold divided by the sum of the maximum point of these pulses.
MinPeakAmplitude: Minimum value between the maximum points of the pulses that pass the threshold in the event.
MaxPeakAmplitude: Maximum value between the maximum points of the pulses that pass the threshold in the event.
PeakAmplitudeIntegral: Sum of all maximum points of the pulses that pass the threshold in the event.
AmplitudeRatio: PeakAmplitudeIntegral/ MaxPeakAmplitude. Sum of all maximum points divided by the maximum between the maximum points of the pulses.
MinEventValue: Minimum value reached by a pulse in the event.

Peak time observables:

MaxPeakTime: Highest bin for the maximum point of a pulse that pass the threshold in the event.
MinPeakTime: Smallest bin for the maximum point of a pulse that pass the threshold in the event.
MaxPeakTimeDelay: MaxPeakTime-MinPeakTime. Time between the earliest peak and the latest peak between the pulses that pass the threshold in the event.
AveragePeakTime: For all pulses that pass the threshold, add the bin of their maximums and divide this amount by the number of signals that pass the threshold.

Observables for individual signal info:

risetime: Map the ID of each signal in the event with its rise time. GetRiseTime() gives the number of bins between the first sample that pass the threshold and the maximum point of the peak.
risetimemean: Add the rise time of all pulses in the event and divide it by the number of pulses.
baseline: Map the ID of each signal in the event with its base line. It computes the base line adding the samples in a certain range and dividing it by the number of samples.
baselinemean: Add the base line of all pulses in the event and divide it by the number of pulses.
baselinesigma: Map the ID of each signal in the event with its base line's standard deviation. Standard deviation computed as the squared root of the sum of the squared differences between the samples and the base line, divided by the number of samples in the range used to compute the base line.
baselinesigmamean: Add the base line's standard deviation of all pulses in the event and divide it by the number of pulses.
max_amplitude_map: Map the ID of each signal in the event with the amplitude of its peak. Amplitude = MaxPeakValue-BaseLine.
ampeve_maxmethod: Add the amplitude of all pulses in the event. Amplitude = MaxPeakValue-BaseLine.
thr_integral_map: Map the ID of each signal in the event with the threshold integral of its peak. GetIntegralWithThreshold() adds the samples of a pulse that get over the threshold. A certain number of samples must pass the threshold to be taken into account.
ampeve_intmethod: Add the threshold integral of all pulses in the event. GetIntegralWithThreshold () adds the samples of a pulse that get over the threshold. A certain number of samples must pass the threshold to be taken into account.

You may add filters to any observable inside the analysis tree. To add a cut, write "cut" sections in your rml file:

<TRestRawSignalAnalysisProcess name=""  ... >
    <cut name="MeanBaseLineCut" value="(0,4096)" />
</TRestRawSignalAnalysisProcess>

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 will 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-February: First implementation of raw signal analysis process into REST_v2. Created from TRestDetectorSignalAnalysisProcess

Author: Javier Galan

Definition at line 31 of file TRestRawSignalAnalysisProcess.h.

#include <TRestRawSignalAnalysisProcess.h>

Inheritance diagram for TRestRawSignalAnalysisProcess:

Public Member Functions
	ClassDefOverride (TRestRawSignalAnalysisProcess, 5)

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

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

void	InitProcess () override
	Process initialization. More...

void	PrintMetadata () override
	Implemented it in the derived metadata class to print out specific metadata information. More...

TRestEvent *	ProcessEvent (TRestEvent *inputEvent) override
	The main processing event function. More...

	TRestRawSignalAnalysisProcess ()
	Default constructor. More...

	~TRestRawSignalAnalysisProcess ()
	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...

TRestAnalysisTree *	GetAnalysisTree () const
	Return the local analysis tree (dummy) More...

TCanvas *	GetCanvas () const
	Get canvas. More...

TRestAnalysisTree *	GetFullAnalysisTree ()

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

TRestRun *	GetRunInfo () 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 TRestEvent *	ProcessEvent (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 ()

Public Member Functions inherited from TRestMetadata
void	AddLog (std::string log="", bool print=true)
	Add logs to messageBuffer. More...

void	DoNotStore ()
	If this method is called the metadata information will not be stored in disk. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1))

TString	GetCommit ()
	Returns the REST commit value stored in fCommit. More...

std::string	GetConfigBuffer ()
	Returns the config section of this class. More...

std::string	GetDataMemberValue (std::string memberName)
	Get the value of data member as string. More...

std::vector< std::string >	GetDataMemberValues (std::string memberName, Int_t precision=0)
	Get the value of datamember as a vector of strings. More...

TString	GetDataPath ()
	Returns a std::string with the path used for data storage. More...

Double_t	GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL)
	Gets the value of the parameter name parName, after applying unit conversion. More...

Bool_t	GetError () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetErrorMessage ()
	Returns a std::string containing the error message. More...

TString	GetLibraryVersion ()
	Returns the REST libraty version stored in fLibraryVersion. More...

TString	GetMainDataPath ()
	Gets a std::string with the path used for data storage. More...

Int_t	GetNumberOfErrors () const

Int_t	GetNumberOfWarnings () const

std::string	GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns corresponding REST Metadata parameter from multiple sources. More...

std::string	GetSectionName ()
	Returns the section name of this class, defined at the beginning of fSectionName. More...

TRestStringOutput::REST_Verbose_Level	GetVerboseLevel ()
	returns the verboselevel in type of REST_Verbose_Level enumerator More...

TString	GetVerboseLevelString ()
	returns the verbose level in type of TString More...

TString	GetVersion ()
	Returns the REST version stored in fVersion. More...

Int_t	GetVersionCode ()

UInt_t	GetVersionMajor () const

UInt_t	GetVersionMinor () const

UInt_t	GetVersionPatch () const

Bool_t	GetWarning () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetWarningMessage ()
	Returns a std::string containing the warning message. More...

virtual void	Initialize ()
	Making default settings. More...

TRestMetadata *	InstantiateChildMetadata (int index, std::string pattern="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `index` given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More...

TRestMetadata *	InstantiateChildMetadata (std::string pattern="", std::string name="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `name` given by argument. More...

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

Int_t	LoadConfigFromBuffer ()
	Initialize data from a string element buffer. More...

Int_t	LoadConfigFromElement (TiXmlElement eSectional, TiXmlElement eGlobal, std::map< std::string, std::string > envs={})
	Main starter method. More...

Int_t	LoadConfigFromFile (const std::string &configFilename, const std::string &sectionName="")
	Give the file name, find out the corresponding section. Then call the main starter. More...

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)

void	Print ()
	Implementing TObject::Print() method. More...

void	PrintConfigBuffer ()
	Print the config xml section stored in the class. More...

void	PrintMessageBuffer ()
	Print the buffered message. More...

virtual void	PrintMetadata ()
	Implemented it in the derived metadata class to print out specific metadata information. More...

void	PrintTimeStamp (Double_t timeStamp)
	Print the current time on local machine. More...

void	SetConfigFile (std::string configFilename)
	set config file path from external More...

void	SetError (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	SetHostmgr (TRestManager *m)
	Set the host manager for this class. More...

void	SetSectionName (std::string sName)
	set the section name, clear the section content More...

void	SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v)
	sets the verbose level More...

void	SetWarning (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	Store ()
	If this method is called the metadata information will be stored in disk. More...

	TRestMetadata (const TRestMetadata &)

virtual void	UpdateMetadataMembers ()
	Method to allow implementation of specific metadata members updates at inherited classes. More...

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	overwriting the write() method with fStore considered More...

void	WriteConfigBuffer (std::string fName)
	Writes the config buffer to a file in append mode. More...

	~TRestMetadata ()
	TRestMetadata default destructor. More...

Private Member Functions
void	Initialize () override
	Function to initialize input/output event members and define the section name. More...

Private Attributes
std::string	fBaseLineOption
	Option for calculation of baseline parameters, can be set to "ROBUST". More...

TVector2	fBaseLineRange = TVector2(5, 55)
	The range where the baseline range will be calculated. More...

std::string	fChannelType
	avoid error when loading parameters (not used) More...

std::set< std::string >	fChannelTypes = {}

TRestRawSignalEvent *	fInputEvent
	A pointer to the specific TRestRawSignalEvent input. More...

TVector2	fIntegralRange = TVector2(10, 500)
	The range where the observables will be calculated. More...

Int_t	fPointsOverThreshold = 5
	The minimum number of points over threshold to identify a signal as such. More...

Double_t	fPointThreshold = 2
	The number of sigmas over baseline fluctuations to identify a point over threshold. More...

Bool_t	fRangeEnabled = false
	Just a flag to quickly determine if we have to apply the range filter. More...

TRestRawReadoutMetadata *	fReadoutMetadata = nullptr

TVector2	fSignalsRange = TVector2(-1, -1)
	It defines the signals id range where analysis is applied. More...

Double_t	fSignalThreshold = 5
	A parameter to define a minimum signal fluctuation. Measured in sigmas. 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 ()

TRestEventProcess *	GetFriend (const std::string &nameOrType)

TRestEventProcess *	GetFriendLive (const std::string &nameOrType)

template<class T >
T *	GetMetadata ()
	Get a metadata object from the host TRestRun. More...

TRestMetadata *	GetMetadata (const std::string &nameOrType)

size_t	GetNumberOfParallelProcesses () const

template<class T >
T	GetObservableValue (const std::string &name)

TRestEventProcess *	GetParallel (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 Member Functions inherited from TRestMetadata
std::string	ElementToString (TiXmlElement *ele)
	Convert an TiXmlElement object to string. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1))

Double_t	GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL)

TiXmlElement *	GetElement (std::string eleDeclare, TiXmlElement *e=nullptr)
	Get an xml element from a given parent element, according to its declaration. More...

TiXmlElement *	GetElementFromFile (std::string configFilename, std::string NameOrDecalre="")
	Open an xml encoded file and find its element. More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName)
	Get an xml element from the default location, according to its declaration and its field "name". More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name". More...

std::string	GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0)
	Gets field value in an xml element string by parsing it as TiXmlElement. More...

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified name. More...

std::string	GetKEYDefinition (std::string keyName)
	Gets the first key definition for keyName found inside buffer starting at fromPosition. More...

std::string	GetKEYDefinition (std::string keyName, size_t &Position)

std::string	GetKEYDefinition (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYDefinition (std::string keyName, std::string buffer)

std::string	GetKEYStructure (std::string keyName)
	Gets the first key structure for keyName found inside buffer after fromPosition. More...

std::string	GetKEYStructure (std::string keyName, size_t &Position)

std::string	GetKEYStructure (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYStructure (std::string keyName, size_t &Position, TiXmlElement *ele)

std::string	GetKEYStructure (std::string keyName, std::string buffer)

TiXmlElement *	GetNextElement (TiXmlElement *e)
	Get the next sibling xml element of this element, with same eleDeclare. More...

std::string	GetParameter (std::string parName, size_t &pos, std::string inputString)
	Returns the value for the parameter name parName found in inputString. More...

std::string	GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns the value for the parameter named parName in the given section. More...

std::pair< std::string, std::string >	GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr)
	Returns the unit string of the given parameter of the given xml section. More...

std::map< std::string, std::string >	GetParametersList ()
	It retrieves a map of all parameter:value found in the metadata class. More...

TString	GetSearchPath ()

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

virtual void	InitFromRootFile ()
	Method called after the object is retrieved from root file. More...

virtual Int_t	LoadSectionMetadata ()
	This method does some preparation of xml section. More...

void	ReadAllParameters ()
	Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More...

void	ReadParametersList (std::map< std::string, std::string > &list)
	It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. More...

std::string	ReplaceConstants (const std::string buffer)
	Identifies "constants" in the input buffer, and replace them with corresponding value. More...

std::string	ReplaceVariables (const std::string buffer)
	Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More...

void	ReSetVersion ()
	Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. More...

std::string	SearchFile (std::string filename)
	Search files in current directory and directories specified in "searchPath" section. More...

void	SetLibraryVersion (TString version)
	Set the library version of this metadata class. More...

TiXmlElement *	StringToElement (std::string definition)
	Parsing a string into TiXmlElement object. More...

	TRestMetadata ()
	TRestMetadata default constructor. More...

	TRestMetadata (const char *configFilename)
	constructor More...

void	UnSetVersion ()
	Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. More...

Protected Attributes inherited from TRestEventProcess
TRestAnalysisTree *	fAnalysisTree = 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...

TRestRun *	fRunInfo = 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...

Protected Attributes inherited from TRestMetadata
std::string	configBuffer
	The buffer where the corresponding metadata section is stored. Filled only during Write() More...

std::string	fConfigFileName
	Full name of the rml file. More...

std::map< std::string, std::string >	fConstants
	Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only. More...

TiXmlElement *	fElement
	Saving the sectional element together with global element. More...

TiXmlElement *	fElementGlobal
	Saving the global element, to be passed to the resident class, if necessary. More...

Bool_t	fError = false
	It can be used as a way to identify that something went wrong using SetError method. More...

TString	fErrorMessage = ""
	A std::string to store an optional error message through method SetError. More...

TRestManager *	fHostmgr
	All metadata classes can be initialized and managed by TRestManager. More...

Int_t	fNErrors = 0
	It counts the number of errors notified. More...

Int_t	fNWarnings = 0
	It counts the number of warnings notified. More...

std::string	fSectionName
	Section name given in the constructor of the derived metadata class. More...

Bool_t	fStore
	This variable is used to determine if the metadata structure should be stored in the ROOT file. More...

std::map< std::string, std::string >	fVariables
	Saving a list of rml variables. name-value std::pair. More...

TRestStringOutput::REST_Verbose_Level	fVerboseLevel
	Verbose level used to print debug info. More...

Bool_t	fWarning = false
	It can be used as a way to identify that something went wrong using SetWarning method. More...

TString	fWarningMessage = ""
	It can be used as a way to identify that something went wrong using SetWarning method. More...

std::string	messageBuffer
	The buffer to store the output message through TRestStringOutput in this class. More...

endl_t	RESTendl
	Termination flag object for TRestStringOutput. More...

Constructor & Destructor Documentation

◆ TRestRawSignalAnalysisProcess()

TRestRawSignalAnalysisProcess::TRestRawSignalAnalysisProcess ( )

Default constructor.

Definition at line 259 of file TRestRawSignalAnalysisProcess.cxx.

◆ ~TRestRawSignalAnalysisProcess()

TRestRawSignalAnalysisProcess::~TRestRawSignalAnalysisProcess ( )

Default destructor.

Definition at line 264 of file TRestRawSignalAnalysisProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestRawSignalAnalysisProcess::GetInputEvent ( ) const

inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 73 of file TRestRawSignalAnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalAnalysisProcess::GetOutputEvent ( ) const

inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 75 of file TRestRawSignalAnalysisProcess.h.

◆ GetProcessName()

const char * TRestRawSignalAnalysisProcess::GetProcessName ( ) const

inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 99 of file TRestRawSignalAnalysisProcess.h.

◆ InitFromConfigFile()

void TRestRawSignalAnalysisProcess::InitFromConfigFile ( )

overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 286 of file TRestRawSignalAnalysisProcess.cxx.

◆ Initialize()

void TRestRawSignalAnalysisProcess::Initialize ( )

overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 270 of file TRestRawSignalAnalysisProcess.cxx.

◆ InitProcess()

void TRestRawSignalAnalysisProcess::InitProcess ( )

overridevirtual

Process initialization.

Reimplemented from TRestEventProcess.

Definition at line 280 of file TRestRawSignalAnalysisProcess.cxx.

◆ PrintMetadata()

void TRestRawSignalAnalysisProcess::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 83 of file TRestRawSignalAnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawSignalAnalysisProcess::ProcessEvent ( TRestEvent * inputEvent )

overridevirtual

The main processing event function.

We define (or re-define) the baseline range and calculation range of our raw-signals.

Important call we need to initialize the points over threshold in a TRestRawSignal

Implements TRestEventProcess.

Definition at line 297 of file TRestRawSignalAnalysisProcess.cxx.

Field Documentation

◆ fBaseLineOption

std::string TRestRawSignalAnalysisProcess::fBaseLineOption

private

Option for calculation of baseline parameters, can be set to "ROBUST".

Definition at line 46 of file TRestRawSignalAnalysisProcess.h.

◆ fBaseLineRange

TVector2 TRestRawSignalAnalysisProcess::fBaseLineRange = TVector2(5, 55)

private

The range where the baseline range will be calculated.

Definition at line 40 of file TRestRawSignalAnalysisProcess.h.

◆ fChannelType

std::string TRestRawSignalAnalysisProcess::fChannelType

private

avoid error when loading parameters (not used)

Definition at line 55 of file TRestRawSignalAnalysisProcess.h.

◆ fChannelTypes

std::set<std::string> TRestRawSignalAnalysisProcess::fChannelTypes = {}

private

Definition at line 67 of file TRestRawSignalAnalysisProcess.h.

◆ fInputEvent

TRestRawSignalEvent* TRestRawSignalAnalysisProcess::fInputEvent

private

A pointer to the specific TRestRawSignalEvent input.

Definition at line 34 of file TRestRawSignalAnalysisProcess.h.

◆ fIntegralRange

TVector2 TRestRawSignalAnalysisProcess::fIntegralRange = TVector2(10, 500)

private

The range where the observables will be calculated.

Definition at line 43 of file TRestRawSignalAnalysisProcess.h.

◆ fPointsOverThreshold

Int_t TRestRawSignalAnalysisProcess::fPointsOverThreshold = 5

private

The minimum number of points over threshold to identify a signal as such.

Definition at line 58 of file TRestRawSignalAnalysisProcess.h.

◆ fPointThreshold

Double_t TRestRawSignalAnalysisProcess::fPointThreshold = 2

private

The number of sigmas over baseline fluctuations to identify a point over threshold.

Definition at line 49 of file TRestRawSignalAnalysisProcess.h.

◆ fRangeEnabled

Bool_t TRestRawSignalAnalysisProcess::fRangeEnabled = false

private

Just a flag to quickly determine if we have to apply the range filter.

Definition at line 37 of file TRestRawSignalAnalysisProcess.h.

◆ fReadoutMetadata

TRestRawReadoutMetadata* TRestRawSignalAnalysisProcess::fReadoutMetadata = nullptr

private

Definition at line 63 of file TRestRawSignalAnalysisProcess.h.

◆ fSignalsRange

TVector2 TRestRawSignalAnalysisProcess::fSignalsRange = TVector2(-1, -1)

private

It defines the signals id range where analysis is applied.

Definition at line 61 of file TRestRawSignalAnalysisProcess.h.

◆ fSignalThreshold

Double_t TRestRawSignalAnalysisProcess::fSignalThreshold = 5

private

A parameter to define a minimum signal fluctuation. Measured in sigmas.

Definition at line 52 of file TRestRawSignalAnalysisProcess.h.

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

Detailed Description

Observables

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestRawSignalAnalysisProcess()

◆ ~TRestRawSignalAnalysisProcess()

Member Function Documentation

◆ GetInputEvent()

◆ GetOutputEvent()

◆ GetProcessName()

◆ InitFromConfigFile()

◆ Initialize()

◆ InitProcess()

◆ PrintMetadata()

◆ ProcessEvent()

Field Documentation

◆ fBaseLineOption

◆ fBaseLineRange

◆ fChannelType

◆ fChannelTypes

◆ fInputEvent

◆ fIntegralRange

◆ fPointsOverThreshold

◆ fPointThreshold

◆ fRangeEnabled

◆ fReadoutMetadata

◆ fSignalsRange

◆ fSignalThreshold