emcCalibrator Class Reference
[Old calibration software]

#include <emcCalibrator.h>

Inherited by emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.

Inheritance diagram for emcCalibrator:

[legend]List of all members.

Detailed Description

(OLD) Virtual base class of a calibrator.

This class defines the old calibration interface.

Deprecated:: (as soon as online code does not need it anylonger). See emcDataProcessor instead.

Definition at line 30 of file emcCalibrator.h.

Public Member Functions

emcCalibrator ()

ctor

virtual ~emcCalibrator ()

virtual bool Calibrate (const emcRawDataObject &rdo, emcMixedDataObject &mdo, const PHTimeStamp &when)=0

Calibrate interface going from RawDataObject to MixedDataObject.

virtual bool Calibrate (const emcMixedDataObject &mdo, emcCalibratedDataObject &cdo, const PHTimeStamp &when)=0

Calibrate interface going from MixedDataObject to CalibratedDataObject.

virtual bool Calibrate (const emcRawDataObject &rdo, emcCalibratedDataObject &cdo, const PHTimeStamp &when)=0

short cut to go from raw to calibrated

virtual void ForceDBCollection (const PHTimeStamp &)

virtual float GetThresholdADC (void) const

Get ADC threshold (below this threshold we do not try to calibrate energy).

virtual float GetGlobalT0 (void) const

Get Global T0 value.

virtual float GetGlobalT0 (int index) const

returns tower dependent corrections to T0

virtual bool GetCollectionStatus (const char *) const

Get status of last try of collecting calibration data.

virtual int GetHighLowLimit (void) const

Get ADC channel count limit between high and low gain.

virtual const char * GetName (void) const

Get the name of this calibrator.

virtual int GetVerbose (void) const

Get verbose level.

virtual void Print (void) const =0

A print utility to inform what the calibrator is doing.

virtual void printData (const emcRawDataObject &rdo, const int towerId) const =0

the print utility to print data for individual tower

virtual void Reset (void)=0

Make this calibrator a brand new fresh baby just born (got it?).

virtual bool SelectSource (const char *type, emcManageable::EStorage source)=0

Select the source of calibration data.

virtual void SetExtraRejectListFilename (const char *=0)

Set the filename of a file containing a list of extra towers to be rejected, as compared to those in Q&A objects.

virtual void SetSMBasedCorrectionFilename (const char *="")

Set the filename of a file containing a list of corrections to be applied to calibration coefficients in individual supermodules.

virtual void SetGlobalT0 (float T0=0.0)

Set Global T0.

virtual void SetTwrGlobalT0 (char *filename=0)

Set Global T0 for every calorimeter Tower.

virtual void SetThresholdADC (float thres=10.)

Set ADC threshold.

virtual void SetHighLowLimit (int lim=1024)

Set ADC channel count limit between high and low gain.

virtual void SetVerbose (int level=0)

Set the verbose level.

void SetZeroSuppression (bool swi=true)

switches on and off the zero suppression flag

Bool_t GetZeroSuppression ()

void SetUseAmpPedestals (Bool_t flag=false)

Sets UseAmplitudePedestals flag (default - false, no pre/post pedestal subtruction in amplitude measurements).

Bool_t GetUseAmpPedestals ()

Sets USE-ONLY-LOW-GAIN flag (default - false, unless otherwise agreed - this is for monitoring purposes only).

void SetUseOnlyLowGain (Bool_t flag=false)

Bool_t GetUseOnlyLowGain ()

Protected Attributes

std::string fName

Name of the calibrator.

Bool_t fZeroSuppression

tells if zero's should be suppressed from raw data

Bool_t fUseAmpPedestals

tells Calibrator to subtruct pedestals from pre and post amplitude measurements

Bool_t fUseOnlyLowGain

tells Calibrator NOT TO USE HIGH GAINS AND High-to-Low GAIN ratios

int fVerbose

Verbosity level.

