GET library
GETFilterGaus Class Reference

#include <GETFilterGaus.hh>

Inheritance diagram for GETFilterGaus:
GETFilterRef GETFilter GETProcess

Public Member Functions

Constructors, affectation, destructor
 GETFilterGaus (u_int n=0, double dt=0.01L, double fcut=0.L, double wid=0.L)
 
 GETFilterGaus (const GETFilterGaus &proc)
 
virtual ~GETFilterGaus ()
 
Initialization functions
virtual void Init (u_int n, double dt)
 
virtual void SetReference (double wid, double fcut=0.L)
 
virtual void UpdateFilter ()
 
double GetReferenceFWHM ()
 
ROOT related functions
 ClassDef (GETFilterGaus, 0)
 
- Public Member Functions inherited from GETFilterRef
 GETFilterRef (GETObject &obj, double fcut=0.)
 
 GETFilterRef (u_int n=0, double dt=0.01, double fcut=0.)
 
 GETFilterRef (const GETFilterRef &proc)
 
virtual ~GETFilterRef ()
 
virtual void SetCutFrequency (double fcut)
 
double GetCutFrequency ()
 
GETSampleGetReference ()
 
 ClassDef (GETFilterRef, 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 GETSampleGetFilterPtr () const
 
GETSampleGetFilterPtr ()
 
const GETSampleGetFilter () const
 
GETSampleGetFilter ()
 
virtual GETSampleProcessSample (GETChannel &channel, u_short info=GET::signalOut)
 
virtual GETSampleProcessSample (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
 
GETSampleGetResultSamplePtr ()
 
const GETSampleGetResultSamplePtr () const
 
GETSampleGetResultSample ()
 
const GETSampleGetResultSample () const
 
 ClassDef (GETProcess, 0)
 

Protected Attributes

double ref_fwhm
 Reference signal width (FWHM)
 
- Protected Attributes inherited from GETFilterRef
double cut_frequency
 Filter cut frequency.
 
GETSample ref_signal
 Reference Gaus signal.
 
- 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 (GETFilterGaus)
 

Detailed Description

This class defines a filter adapted for Gauss signal.

It is based on the optimal filter, considering constant noise spectral density, corresponding to the reference signal PSD at cut frequency (see figure for GETFilterRef).

Examples:
TestChannel.C.

Constructor & Destructor Documentation

GETFilterGaus::GETFilterGaus ( u_int  n = 0,
double  dt = 0.01L,
double  fcut = 0.L,
double  wid = 0.L 
)

Constructor.

Parameters
nsampling size of the channels
dtsampling period (us)
fcutcut frequency
widwidth (FWHM) of reference signal

References ref_fwhm, and UpdateFilter().

GETFilterGaus::GETFilterGaus ( const GETFilterGaus proc)

Copy constructor.

Parameters
procobject to copy

References ref_fwhm, and UpdateFilter().

GETFilterGaus::~GETFilterGaus ( )
virtual

Destructor.

Member Function Documentation

GETFilterGaus::ClassDef ( GETFilterGaus  ,
 
)

for use within ROOT.

double GETFilterGaus::GetReferenceFWHM ( )
inline

Return the reference signal width (FWHM).

References ref_fwhm.

GETFilterGaus::GObject ( GETFilterGaus  )
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 GETFilterGaus::Init ( u_int  n,
double  dt 
)
virtual

Initialization of response function sample. If the analytical function is defined, the response function sample is computed.

Parameters
nsampling size of the function
dtsampling time step

Reimplemented from GETFilterRef.

References GETFilter::Init(), and UpdateFilter().

void GETFilterGaus::SetReference ( double  wid,
double  fcut = 0.L 
)
virtual

Set the filter paremeters.

Parameters
widwidth (FWHM) of reference signal
fcutcut frequency (not changed if 0)

References GETProcess::GetDimension(), GETFilter::GetFilter(), GETProcess::GetSamplingTime(), ref_fwhm, GETFilterRef::SetCutFrequency(), and UpdateFilter().

void GETFilterGaus::UpdateFilter ( )
virtual

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