GETAutoBLoffset Class Reference

#include <GETAutoBLoffset.hh>

Inheritance diagram for GETAutoBLoffset:

Public Member Functions
Constructors, affectation, destructor
	GETAutoBLoffset (GETObject &obj, u_short itmin=0, u_short itmax=0)
	GETAutoBLoffset (u_int n=0, double dt=0.01, u_short itmin=0, u_short itmax=0)
	GETAutoBLoffset (const GETAutoBLoffset &proc)
virtual	~GETAutoBLoffset ()
Process parameters
virtual void	SetOffsetRange (u_short itmin, u_short itmax)
Signal processing
virtual GETSample *	ProcessSample (GETSample &sample, GETSample &result, GETChannel &channel)
ROOT related functions
	ClassDef (GETAutoBLoffset, 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
u_short	bucket_max
	Uppet time bucket for offset estimate (excluded)
u_short	bucket_min
	Lower time bucket for offset estimate (included)
Protected Attributes inherited from GETProcess
u_int	options
	Option flags.
GETSample	result_sample
	Internal processing result sample (processing result)

Private Member Functions
	GObject (GETAutoBLoffset)

Detailed Description

This class defines an automatic base-line correction process.

The automatic baseline computes an average at the beginning of the sample and another average at the end of the sample, and use them to perform a linear subtraction to the signal.

Constructor & Destructor Documentation

GETAutoBLoffset::GETAutoBLoffset	(	GETObject &	obj,
		u_short	itmin = 0,
		u_short	itmax = 0
	)

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
itmin	lower time bucket for offset estimate (included)
itmax	upper time bucket for offset estimate (excluded)

References bucket_max, bucket_min, and SetOffsetRange().

GETAutoBLoffset::GETAutoBLoffset	(	u_int	n = 0,
		double	dt = 0.01,
		u_short	itmin = 0,
		u_short	itmax = 0
	)

Constructor. The baseline sample is initialized to 0.

Parameters

n	sampling size of the channels
dt	sampling period (us)
itmin	lower time bucket for offset estimate (included)
itmax	upper time bucket for offset estimate (excluded)

References bucket_max, bucket_min, and SetOffsetRange().

GETAutoBLoffset::GETAutoBLoffset

(

const GETAutoBLoffset &

proc

)

Copy constructor.

Parameters

proc	object to copy

References bucket_max, and bucket_min.

GETAutoBLoffset::~GETAutoBLoffset ( )

virtual

Destructor.

Member Function Documentation

GETAutoBLoffset::ClassDef	(	GETAutoBLoffset	,
		0
	)

for use within ROOT.

GETAutoBLoffset::GObject ( GETAutoBLoffset  )

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 * GETAutoBLoffset::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.

References bucket_max, and bucket_min.

void GETAutoBLoffset::SetOffsetRange ( u_short  itmin, u_short  itmax  )

virtual

Define the range for the low part of the sample to determine the baseline correction.

Parameters

itmin	lower time bucket for offset estimate (included)
itmax	upper time bucket for offset estimate (excluded)

References bucket_max, bucket_min, and GETProcess::GetDimension().

Referenced by GETAutoBLoffset().

---

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

• GETAutoBLoffset.hh
• GETAutoBLoffset.cpp