float * fTwrGlobalT0

Private Attributes

int fHLLimit

ADC channel count limit between high and low gain.

float fThresholdADC

ADC threshold.

float fGlobalT0

GlobalT0.

Constructor & Destructor Documentation

emcCalibrator::emcCalibrator ( ) [inline]

ctor

Definition at line 36 of file emcCalibrator.h.
References fName, fTwrGlobalT0, SetGlobalT0(), SetHighLowLimit(), SetThresholdADC(), SetUseAmpPedestals(), SetUseOnlyLowGain(), and SetVerbose().

virtual emcCalibrator::~emcCalibrator ( ) [inline, virtual]

Definition at line 47 of file emcCalibrator.h.

Member Function Documentation

virtual bool emcCalibrator::Calibrate ( const emcRawDataObject & rdo,

emcCalibratedDataObject & cdo,

const PHTimeStamp & when

) [pure virtual]

short cut to go from raw to calibrated

Implemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.

virtual bool emcCalibrator::Calibrate ( const emcMixedDataObject & mdo,

emcCalibratedDataObject & cdo,

const PHTimeStamp & when

) [pure virtual]

Calibrate interface going from MixedDataObject to CalibratedDataObject.

Implemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.

virtual bool emcCalibrator::Calibrate ( const emcRawDataObject & rdo,

emcMixedDataObject & mdo,

const PHTimeStamp & when

) [pure virtual]

Calibrate interface going from RawDataObject to MixedDataObject.

Implemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.
Referenced by mEmcCalibratorModule::event().

virtual void emcCalibrator::ForceDBCollection ( const PHTimeStamp & ) [inline, virtual]

Reimplemented in emcRawDataCalibratorV1.
Definition at line 69 of file emcCalibrator.h.
Referenced by mEmcCalibratorModule::ForceDBCollection().

virtual bool emcCalibrator::GetCollectionStatus ( const char * ) const [inline, virtual]

Get status of last try of collecting calibration data.

Reimplemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.
Definition at line 99 of file emcCalibrator.h.
Referenced by mEmcCalibratorModule::event().

virtual float emcCalibrator::GetGlobalT0 ( int index ) const [inline, virtual]

returns tower dependent corrections to T0

Definition at line 93 of file emcCalibrator.h.
References fTwrGlobalT0.

virtual float emcCalibrator::GetGlobalT0 ( void ) const [inline, virtual]

Get Global T0 value.
which in principle may be run dependent and which is needed almost entirely for presentation purposes (also if we want to use timing in Clustering and need it to be approximately correct)
Definition at line 87 of file emcCalibrator.h.
References fGlobalT0.
Referenced by emcRawDataCalibratorV2::CalibrateTime(), emcRawDataCalibratorV1::CalibrateTime(), and emcRawDataCalibrator::CalibrateTime().

virtual int emcCalibrator::GetHighLowLimit ( void ) const [inline, virtual]

Get ADC channel count limit between high and low gain.

Definition at line 105 of file emcCalibrator.h.
References fHLLimit.
Referenced by emcRawDataCalibratorV2::Print(), emcRawDataCalibratorV1::Print(), and emcRawDataCalibrator::Print().

virtual const char* emcCalibrator::GetName ( void ) const [inline, virtual]

Get the name of this calibrator.
(has to be the classname, so the CalibratorFactory can detect changes).
Definition at line 113 of file emcCalibrator.h.
References fName.
Referenced by emcCalibratorFactory::Initialize().

virtual float emcCalibrator::GetThresholdADC ( void ) const [inline, virtual]

Get ADC threshold (below this threshold we do not try to calibrate energy).

Definition at line 78 of file emcCalibrator.h.
References fThresholdADC.
Referenced by emcRawDataCalibratorV2::Print(), emcRawDataCalibratorV1::Print(), and emcRawDataCalibrator::Print().

Bool_t emcCalibrator::GetUseAmpPedestals ( ) [inline]

