GETSignalModifier Class Reference

#include <GETSignalModifier.hh>

Inheritance diagram for GETSignalModifier:

Public Member Functions
Constructors, affectation, destructor
	GETSignalModifier (GETObject &obj)
	GETSignalModifier (u_int n=0, double dt=0.01)
	GETSignalModifier (const GETSignalModifier &proc)
virtual	~GETSignalModifier ()
Signal processing
virtual GETSample *	ProcessSample (GETChannel &channel, u_short info)
virtual GETSample *	ProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)=0
ROOT related functions
	ClassDef (GETSignalModifier, 0)
Public Member Functions inherited from GETProcess
	GETProcess (GETObject &obj)
	GETProcess (u_int n=0, double dt=0.01)
	GETProcess (const GETProcess &proc)
virtual	~GETProcess ()
virtual void	SetOptions (u_int opts)
virtual void	SetOption (u_int flags, bool b=true)
virtual u_int	GetOptions ()
virtual bool	GetOption (u_int flags)
virtual void	Init (u_int n, double dt)
u_int	GetDimension () const
double	GetSamplingTime () const
GETSample *	GetResultSamplePtr ()
const GETSample *	GetResultSamplePtr () const
GETSample &	GetResultSample ()
const GETSample &	GetResultSample () const
	ClassDef (GETProcess, 0)

Private Member Functions
	GObjectV (GETSignalModifier)

Additional Inherited Members
Protected Attributes inherited from GETProcess
u_int	options
	Option flags.
GETSample	result_sample
	Internal processing result sample (processing result)

Detailed Description

GETSignalModifier is the base class for modification of signal samples (noise, baseline corrections,...).

Constructor & Destructor Documentation

GETSignalModifier::GETSignalModifier

(

GETObject &

obj

)

Constructor: the dimension of the first channel of the object is used for the process definition.

Parameters

obj	a core object of the GET system

GETSignalModifier::GETSignalModifier	(	u_int	n = 0,
		double	dt = 0.01
	)

Constructor.

Parameters

n	sampling size of the channels
dt	sampling period (us)

GETSignalModifier::GETSignalModifier

(

const GETSignalModifier &

proc

)

Copy constructor.

Parameters

proc	object to copy

GETSignalModifier::~GETSignalModifier ( )

virtual

Destructor.

Member Function Documentation

GETSignalModifier::ClassDef	(	GETSignalModifier	,
		0
	)

for use within ROOT.

GETSignalModifier::GObjectV ( GETSignalModifier  )

private

Macro from GCpp library that defines the following functions:

• ClassName(): return the real class name of the object
• StaticClassName(): return the used class name of the object (that may be a base class of the real object).
• IsInstanceOf<T>(): return true if the current object is an instance of the template class name argument
• Clone(): return an allocated copy of the object.

GETSample * GETSignalModifier::ProcessSample ( GETChannel &  channel, u_short  info  )

virtual

This function processes the argument channel and stores the result in the internal sample.

The channel sample that is processed depends on the info argument:

• if info == GET::signalTst, the channel input test sample is processed
• if info == GET::signalOut, the channel output sample is processed The function returns the internal result sample pointer. In case of error, the result is a NULL pointer.

Note

The channel samples are not modified, the result is stored in the process internal sample.

Parameters

channel	GET system channel to be processed
info	additional optional information (sample signal identifier)

Implements GETProcess.

References GETChannel::OutSample(), GETProcess::result_sample, GET::signalTst, and GETChannel::TstSample().

Referenced by GETChannel::ApplyOutputNoise(), GETChannel::ProcessOutFromTst(), and GETModifierSeq::ProcessSample().

virtual GETSample* GETSignalModifier::ProcessSample ( GETSample &  sample, GETSample &  result, GETChannel &  channel  )

pure virtual

This is the effective function that processes the input sample and stores the result in the result sample. This function must be defined in the derived classes.

Parameters

sample	input sample to be processed
result	sample where result should be stored
channel	GET system channel (the samples should correspond to this channel)

Implements GETProcess.

Implemented in GETModifierSeq, GETPhaseCorrection, GETAutoBaseline, GETFilterModifier, GETNoise, GETSampleWindow, GETAutoBLoffset, GETCalibProcess, and GETBaselineCorrection.

---

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

• GETSignalModifier.hh
• GETSignalModifier.cpp