GET library
GETCalibProcess Class Reference

#include <GETCalibProcess.hh>

Inheritance diagram for GETCalibProcess:
GETSignalModifier GETProcess

Public Member Functions

Constructors, affectation, destructor
 GETCalibProcess (GETObject &obj, double a0=0., double a1=1.)
 
 GETCalibProcess (u_int n=0, double dt=0.01, double a0=0., double a1=1.)
 
 GETCalibProcess (const GETCalibProcess &proc)
 
virtual ~GETCalibProcess ()
 
Process parameters
u_short GetDegree () const
 
virtual void SetDegree (u_short d)
 
double GetCoefficient (u_short i) const
 
void SetCoefficient (u_short i, double c)
 
Signal processing
virtual GETSampleProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)
 
ROOT related functions
 ClassDef (GETCalibProcess, 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 GETSampleProcessSample (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
 
GETSampleGetResultSamplePtr ()
 
const GETSampleGetResultSamplePtr () const
 
GETSampleGetResultSample ()
 
const GETSampleGetResultSample () const
 
 ClassDef (GETProcess, 0)
 

Protected Attributes

double * coef
 Calibration coefficients array.
 
u_short degree
 Polynomial degree of the calibration.
 
- Protected Attributes inherited from GETProcess
u_int options
 Option flags.
 
GETSample result_sample
 Internal processing result sample (processing result)
 

Private Member Functions

 GObject (GETCalibProcess)
 

Detailed Description

This class defines a (linear) calibration process.

Constructor & Destructor Documentation

GETCalibProcess::GETCalibProcess ( GETObject obj,
double  a0 = 0.,
double  a1 = 1. 
)

Constructor. The dimension of the first channel of the object is used for the process definition. The baseline sample is initialized to 0.

Parameters
obja core object of the GET system
a0degree 0 coefficient (offset)
a1degree 1 coefficient (linear term)

References coef, and SetDegree().

GETCalibProcess::GETCalibProcess ( u_int  n = 0,
double  dt = 0.01,
double  a0 = 0.,
double  a1 = 1. 
)

Constructor. The baseline sample is initialized to 0.

Parameters
nsampling size of the channels
dtsampling period (us)
a0degree 0 coefficient (offset)
a1degree 1 coefficient (linear term)

References coef, and SetDegree().

GETCalibProcess::GETCalibProcess ( const GETCalibProcess proc)

Copy constructor.

Parameters
procobject to copy

References coef, degree, GetDegree(), and SetDegree().

GETCalibProcess::~GETCalibProcess ( )
virtual

Destructor.

Member Function Documentation

GETCalibProcess::ClassDef ( GETCalibProcess  ,
 
)

for use within ROOT.

double GETCalibProcess::GetCoefficient ( u_short  i) const
inline

Return a calibration coefficient.

Parameters
idegree of the coefficient

References coef, and degree.

u_short GETCalibProcess::GetDegree ( ) const
inline

Return the polynomial degree of the calibration.

References degree.

Referenced by GETCalibProcess().

GETCalibProcess::GObject ( GETCalibProcess  )
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 * GETCalibProcess::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
sampleinput sample to be processed
resultsample where result should be stored
channelGET system channel (no use in this class)

Implements GETSignalModifier.

References coef, and GETRandom.

void GETCalibProcess::SetCoefficient ( u_short  i,
double  c 
)
inline

Set a calibration coefficient.

Parameters
idegree of the coefficient
cvalue of the coefficient

References coef, and degree.

Referenced by GETSystem::SetCalibProcess().

void GETCalibProcess::SetDegree ( u_short  d)
virtual

Set the polynomial degree of the calibration. The array of coefficients is allocated.

Parameters
dpolynomial degree

References coef, and degree.

Referenced by GETCalibProcess(), and GETSystem::SetCalibProcess().


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