emcDataObject Class Reference

#include <emcDataObject.h>

Inherited by emcMixedDataObject, and emcRawDataObject.

Inheritance diagram for emcDataObject:

Detailed Description

Base DataObject which implements methods common to :

Definition at line 21 of file emcDataObject.h.

Public Member Functions

void Reset ()

Clean the object : all data members initialized.

void SetDataDescriptionPointers (Int_t *datamap, long *softwareKey, Int_t *dataerrors)

void GetDataDescriptionPointers (Int_t *&datamap, long *&softwareKey, Int_t *&dataerrors) const

void SetDataDescriptionPointers (Int_t *datamap, long *softwareKey, Int_t *dataerrors, Int_t *deadmap)

void GetDataDescriptionPointers (Int_t *&datamap, long *&softwareKey, Int_t *&dataerrors, Int_t *&deadmap) const

void SetDataDescriptionPointers (Int_t *datamap, long *softwareKey, Int_t *dataerrors, Int_t *deadmap, Int_t *warnmap)

void GetDataDescriptionPointers (Int_t *&datamap, long *&softwareKey, Int_t *&dataerrors, Int_t *&deadmap, Int_t *&warnmap) const

void DecodeKey (long key, Int_t &arm, Int_t &sector, Int_t &yrow, Int_t &zrow) const

Returns geometrical location given the software key.

Int_t GetDead (Int_t index) const

Get status of neighbouring towers.

Int_t GetWarn (Int_t index) const

Int_t GetMaxSize (void) const

Returns the number of towers of this object defined by the configuration file.

Int_t GetDataError (Int_t index) const

Get error related to a given tower.

void AddDataError (Int_t index, int flag)

Update data errors if appropriate.

Int_t * GetDataErrorPointer (void) const

Get pointer to the fDataErrors array (be careful with this method!).

Int_t GetSize (void) const

Returns the number of towers of this object with non-zero data.

Int_t GetItemId (Int_t index) const

