GETBaselineCorrection Class Reference

#include <GETBaselineCorrection.hh>

Inheritance diagram for GETBaselineCorrection:

Public Member Functions
Constructors, affectation, destructor
	GETBaselineCorrection (GETObject &obj)
	GETBaselineCorrection (u_int n=0, double dt=0.01)
	GETBaselineCorrection (const GETSample &ped)
	GETBaselineCorrection (const GETBaselineCorrection &proc)
virtual	~GETBaselineCorrection ()
Process parameters
const GETSample &	GetBaseline () const
GETSample &	GetBaseline ()
virtual void	SetBaseline (const GETSample &ped)
Signal processing
virtual GETSample *	ProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)
ROOT related functions
	ClassDef (GETBaselineCorrection, 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 GETSample *	ProcessSample (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
GETSample *	GetResultSamplePtr ()
const GETSample *	GetResultSamplePtr () const
GETSample &	GetResultSample ()
const GETSample &	GetResultSample () const
	ClassDef (GETProcess, 0)

Protected Attributes
GETSample	baseline
	Baseline sample data.
Protected Attributes inherited from GETProcess
u_int	options
	Option flags.
GETSample	result_sample
	Internal processing result sample (processing result)

Private Member Functions
	GObject (GETBaselineCorrection)

Detailed Description

This class defines a base-line correction process, acting as an output noise process.

Constructor & Destructor Documentation

GETBaselineCorrection::GETBaselineCorrection

(

GETObject &

obj

)

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

Parameters

obj	a core object of the GET system

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

Constructor. The baseline sample is initialized to 0.

Parameters

n	sampling size of the channels
dt	sampling period (us)

GETBaselineCorrection::GETBaselineCorrection

(

const GETSample &

ped

)

Constructor. The sample parameters (size and period) are taken from the pedestal sample.

Parameters

ped	pedestal (baseline) sample

References baseline.

GETBaselineCorrection::GETBaselineCorrection

(

const GETBaselineCorrection &

proc

)

Copy constructor.

Parameters

proc	object to copy

References baseline, and GetBaseline().

GETBaselineCorrection::~GETBaselineCorrection ( )

virtual

Destructor.

Member Function Documentation

GETBaselineCorrection::ClassDef	(	GETBaselineCorrection	,
		0
	)

for use within ROOT.

const GETSample & GETBaselineCorrection::GetBaseline ( ) const

inline

Return the baseline sample.

References baseline.

Referenced by GETBaselineCorrection().

GETSample & GETBaselineCorrection::GetBaseline ( )

inline

Return the baseline sample.

References baseline.

GETBaselineCorrection::GObject ( GETBaselineCorrection  )

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 * GETBaselineCorrection::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

sample	input sample to be processed
result	sample where result should be stored
channel	GET system channel (no use in this class)

Implements GETSignalModifier.

Reimplemented in GETPhaseCorrection.

References baseline.

void GETBaselineCorrection::SetBaseline ( const GETSample &  ped )

inlinevirtual

Set the baseline sample.

Parameters

ped	pedestal sample to be subtracted

References baseline.

---

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

• GETBaselineCorrection.hh
• GETBaselineCorrection.cpp
• GETBaselineCorrection.icc