GETNoise Class Reference

#include <GETNoise.hh>

Inheritance diagram for GETNoise:

Public Member Functions
Constructors, affectation, destructor
	GETNoise (GETObject &obj, double wid=0., double off=0.)
	GETNoise (u_int n=0, double dt=0.01, double wid=0., double off=0.)
	GETNoise (const GETNoise &proc)
virtual	~GETNoise ()
Process parameters
void	SetWidth (double wid)
void	SetOffset (double off)
Signal processing
virtual GETSample *	ProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)
ROOT related functions
	ClassDef (GETNoise, 0)
Public Member Functions inherited from GETSignalModifier
	GETSignalModifier (GETObject &obj)
	GETSignalModifier (u_int n=0, double dt=0.01)
	GETSignalModifier (const GETSignalModifier &proc)
virtual	~GETSignalModifier ()
virtual GETSample *	ProcessSample (GETChannel &channel, u_short info)
	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)

Protected Attributes
double	offset
	Signal offset.
double	width
	Fluctuation width (FWHM)
Protected Attributes inherited from GETProcess
u_int	options
	Option flags.
GETSample	result_sample
	Internal processing result sample (processing result)

Private Member Functions
	GObject (GETNoise)

Detailed Description

This class defines Gauss random noise with an optional offset of the signal.

Examples:

TestChannel.C.

Constructor & Destructor Documentation

GETNoise::GETNoise	(	GETObject &	obj,
		double	wid = 0.,
		double	off = 0.
	)

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
wid	fluctuation width
off	signal offset

References offset, and width.

GETNoise::GETNoise	(	u_int	n = 0,
		double	dt = 0.01,
		double	wid = 0.,
		double	off = 0.
	)

Constructor.

Parameters

n	sampling size of the channels
dt	sampling period (us)
wid	fluctuation width
off	signal offset

References offset, and width.

GETNoise::GETNoise

(

const GETNoise &

proc

)

Copy constructor.

Parameters

proc	object to copy

References offset, and width.

GETNoise::~GETNoise ( )

virtual

Destructor.

Member Function Documentation

GETNoise::ClassDef	(	GETNoise	,
		0
	)

for use within ROOT.

GETNoise::GObject ( GETNoise  )

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 * GETNoise::ProcessSample ( GETSample &  sample, GETSample &  result, GETChannel &  channel  )

virtual

This function process the input sample channel and stores the result in the result sample (convolution or deconvolution of the response function, according to inv argument).

The function returns the (argument) result sample sample pointer. In case of error, the result is a NULL pointer.

Note

• The sample to be processed and the result sample can be the same object, in which case the initial sample is replaced by the processing result.
• The initial and result samples may be the same object, in which case the sample is replaced by the result.

Parameters

sample	input sample to be processed
result	sample where result should be stored
channel	GET system channel (no use in this class)

Implements GETSignalModifier.

Examples:

TestChannel.C.

References GETRandom, offset, and width.

void GETNoise::SetOffset ( double  off )

inline

Set the signal offset.

Parameters

off	offset value

References offset.

void GETNoise::SetWidth ( double  wid )

inline

Set the noise amplitude.

Parameters

wid	amplitude of random fluctuations

References width.

---

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

• GETNoise.hh
• GETNoise.cpp
• GETNoise.icc