Sets USE-ONLY-LOW-GAIN flag (default - false, unless otherwise agreed - this is for monitoring purposes only).

Definition at line 195 of file emcCalibrator.h.
References fUseAmpPedestals.

Bool_t emcCalibrator::GetUseOnlyLowGain ( ) [inline]

Definition at line 201 of file emcCalibrator.h.
References fUseOnlyLowGain.

virtual int emcCalibrator::GetVerbose ( void ) const [inline, virtual]

Get verbose level.

Definition at line 119 of file emcCalibrator.h.
References fVerbose.

Bool_t emcCalibrator::GetZeroSuppression ( ) [inline]

Definition at line 186 of file emcCalibrator.h.
References fZeroSuppression.

virtual void emcCalibrator::Print ( void ) const [pure virtual]

A print utility to inform what the calibrator is doing.

Implemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.
Referenced by mEmcRecoModuleRealYear3::setup(), and mEmcRecoModuleRealYear2::setupAna().

virtual void emcCalibrator::printData ( const emcRawDataObject & rdo,

const int towerId

) const [pure virtual]

the print utility to print data for individual tower

Implemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.

virtual void emcCalibrator::Reset ( void ) [pure virtual]

Make this calibrator a brand new fresh baby just born (got it?).

Implemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.

virtual bool emcCalibrator::SelectSource ( const char * type,

emcManageable::EStorage source

) [pure virtual]

Select the source of calibration data.

Implemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.
Referenced by mEmcCalibratorModule::SelectSource().

virtual void emcCalibrator::SetExtraRejectListFilename ( const char * = 0 ) [inline, virtual]

Set the filename of a file containing a list of extra towers to be rejected, as compared to those in Q&A objects.

Reimplemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.
Definition at line 138 of file emcCalibrator.h.
Referenced by mEmcRecoModuleRealYear3::setup(), and mEmcRecoModuleRealYear2::setupAna().

virtual void emcCalibrator::SetGlobalT0 ( float T0 = 0.0 ) [inline, virtual]

Set Global T0.

Definition at line 147 of file emcCalibrator.h.
References fGlobalT0.
Referenced by emcCalibrator().

virtual void emcCalibrator::SetHighLowLimit ( int lim = 1024 ) [inline, virtual]

Set ADC channel count limit between high and low gain.

Definition at line 169 of file emcCalibrator.h.
References fHLLimit.
Referenced by emcCalibrator(), and mEmcCalibratorModule::SetHighLowLimit().

virtual void emcCalibrator::SetSMBasedCorrectionFilename ( const char * = "" ) [inline, virtual]

Set the filename of a file containing a list of corrections to be applied to calibration coefficients in individual supermodules.

Reimplemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.
Definition at line 142 of file emcCalibrator.h.

virtual void emcCalibrator::SetThresholdADC ( float thres = 10. ) [inline, virtual]

Set ADC threshold.

Definition at line 162 of file emcCalibrator.h.
References fThresholdADC.
Referenced by emcCalibrator().

virtual void emcCalibrator::SetTwrGlobalT0 ( char * filename = 0 ) [inline, virtual]

Set Global T0 for every calorimeter Tower.
(implementation is user dependent) - DEFAULT - ZERO.
Reimplemented in emcRawDataCalibrator, emcRawDataCalibratorV1, and emcRawDataCalibratorV2.
Definition at line 154 of file emcCalibrator.h.
References fTwrGlobalT0.

void emcCalibrator::SetUseAmpPedestals ( Bool_t flag = false ) [inline]

Sets UseAmplitudePedestals flag (default - false, no pre/post pedestal subtruction in amplitude measurements).

Definition at line 189 of file emcCalibrator.h.
References fUseAmpPedestals.
Referenced by emcCalibrator().

void emcCalibrator::SetUseOnlyLowGain ( Bool_t flag = false ) [inline]

Definition at line 196 of file emcCalibrator.h.
References fUseOnlyLowGain.
Referenced by emcCalibrator().

virtual void emcCalibrator::SetVerbose ( int level = 0 ) [inline, virtual]

Set the verbose level.

Definition at line 175 of file emcCalibrator.h.
References fVerbose.
Referenced by emcCalibrator().

void emcCalibrator::SetZeroSuppression ( bool swi = true ) [inline]

switches on and off the zero suppression flag

Definition at line 181 of file emcCalibrator.h.
References fZeroSuppression.
Referenced by mEmcCalibratorModule::SetZeroSuppression().

Member Data Documentation

float emcCalibrator::fGlobalT0 [private]

GlobalT0.

Definition at line 224 of file emcCalibrator.h.
Referenced by GetGlobalT0(), and SetGlobalT0().

int emcCalibrator::fHLLimit [private]

ADC channel count limit between high and low gain.

Definition at line 220 of file emcCalibrator.h.
Referenced by GetHighLowLimit(), and SetHighLowLimit().

std::string emcCalibrator::fName [protected]

Name of the calibrator.

Definition at line 206 of file emcCalibrator.h.
Referenced by emcCalibrator(), emcRawDataCalibrator::emcRawDataCalibrator(), emcRawDataCalibratorV1::emcRawDataCalibratorV1(), emcRawDataCalibratorV2::emcRawDataCalibratorV2(), and GetName().

float emcCalibrator::fThresholdADC [private]

ADC threshold.

Definition at line 222 of file emcCalibrator.h.
Referenced by GetThresholdADC(), and SetThresholdADC().

float* emcCalibrator::fTwrGlobalT0 [protected]

Definition at line 215 of file emcCalibrator.h.
Referenced by emcCalibrator(), GetGlobalT0(), emcRawDataCalibratorV2::SetTwrGlobalT0(), emcRawDataCalibratorV1::SetTwrGlobalT0(), emcRawDataCalibrator::SetTwrGlobalT0(), and SetTwrGlobalT0().

Bool_t emcCalibrator::fUseAmpPedestals [protected]

tells Calibrator to subtruct pedestals from pre and post amplitude measurements

Definition at line 210 of file emcCalibrator.h.
Referenced by GetUseAmpPedestals(), emcRawDataCalibratorV2::Print(), and SetUseAmpPedestals().

Bool_t emcCalibrator::fUseOnlyLowGain [protected]

tells Calibrator NOT TO USE HIGH GAINS AND High-to-Low GAIN ratios

Definition at line 212 of file emcCalibrator.h.
Referenced by emcRawDataCalibratorV2::CollectForMDO(), GetUseOnlyLowGain(), emcRawDataCalibratorV2::Print(), and SetUseOnlyLowGain().

int emcCalibrator::fVerbose [protected]

Verbosity level.

Definition at line 214 of file emcCalibrator.h.
Referenced by emcRawDataCalibratorV2::CalibrateEnergy(), emcRawDataCalibratorV2::CollectForCDO(), emcRawDataCalibratorV1::CollectForCDO(), emcRawDataCalibrator::CollectForCDO(), emcRawDataCalibratorV1::CollectForMDO(), emcRawDataCalibrator::CollectForMDO(), GetVerbose(), and SetVerbose().

Bool_t emcCalibrator::fZeroSuppression [protected]

tells if zero's should be suppressed from raw data

Definition at line 208 of file emcCalibrator.h.
Referenced by GetZeroSuppression(), emcRawDataCalibratorV2::Print(), emcRawDataCalibratorV1::Print(), emcRawDataCalibrator::Print(), emcRawDataCalibratorV2::Reset(), emcRawDataCalibratorV1::Reset(), emcRawDataCalibrator::Reset(), and SetZeroSuppression().

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

emcCalibrator.h


Public Member Functions
	emcCalibrator ()
	ctor
