#include <GETFilterLowN.hh>

Inheritance diagram for GETFilterLowN:

Public Member Functions
Constructors, affectation, destructor
	GETFilterLowN (u_int n=0, double dt=0.01L, u_int nf=3, double fcut=0.L, double q=0.7071067811865475244008443621048490L)

	GETFilterLowN (const GETFilterLowN &proc)

virtual	~GETFilterLowN ()

Initialization functions
virtual void	SetOrder (u_int nf)

u_int	GetOrder () const

virtual void	UpdateFilter ()

ROOT related functions
	ClassDef (GETFilterLowN, 0)

Public Member Functions inherited from GETFilterLow2
	GETFilterLow2 (u_int n=0, double dt=0.01L, double fcut=0.L, double q=0.7071067811865475244008443621048490L)

	GETFilterLow2 (const GETFilterLow2 &proc)

virtual	~GETFilterLow2 ()

virtual void	SetQualityFactor (double q)

double	GetQualityFactor () const

	ClassDef (GETFilterLow2, 0)

Public Member Functions inherited from GETFilterCut
	GETFilterCut (GETObject &obj, double fcut=0.)

	GETFilterCut (u_int n=0, double dt=0.01, double fcut=0.)

	GETFilterCut (const GETFilterCut &proc)

virtual	~GETFilterCut ()

virtual void	SetCutFrequency (double fcut)

double	GetCutFrequency () const

virtual void	Init (u_int n, double dt)

	ClassDef (GETFilterCut, 0)

Public Member Functions inherited from GETFilter
	GETFilter (GETObject &obj)

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

	GETFilter (const GETFilter &proc)

	GETFilter (GETFilter &f1, GETFilter &f2)

virtual	~GETFilter ()

virtual void	Reset ()

virtual void	SetNormalized (bool b=true)

virtual void	Normalize (double norm=1.)

virtual void	Scale (double fact=1.)

const GETSample *	GetFilterPtr () const

GETSample *	GetFilterPtr ()

const GETSample &	GetFilter () const

GETSample &	GetFilter ()

virtual GETSample *	ProcessSample (GETChannel &channel, u_short info=GET::signalOut)

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

	ClassDef (GETFilter, 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)

u_int	GetDimension () const

double	GetSamplingTime () const

GETSample *	GetResultSamplePtr ()

const GETSample *	GetResultSamplePtr () const

GETSample &	GetResultSample ()

const GETSample &	GetResultSample () const

	ClassDef (GETProcess, 0)

Protected Attributes
u_int	order
	Filter order.

Protected Attributes inherited from GETFilterLow2
double	quality_factor
	Quality factor of the filter.

Protected Attributes inherited from GETFilterCut
double	cut_frequency
	Filter cut frequency.

Protected Attributes inherited from GETFilter
GETSample	filter_fct
	Filter function for an AGET channel.

Protected Attributes inherited from GETProcess
u_int	options
	Option flags.

GETSample	result_sample
	Internal processing result sample (processing result)

Private Member Functions
	GObject (GETFilterLowN)

Detailed Description

This class defines a low pass filter of order N. It is constructed as a composition of first and second order filters:

if N is even, N/2 second order filters;
if N is odd, (N-1)/2 second order filters and a first order filter.

All the filters used in the construction have the same cut frequency, and the second order filters have the same quality factor Q (see GETFilterLow2). For filters with different parameters, it is possible to use the base filter class GETFilter, with composition constructor.

Constructor & Destructor Documentation

GETFilterLowN::GETFilterLowN	(	u_int	n = `0`,
		double	dt = `0.01L`,
		u_int	nf = `3`,
		double	fcut = `0.L`,
		double	q = `0.7071067811865475244008443621048490L`
	)

Constructor.

Parameters

n	sampling size of the channels
dt	sampling period (us)
nf	filter order
fcut	cut frequency
q	quality factor

References GETFilterCut::cut_frequency, GETFilter::Init(), order, GETFilterLow2::quality_factor, and UpdateFilter().

GETFilterLowN::GETFilterLowN ( const GETFilterLowN & proc )

Copy constructor.

Parameters

proc	object to copy

References GETFilterCut::cut_frequency, GETFilterCut::GetCutFrequency(), GETFilter::GetFilter(), GetOrder(), GETFilterLow2::GetQualityFactor(), GETFilter::Init(), order, GETFilterLow2::quality_factor, and UpdateFilter().

GETFilterLowN::~GETFilterLowN ( )

virtual

Destructor.

Member Function Documentation

GETFilterLowN::ClassDef	(	GETFilterLowN	,
		0
	)

for use within ROOT.

u_int GETFilterLowN::GetOrder ( ) const

inline

Return the filter order.

References order.

Referenced by GETFilterLowN().

GETFilterLowN::GObject ( GETFilterLowN )

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.

void GETFilterLowN::SetOrder ( u_int nf )

virtual

Set the filter order.

Parameters

nf order

References GETProcess::GetDimension(), GETProcess::GetSamplingTime(), order, and UpdateFilter().

void GETFilterLowN::UpdateFilter ( )

virtual

Compute the filter sample.

Reimplemented from GETFilterLow2.

References GETFilterCut::cut_frequency, GETProcess::GetDimension(), GETFilter::GetFilter(), GETFilter::GetFilterPtr(), GETProcess::GetSamplingTime(), order, and GETFilterLow2::quality_factor.

Referenced by GETFilterLowN(), and SetOrder().

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