#include <GETSampleWindow.hh>

Inheritance diagram for GETSampleWindow:

Public Member Functions
Constructors, affectation, destructor
	GETSampleWindow (GETObject &obj)

	GETSampleWindow (u_int n=0, double dt=0.01)

	GETSampleWindow (GETSample &w)

	GETSampleWindow (const GETSampleWindow &proc)

virtual	~GETSampleWindow ()

Signal windowing function
const GETSample &	GetWindow () const

GETSample &	GetWindow ()

void	ClearWindow ()

int	SetWindow (const GETSample &w)

int	SetWindowHann ()

int	ApplyWindow (GETSample &sample, GETSample &result)

Signal processing
virtual GETSample *	ProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)

ROOT related functions
	ClassDef (GETSampleWindow, 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
GETSample	window
	Sample for windowing the signal.

Protected Attributes inherited from GETProcess
u_int	options
	Option flags.

GETSample	result_sample
	Internal processing result sample (processing result)

Private Member Functions
	GObject (GETSampleWindow)

Detailed Description

This class defines a windowing process for samples.

Constructor & Destructor Documentation

GETSampleWindow::GETSampleWindow ( 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

References ClearWindow(), GETObject::GetSampleDim(), GETObject::GetTimeStep(), and window.

GETSampleWindow::GETSampleWindow	(	u_int	n = `0`,
		double	dt = `0.01`
	)

Constructor.

Parameters

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

References ClearWindow(), and window.

GETSampleWindow::GETSampleWindow ( GETSample & w )

Constructor.

Parameters

w	window sample data

References SetWindow().

GETSampleWindow::GETSampleWindow ( const GETSampleWindow & proc )

Copy constructor.

Parameters

proc	object to copy

GETSampleWindow::~GETSampleWindow ( )

virtual

Destructor.

Member Function Documentation

int GETSampleWindow::ApplyWindow	(	GETSample &	sample,
		GETSample &	result
	)

Apply the windowing to a sample.

Parameters

sample	input sample on which to apply the window
result	result sample

References window.

Referenced by ProcessSample().

GETSampleWindow::ClassDef	(	GETSampleWindow	,
		0
	)

for use within ROOT.

void GETSampleWindow::ClearWindow ( )

Remove the windowing of the signal modifier.

References window.

Referenced by GETSampleWindow(), SetWindow(), and SetWindowHann().

const GETSample & GETSampleWindow::GetWindow ( ) const

inline

Return the pointer to the windowing sample.

References window.

GETSample & GETSampleWindow::GetWindow ( )

inline

Return the pointer to the windowing sample.

References window.

GETSampleWindow::GObject ( GETSampleWindow )

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 * GETSampleWindow::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.

References ApplyWindow().

int GETSampleWindow::SetWindow ( const GETSample & w )

Set a windowing for the modifier process. The windowing is applied after the specific signal modification defined in derived classes. The window must have the same sampling than the modifier samples.

Parameters

w	window sample

References ClearWindow(), GETProcess::result_sample, and window.

Referenced by GETSampleWindow().

int GETSampleWindow::SetWindowHann ( )

Set a Hann window.

References ClearWindow(), GETProcess::GetDimension(), GETProcess::GetSamplingTime(), GETProcess::result_sample, and window.

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation