GETFilterModifier Class Reference

#include <GETFilterModifier.hh>

Inheritance diagram for GETFilterModifier:

Public Member Functions
Constructors, affectation, destructor
	GETFilterModifier (GETObject &obj, GETFilter *filt=NULL)
	GETFilterModifier (u_int n=0, double dt=0.01, GETFilter *filt=NULL)
	GETFilterModifier (const GETFilterModifier &proc)
virtual	~GETFilterModifier ()
Process parameters
virtual void	SetFilter (GETFilter *filt)
virtual const GETFilter *	GetFilter () const
virtual GETFilter *	GetFilter ()
Signal processing
virtual GETSample *	ProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)
ROOT related functions
	ClassDef (GETFilterModifier, 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
GETFilter *	filter
	Pointer to the filter process.
Protected Attributes inherited from GETProcess
u_int	options
	Option flags.
GETSample	result_sample
	Internal processing result sample (processing result)

Private Member Functions
	GObject (GETFilterModifier)

Detailed Description

This class defines a signal correction process using a filter process.

It can then be used to apply a filter, considered as output signal correction.

Constructor & Destructor Documentation

GETFilterModifier::GETFilterModifier	(	GETObject &	obj,
		GETFilter *	filt = NULL
	)

Constructor. The dimension of the first channel of the object is used for the process definition. The filter is adopted by the object, and deleted with it.

Parameters

obj	a core object of the GET system
filt	pointer to the filter associated to the modifier

References filter, and SetFilter().

GETFilterModifier::GETFilterModifier	(	u_int	n = 0,
		double	dt = 0.01,
		GETFilter *	filt = NULL
	)

Constructor. The filter is adopted by the object, and deleted with it.

Parameters

n	sampling size of the channels
dt	sampling period (us)
filt	pointer to the filter associated to the modifier

References filter, and SetFilter().

GETFilterModifier::GETFilterModifier

(

const GETFilterModifier &

proc

)

Copy constructor.

Parameters

proc	object to copy

References GetFilter(), and SetFilter().

GETFilterModifier::~GETFilterModifier ( )

virtual

Destructor.

Member Function Documentation

GETFilterModifier::ClassDef	(	GETFilterModifier	,
		0
	)

for use within ROOT.

const GETFilter * GETFilterModifier::GetFilter ( ) const

inlinevirtual

Return the pointer to the filter of the modifier process.

References filter.

Referenced by GETFilterModifier().

GETFilter * GETFilterModifier::GetFilter ( )

inlinevirtual

Return the pointer to the filter of the modifier process.

References filter.

GETFilterModifier::GObject ( GETFilterModifier  )

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

virtual

This function process the input sample channel and stores the result in the result sample.

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.

void GETFilterModifier::SetFilter ( GETFilter *  filt )

virtual

Function setting the filter of the modifier process. The filter is adopted by the object, and deleted with it.

Parameters

filt	pointer to the filter associated to the modifier

References filter.

Referenced by GETFilterModifier().

---

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

• GETFilterModifier.hh
• GETFilterModifier.cpp
• GETFilterModifier.icc