virtual	~emcCalibrator ()
virtual bool	Calibrate (const emcRawDataObject &rdo, emcMixedDataObject &mdo, const PHTimeStamp &when)=0
	Calibrate interface going from RawDataObject to MixedDataObject.
virtual bool	Calibrate (const emcMixedDataObject &mdo, emcCalibratedDataObject &cdo, const PHTimeStamp &when)=0
	Calibrate interface going from MixedDataObject to CalibratedDataObject.
virtual bool	Calibrate (const emcRawDataObject &rdo, emcCalibratedDataObject &cdo, const PHTimeStamp &when)=0
	short cut to go from raw to calibrated
virtual void	ForceDBCollection (const PHTimeStamp &)
virtual float	GetThresholdADC (void) const
	Get ADC threshold (below this threshold we do not try to calibrate energy).
virtual float	GetGlobalT0 (void) const
	Get Global T0 value.
virtual float	GetGlobalT0 (int index) const
	returns tower dependent corrections to T0
virtual bool	GetCollectionStatus (const char *) const
	Get status of last try of collecting calibration data.
virtual int	GetHighLowLimit (void) const
	Get ADC channel count limit between high and low gain.
virtual const char *	GetName (void) const
	Get the name of this calibrator.
virtual int	GetVerbose (void) const
	Get verbose level.
virtual void	Print (void) const =0
	A print utility to inform what the calibrator is doing.
virtual void	printData (const emcRawDataObject &rdo, const int towerId) const =0
	the print utility to print data for individual tower
virtual void	Reset (void)=0
	Make this calibrator a brand new fresh baby just born (got it?).
virtual bool	SelectSource (const char *type, emcManageable::EStorage source)=0
	Select the source of calibration data.
virtual void	SetExtraRejectListFilename (const char *=0)
	Set the filename of a file containing a list of extra towers to be rejected, as compared to those in Q&A objects.
virtual void	SetSMBasedCorrectionFilename (const char *="")
	Set the filename of a file containing a list of corrections to be applied to calibration coefficients in individual supermodules.
virtual void	SetGlobalT0 (float T0=0.0)
	Set Global T0.
virtual void	SetTwrGlobalT0 (char *filename=0)
	Set Global T0 for every calorimeter Tower.
virtual void	SetThresholdADC (float thres=10.)
	Set ADC threshold.
virtual void	SetHighLowLimit (int lim=1024)
	Set ADC channel count limit between high and low gain.
virtual void	SetVerbose (int level=0)
	Set the verbose level.
void	SetZeroSuppression (bool swi=true)
	switches on and off the zero suppression flag
Bool_t	GetZeroSuppression ()
void	SetUseAmpPedestals (Bool_t flag=false)
	Sets UseAmplitudePedestals flag (default - false, no pre/post pedestal subtruction in amplitude measurements).
Bool_t	GetUseAmpPedestals ()
	Sets USE-ONLY-LOW-GAIN flag (default - false, unless otherwise agreed - this is for monitoring purposes only).
void	SetUseOnlyLowGain (Bool_t flag=false)
Bool_t	GetUseOnlyLowGain ()
Protected Attributes
std::string	fName
	Name of the calibrator.
Bool_t	fZeroSuppression
	tells if zero's should be suppressed from raw data
Bool_t	fUseAmpPedestals
	tells Calibrator to subtruct pedestals from pre and post amplitude measurements
Bool_t	fUseOnlyLowGain
	tells Calibrator NOT TO USE HIGH GAINS AND High-to-Low GAIN ratios
int	fVerbose
	Verbosity level.
float *	fTwrGlobalT0
Private Attributes
int	fHLLimit
	ADC channel count limit between high and low gain.
float	fThresholdADC
	ADC threshold.
float	fGlobalT0
	GlobalT0.

emcCalibrator Class Reference [Old calibration software]

Detailed Description

Public Member Functions

Protected Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

emcCalibrator Class Reference
[Old calibration software]