Returns the EMCal Object Id given the object naumber in the data map. The Object (Item) Identifier uniquely identifies the EMCal Object sendig its signal to the FEM channel stored as Item (Absolute Tower Number within PHENIX scope. Note - this tower numbering was extended to include FEM channels used to measure signals from References. The monitoring FEM's are grouped into nonexistent Sector "none"). It is actually implemented in the RawDataObject.

long GenerateSoftwareKey (Int_t ItemId) const

Generate software key for a given EMCal Object (sets to -1 for non tower objects).

long GetSoftwareKey (Int_t index) const

Gets software key for a given EMCal Object (assumes they were generated at instantiate time).

long GetErrorFlag (Int_t index) const

Gets error Flag for a given EMCal Object.

bool HasErrors (void) const

Indicates if part(s) of the fDataErrors array is not zero.

Bool_t ValidIndex (Int_t index) const

Checks if the index is within the range of the array.

Protected Member Functions

emcDataObject ()

You are not supposed to instantiate an object of this class.

virtual ~emcDataObject ()

Protected Attributes

Int_t fMaxSize

Number of towers of this object defined by the configuration file.

Int_t fSize

Number of towers of this object with non-zero data.

Int_t * fDataErrors

Data errors (do not belonge to this object).

Int_t * fDataMap

DataMap (does not belonge to this object).

long * fSoftKey

Software Keys - belonge to emcRawDataObject object.

Int_t * fDeadMap

Dead map - might belong to this object.

bool fOwnDeadMap

Tells if the dead map is ours or not.

bool fReadOnly

Int_t * fWarnMap

Warning map - might belong to this object.

bool fOwnWarnMap

Tells if the warning map is ours or not.

Constructor & Destructor Documentation

emcDataObject::emcDataObject ( ) [protected]

You are not supposed to instantiate an object of this class.

emcDataObject::~emcDataObject ( ) [protected, virtual]

Definition at line 33 of file emcDataObject.C.
References fDataErrors, fDataMap, fDeadMap, fOwnDeadMap, fOwnWarnMap, fSoftKey, and fWarnMap.

Member Function Documentation

void emcDataObject::AddDataError ( Int_t index,

int flag

) [inline]

Update data errors if appropriate.

Definition at line 85 of file emcDataObject.h.
References fDataErrors.
Referenced by emcRawDataCalibratorV2::Calibrate(), emcRawDataCalibratorV1::Calibrate(), and emcRawDataCalibrator::Calibrate().

void emcDataObject::DecodeKey ( long key,

Int_t & arm,

Int_t & sector,

Int_t & yrow,

Int_t & zrow

) const

Returns geometrical location given the software key.

Definition at line 145 of file emcDataObject.C.
Referenced by operator<<().

long emcDataObject::GenerateSoftwareKey ( Int_t ItemId ) const

Generate software key for a given EMCal Object (sets to -1 for non tower objects).

Definition at line 154 of file emcDataObject.C.
References EmcIndexer::iPXiSiST().

void emcDataObject::GetDataDescriptionPointers ( Int_t *& datamap,

long *& softwareKey,

Int_t *& dataerrors,

Int_t *& deadmap,

Int_t *& warnmap

) const

Definition at line 129 of file emcDataObject.C.
References fDataErrors, fDataMap, fDeadMap, fSoftKey, and fWarnMap.

void emcDataObject::GetDataDescriptionPointers ( Int_t *& datamap,

long *& softwareKey,

Int_t *& dataerrors,

Int_t *& deadmap

) const

Definition at line 102 of file emcDataObject.C.
References fDataErrors, fDataMap, fDeadMap, and fSoftKey.

void emcDataObject::GetDataDescriptionPointers ( Int_t *& datamap,

long *& softwareKey,

Int_t *& dataerrors

) const

Definition at line 80 of file emcDataObject.C.
References fDataErrors, fDataMap, and fSoftKey.
Referenced by emcRawDataCalibratorV2::Calibrate(), emcRawDataCalibratorV1::Calibrate(), and emcRawDataCalibrator::Calibrate().

Int_t emcDataObject::GetDataError ( Int_t index ) const [inline]

Get error related to a given tower.

Definition at line 79 of file emcDataObject.h.
References fDataErrors, and ValidIndex().
Referenced by emcPatch::event(), and operator<<().

Int_t* emcDataObject::GetDataErrorPointer ( void ) const [inline]

Get pointer to the fDataErrors array (be careful with this method!).

Definition at line 90 of file emcDataObject.h.
References fDataErrors.

Int_t emcDataObject::GetDead ( Int_t index ) const

Get status of neighbouring towers.
For the description of error and warning bits see emcQAs.C
Definition at line 195 of file emcDataObject.C.
References fDeadMap, and fMaxSize.
Referenced by emcRawDataCalibratorV2::Calibrate(), emcRawDataCalibratorV1::Calibrate(), and emcRawDataCalibrator::Calibrate().

long emcDataObject::GetErrorFlag ( Int_t index ) const [inline]

Gets error Flag for a given EMCal Object.

Definition at line 117 of file emcDataObject.h.
References fDataErrors.

Int_t emcDataObject::GetItemId ( Int_t index ) const [inline]

Returns the EMCal Object Id given the object naumber in the data map. The Object (Item) Identifier uniquely identifies the EMCal Object sendig its signal to the FEM channel stored as Item (Absolute Tower Number within PHENIX scope. Note - this tower numbering was extended to include FEM channels used to measure signals from References. The monitoring FEM's are grouped into nonexistent Sector "none"). It is actually implemented in the RawDataObject.

Definition at line 102 of file emcDataObject.h.
References fDataMap.
Referenced by emcRawDataCalibratorV2::Calibrate(), and operator<<().

Int_t emcDataObject::GetMaxSize ( void ) const [inline]

Returns the number of towers of this object defined by the configuration file.

Definition at line 73 of file emcDataObject.h.
References fMaxSize.
Referenced by emcRawDataCalibratorV2::Calibrate(), emcRawDataCalibratorV1::Calibrate(), emcRawDataCalibrator::Calibrate(), emcRawDataCalibratorV2::printData(), emcRawDataCalibratorV2::SetTwrGlobalT0(), emcRawDataCalibratorV1::SetTwrGlobalT0(), emcRawDataCalibrator::SetTwrGlobalT0(), and ValidIndex().

Int_t emcDataObject::GetSize ( void ) const [inline]

Returns the number of towers of this object with non-zero data.

Definition at line 96 of file emcDataObject.h.
References fSize.
Referenced by mEmcTOFCorr2Module::apply_tdcped(), emcRawDataCalibratorV2::Calibrate(), emcRawDataCalibratorV1::Calibrate(), emcRawDataCalibrator::Calibrate(), mEmcCalibratorModule::event(), and operator<<().

long emcDataObject::GetSoftwareKey ( Int_t index ) const [inline]

Gets software key for a given EMCal Object (assumes they were generated at instantiate time).

Definition at line 111 of file emcDataObject.h.
References fSoftKey.
Referenced by mEmcTOFCorr2Module::apply_tdcped(), and operator<<().

Int_t emcDataObject::GetWarn ( Int_t index ) const

Definition at line 206 of file emcDataObject.C.
References fMaxSize, and fWarnMap.

bool emcDataObject::HasErrors ( void ) const

Indicates if part(s) of the fDataErrors array is not zero.

Definition at line 219 of file emcDataObject.C.
References fDataErrors, and fSize.

void emcDataObject::Reset ( )

Clean the object : all data members initialized.

Definition at line 48 of file emcDataObject.C.
References fDataErrors, fDataMap, fDeadMap, fMaxSize, fOwnDeadMap, fOwnWarnMap, fReadOnly, fSize, fSoftKey, and fWarnMap.

void emcDataObject::SetDataDescriptionPointers ( Int_t * datamap,

long * softwareKey,

Int_t * dataerrors,

Int_t * deadmap,

Int_t * warnmap

)

Definition at line 114 of file emcDataObject.C.
References fDataErrors, fDataMap, fDeadMap, fSoftKey, and fWarnMap.

void emcDataObject::SetDataDescriptionPointers ( Int_t * datamap,

long * softwareKey,

Int_t * dataerrors,

Int_t * deadmap

)

Definition at line 90 of file emcDataObject.C.
References fDataErrors, fDataMap, fDeadMap, and fSoftKey.

void emcDataObject::SetDataDescriptionPointers ( Int_t * datamap,

long * softwareKey,

Int_t * dataerrors

)

Definition at line 70 of file emcDataObject.C.
References fDataErrors, fDataMap, and fSoftKey.
Referenced by emcRawDataCalibratorV2::Calibrate(), emcRawDataCalibratorV1::Calibrate(), and emcRawDataCalibrator::Calibrate().

Bool_t emcDataObject::ValidIndex ( Int_t index ) const [inline]

Checks if the index is within the range of the array.

Definition at line 126 of file emcDataObject.h.
References GetMaxSize().
Referenced by emcRawDataObject::GetAMUPost(), emcRawDataObject::GetAMUPre(), emcRawDataObject::GetAMUTAC(), GetDataError(), emcRawDataObject::GetHGPost(), emcRawDataObject::GetHGPre(), emcRawDataObject::GetLGPost(), emcRawDataObject::GetLGPre(), emcRawDataObject::GetTAC(), emcMixedDataObject::IsZero(), and emcMixedDataObject::Set().

Member Data Documentation

Int_t* emcDataObject::fDataErrors [protected]

Data errors (do not belonge to this object).

Definition at line 138 of file emcDataObject.h.
Referenced by AddDataError(), emcRawDataObject::Get(), GetDataDescriptionPointers(), GetDataError(), GetDataErrorPointer(), GetErrorFlag(), HasErrors(), emcRawDataObject::IsZero(), Reset(), emcRawDataObject::Set(), SetDataDescriptionPointers(), and ~emcDataObject().

Int_t* emcDataObject::fDataMap [protected]

DataMap (does not belonge to this object).

Definition at line 140 of file emcDataObject.h.
Referenced by GetDataDescriptionPointers(), GetItemId(), emcMixedDataObject::GetPointers(), operator<<(), Reset(), SetDataDescriptionPointers(), ~emcDataObject(), and emcRawDataObject::~emcRawDataObject().

Int_t* emcDataObject::fDeadMap [protected]

Dead map - might belong to this object.

Definition at line 144 of file emcDataObject.h.
Referenced by GetDataDescriptionPointers(), GetDead(), Reset(), SetDataDescriptionPointers(), and ~emcDataObject().

Int_t emcDataObject::fMaxSize [protected]

Number of towers of this object defined by the configuration file.

Definition at line 134 of file emcDataObject.h.
Referenced by GetDead(), GetMaxSize(), GetWarn(), Reset(), emcMixedDataObject::SetMaxSize(), and emcMixedDataObject::UseHGLG().

bool emcDataObject::fOwnDeadMap [protected]

Tells if the dead map is ours or not.

Definition at line 146 of file emcDataObject.h.
Referenced by Reset(), and ~emcDataObject().

bool emcDataObject::fOwnWarnMap [protected]

Tells if the warning map is ours or not.

Definition at line 153 of file emcDataObject.h.
Referenced by Reset(), and ~emcDataObject().

bool emcDataObject::fReadOnly [protected]

Definition at line 147 of file emcDataObject.h.
Referenced by Reset().

Int_t emcDataObject::fSize [protected]

Number of towers of this object with non-zero data.

Definition at line 136 of file emcDataObject.h.
Referenced by GetSize(), HasErrors(), Reset(), emcMixedDataObject::Set(), and emcMixedDataObject::SetMaxSize().

long* emcDataObject::fSoftKey [protected]

Software Keys - belonge to emcRawDataObject object.

Definition at line 142 of file emcDataObject.h.
Referenced by GetDataDescriptionPointers(), GetSoftwareKey(), Reset(), SetDataDescriptionPointers(), and ~emcDataObject().

Int_t* emcDataObject::fWarnMap [protected]

Warning map - might belong to this object.

Definition at line 151 of file emcDataObject.h.
Referenced by GetDataDescriptionPointers(), GetWarn(), Reset(), SetDataDescriptionPointers(), and ~emcDataObject().

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


Public Member Functions
void	Reset ()
	Clean the object : all data members initialized.
void	SetDataDescriptionPointers (Int_t datamap, long softwareKey, Int_t *dataerrors)
void	GetDataDescriptionPointers (Int_t &datamap, long &softwareKey, Int_t *&dataerrors) const
void	SetDataDescriptionPointers (Int_t datamap, long softwareKey, Int_t dataerrors, Int_t deadmap)
void	GetDataDescriptionPointers (Int_t &datamap, long &softwareKey, Int_t &dataerrors, Int_t &deadmap) const
void	SetDataDescriptionPointers (Int_t datamap, long softwareKey, Int_t dataerrors, Int_t deadmap, Int_t *warnmap)
void	GetDataDescriptionPointers (Int_t &datamap, long &softwareKey, Int_t &dataerrors, Int_t &deadmap, Int_t *&warnmap) const
void	DecodeKey (long key, Int_t &arm, Int_t &sector, Int_t &yrow, Int_t &zrow) const
	Returns geometrical location given the software key.
Int_t	GetDead (Int_t index) const
	Get status of neighbouring towers.
Int_t	GetWarn (Int_t index) const
Int_t	GetMaxSize (void) const
	Returns the number of towers of this object defined by the configuration file.
Int_t	GetDataError (Int_t index) const
	Get error related to a given tower.
void	AddDataError (Int_t index, int flag)
	Update data errors if appropriate.
Int_t *	GetDataErrorPointer (void) const
	Get pointer to the fDataErrors array (be careful with this method!).
Int_t	GetSize (void) const
	Returns the number of towers of this object with non-zero data.
Int_t	GetItemId (Int_t index) const
	Returns the EMCal Object Id given the object naumber in the data map. The Object (Item) Identifier uniquely identifies the EMCal Object sendig its signal to the FEM channel stored as Item (Absolute Tower Number within PHENIX scope. Note - this tower numbering was extended to include FEM channels used to measure signals from References. The monitoring FEM's are grouped into nonexistent Sector "none"). It is actually implemented in the RawDataObject.
long	GenerateSoftwareKey (Int_t ItemId) const
	Generate software key for a given EMCal Object (sets to -1 for non tower objects).
long	GetSoftwareKey (Int_t index) const
	Gets software key for a given EMCal Object (assumes they were generated at instantiate time).
long	GetErrorFlag (Int_t index) const
	Gets error Flag for a given EMCal Object.
bool	HasErrors (void) const
	Indicates if part(s) of the fDataErrors array is not zero.
Bool_t	ValidIndex (Int_t index) const
	Checks if the index is within the range of the array.
Protected Member Functions
	emcDataObject ()
	You are not supposed to instantiate an object of this class.
virtual	~emcDataObject ()
Protected Attributes
Int_t	fMaxSize
	Number of towers of this object defined by the configuration file.
Int_t	fSize
	Number of towers of this object with non-zero data.
Int_t *	fDataErrors
	Data errors (do not belonge to this object).
Int_t *	fDataMap
	DataMap (does not belonge to this object).
long *	fSoftKey
	Software Keys - belonge to emcRawDataObject object.
Int_t *	fDeadMap
	Dead map - might belong to this object.
bool	fOwnDeadMap
	Tells if the dead map is ours or not.
bool	fReadOnly
Int_t *	fWarnMap
	Warning map - might belong to this object.
bool	fOwnWarnMap
	Tells if the warning map is ours or not.