GET library
GETResponse Class Reference

#include <GETResponse.hh>

Inheritance diagram for GETResponse:
GETProcess GETResponseFct GETResponseFctAget

Public Member Functions

Constructors, affectation, destructor
 GETResponse (GETObject &obj)
 
 GETResponse (u_int n=0, double dt=0.01)
 
 GETResponse (const GETResponse &proc)
 
virtual ~GETResponse ()
 
Initialization functions
virtual void Reset ()
 
virtual void Init (u_int n, double dt)
 
Access to class data
const GETSampleGetResponsePtr () const
 
GETSampleGetResponsePtr ()
 
const GETSampleGetResponse () const
 
GETSampleGetResponse ()
 
Signal processing
virtual GETSampleProcessSample (GETChannel &channel, u_short info)
 
virtual GETSampleProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)
 
virtual GETSampleProcessSample (GETSample &sample, GETSample &result, GETChannel &channel, bool inv)
 
ROOT related functions
 ClassDef (GETResponse, 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

GETSample response_fct
 Response 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 (GETResponse)
 

Detailed Description

This class defines a simple response function for the GET input signal. The response is defined by the sample for convolution / deconvolution of input (test) / output signals.

Constructor & Destructor Documentation

GETResponse::GETResponse ( GETObject obj)

Constructor: the dimension of the first channel of the object is used for the process definition. At initialization, the default response function is set to reproduce the input signal (full band filter).

Parameters
obja core object of the GET system

References GETObject::GetSampleDim(), GETObject::GetTimeStep(), and Init().

GETResponse::GETResponse ( u_int  n = 0,
double  dt = 0.01 
)

Constructor. At initialization, the default response function is set to reproduce the input signal (full band filter).

Parameters
nsampling size of the channels
dtsampling period (us)

References Init().

GETResponse::GETResponse ( const GETResponse proc)

Copy constructor.

Parameters
procobject to copy

References GetResponse(), and response_fct.

GETResponse::~GETResponse ( )
virtual

Destructor.

Member Function Documentation

GETResponse::ClassDef ( GETResponse  ,
 
)

for use within ROOT.

const GETSample & GETResponse::GetResponse ( ) const
inline

Return the response function sample (by reference).

Examples:
TestChannel.C.

References response_fct.

Referenced by GETResponse().

GETSample & GETResponse::GetResponse ( )
inline

Return the response function sample (by reference).

References response_fct.

const GETSample * GETResponse::GetResponsePtr ( ) const
inline

Return the pointer to the response function sample.

References response_fct.

GETSample * GETResponse::GetResponsePtr ( )
inline

Return the pointer to the response function sample.

References response_fct.

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

Initialization of response function sample.

Parameters
nsampling size of the function
dtsampling time step

Reimplemented from GETProcess.

Reimplemented in GETResponseFct.

References response_fct, and GETProcess::result_sample.

Referenced by GETResponse(), and GETResponseFct::Init().

GETSample * GETResponse::ProcessSample ( GETChannel channel,
u_short  info 
)
virtual

This function process the argument channel and stores the result in the internal sample. The channel sample that is processed depends on the info argument:

  • if info == GET::signalTst, the input test sample is convoluted with the response function
  • if info == GET::signalOut, the output sample is deconvoluted with the response function The function returns the internal result sample pointer. In case of error, the result is a NULL pointer.

For the base response function class, the processing is the convolution or the deconvolution with the response function sample data.

Parameters
channelGET system channel to be processed
infoadditional optional information (sample signal identifier)

Implements GETProcess.

Examples:
TestChannel.C.

References GETChannel::OutSample(), GETProcess::result_sample, GET::signalOut, GET::signalTst, and GETChannel::TstSample().

Referenced by GETChannel::ProcessOutFromTst(), GETChannel::ProcessRecFromOut(), and ProcessSample().

GETSample * GETResponse::ProcessSample ( GETSample sample,
GETSample result,
GETChannel channel 
)
inlinevirtual

This function process the input sample channel and stores the result in the result sample (convolution with response function). The channel argument is provided if processing (from derived classes) may be affected by GET core objects properties. The function returns the (argument) result sample sample pointer. In case of error, the result is a NULL pointer.

For the base filter class, the processing is the convolution with the response function sample data (see function with bool argument for deconvolution).

Parameters
sampleinput sample to be processed
resultsample where result should be stored
channelGET system channel to be processed

Implements GETProcess.

References ProcessSample().

GETSample * GETResponse::ProcessSample ( GETSample sample,
GETSample result,
GETChannel channel,
bool  inv 
)
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 channel argument is provided if processing (from derived classes) may be affected by GET core objects properties. The function returns the (argument) result sample sample pointer. In case of error, the result is a NULL pointer.

For the base response function class, the processing is the convolution or the deconvolution with the response function sample data.

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
sampleinput sample to be processed
resultsample where result should be stored
channelGET system channel to be processed
invdeconvolution instead of convolution

References response_fct.

void GETResponse::Reset ( )
virtual

Function resetting the response function.

References response_fct, and GETProcess::result_sample.


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