GET library
GETFilterRef Class Referenceabstract

#include <GETFilterRef.hh>

Inheritance diagram for GETFilterRef:
GETFilter GETProcess GETFilterAget GETFilterAgetGaus GETFilterGaus

Public Member Functions

Constructors, affectation, destructor
 GETFilterRef (GETObject &obj, double fcut=0.)
 
 GETFilterRef (u_int n=0, double dt=0.01, double fcut=0.)
 
 GETFilterRef (const GETFilterRef &proc)
 
virtual ~GETFilterRef ()
 
Initialization functions
virtual void Init (u_int n, double dt)
 
virtual void SetCutFrequency (double fcut)
 
virtual void UpdateFilter ()=0
 
double GetCutFrequency ()
 
GETSampleGetReference ()
 
ROOT related functions
 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 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

 GObjectV (GETFilterRef)
 

Detailed Description

This class defines a filter adapted for a refence signal.

It is based on the optimal filter, considering constant noise spectral density, corresponding to the reference signal PSD at cut frequency.

The picture below shows the construction of such a filter for a Gauss reference signal.

FilterGaus.png

Constructor & Destructor Documentation

GETFilterRef::GETFilterRef ( GETObject obj,
double  fcut = 0. 
)

Constructor. The dimension of the first channel of the object is used for the process definition.

Parameters
obja core object of the GET system
fcutcut frequency

References cut_frequency.

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

Constructor.

Parameters
nsampling size of the channels
dtsampling period (us)
fcutcut frequency

References cut_frequency.

GETFilterRef::GETFilterRef ( const GETFilterRef proc)

Copy constructor.

Parameters
procobject to copy

References cut_frequency.

GETFilterRef::~GETFilterRef ( )
virtual

Destructor.

Member Function Documentation

GETFilterRef::ClassDef ( GETFilterRef  ,
 
)

for use within ROOT.

double GETFilterRef::GetCutFrequency ( )
inline

Return the cut frequency.

References cut_frequency.

GETSample & GETFilterRef::GetReference ( )
inline

Return the reference signal sample.

References ref_signal.

GETFilterRef::GObjectV ( GETFilterRef  )
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 GETFilterRef::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 GETFilter.

Reimplemented in GETFilterAgetGaus, GETFilterAget, and GETFilterGaus.

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

void GETFilterRef::SetCutFrequency ( double  fcut)
inlinevirtual

Set the cut frequency.

Parameters
fcutcut frequency

References cut_frequency.

Referenced by GETFilterGaus::SetReference(), GETFilterAget::SetReference(), and GETFilterAgetGaus::SetReference().

virtual void GETFilterRef::UpdateFilter ( )
pure virtual

Compute the reference and the filter sample.

Implemented in GETFilterAgetGaus, GETFilterAget, and GETFilterGaus.

Referenced by Init().


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