Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

CalLog Class Reference

The CalLog class contains the information about a single calorimeter log. This class can handle either ADC values for all 4 digitizations, or a readout that has one "best" range. This class implements a LogId member which provides access to information on the position of the log within the calorimeter. More...

#include <CalLog.h>

Inheritance diagram for CalLog:

TObject List of all members.

Public Types

enum  AdcRange { LowEnX4 = 0, LowEnX1, HiEnX8, HiEnX1 }
enum  LogFace { POS = 0, NEG }
enum  CalTrigMode { BESTRANGE = 0, ALLRANGE = 2 }

Public Methods

 CalLog ()
 CalLog (LogId &id)
virtual ~CalLog ()
Int_t Compare (const TObject *obj) const
 Root >= 3.0 is now const correct for the Compare function. More...

Bool_t IsSortable () const
UShort_t getAdc (LogFace face, short index) const
UShort_t getAdcSelectedRange (LogFace face, AdcRange range = LowEnX4) const
 Get ADC value for selected face and energy range. More...

UShort_t getRange (LogFace face, short index) const
const CalTrigMode getMode () const
 Retrieve readout mode. More...

Bool_t setAdcValue (UShort_t newVal, LogFace face, AdcRange range = LowEnX4)
Bool_t setAdcId (UShort_t newVal, LogFace face, AdcRange range = LowEnX4)
Bool_t setAdcPinId (UShort_t newVal, LogFace face, AdcRange range = LowEnX4)
Bool_t setAdcRangeScale (UShort_t newVal, LogFace face, AdcRange range = LowEnX4)
void setAdcWord (UShort_t newVal, LogFace face, AdcRange range = LowEnX4)
void setTriggerMode (CalTrigMode val)
LogIdgetLogId ()

Private Types

enum  {
  ADC_K_RS = 1, ADC_V_RS = 0, ADC_M_RS = ((1 << ADC_K_RS) - 1), ADC_K_PIN = 1,
  ADC_V_PIN = (ADC_K_RS + ADC_V_RS), ADC_M_PIN = ((1 << ADC_K_PIN) - 1), ADC_K_ID = 2, ADC_V_ID = (ADC_K_PIN + ADC_V_PIN),
  ADC_M_ID = ((1 << ADC_K_ID) - 1), ADC_K_VAL = 12, ADC_V_VAL = (ADC_K_ID + ADC_V_ID), ADC_M_VAL = ((1 << ADC_K_VAL) - 1)
}

Private Attributes

LogId m_log
UShort_t m_AdcValues [8]

Static Private Methods

UShort_t getAdc (UShort_t adcWord)
UShort_t getAdcId (UShort_t adcWord)
UShort_t getAdcPinId (UShort_t adcWord)
UShort_t getAdcRangeScale (UShort_t adcWord)
UShort_t getAdcRange (UShort_t adcWord)

Static Private Attributes

CalTrigMode m_mode
 Cal readout mode is based on trigger type. More...


Detailed Description

The CalLog class contains the information about a single calorimeter log. This class can handle either ADC values for all 4 digitizations, or a readout that has one "best" range. This class implements a LogId member which provides access to information on the position of the log within the calorimeter.

Jun 2001 Heather Kelly - renamed from CalHit to CalLog Jun 2001 Heather Kelly - remove pointer to LogId Jan 2000 Daniel Flath - ROOT HTML comments added Dec 1999 Daniel Flath - Rewritten for GLAST Oct 25,1999 Richard Dubois Clone from LCD version

Definition at line 23 of file CalLog.h.


Member Enumeration Documentation

anonymous enum [private]
 

ADC word layout (defined in following enum): _____________________________________________________ |15| | | | | | | | | | |04|03|02|01|00| |__|__|__|__|___|__|__|__|__|__|__|__|__|__|__|__| | ADC Value | ID |PN|RS| |_______________________________________|_____|__|__|

NOTES: *****

PN == Pin RS == Range Scale

PN & RS = Range

Enumeration values:
ADC_K_RS  
ADC_V_RS  
ADC_M_RS  
ADC_K_PIN  
ADC_V_PIN  
ADC_M_PIN  
ADC_K_ID  
ADC_V_ID  
ADC_M_ID  
ADC_K_VAL  
ADC_V_VAL  
ADC_M_VAL  

Definition at line 70 of file CalLog.h.

enum CalLog::AdcRange
 

Enumeration values:
LowEnX4  
LowEnX1  
HiEnX8  
HiEnX1  

Definition at line 35 of file CalLog.h.

enum CalLog::CalTrigMode
 

Enumeration values:
BESTRANGE  
ALLRANGE  

Definition at line 47 of file CalLog.h.

enum CalLog::LogFace
 

Enumeration values:
POS  
NEG  

Definition at line 42 of file CalLog.h.


Constructor & Destructor Documentation

CalLog::CalLog ( )
 

CalLog::CalLog ( LogId & id )
 

Definition at line 14 of file CalLog.cxx.

CalLog::~CalLog ( ) [virtual]
 

Definition at line 20 of file CalLog.cxx.


Member Function Documentation

Int_t CalLog::Compare ( const TObject * obj ) const
 

Root >= 3.0 is now const correct for the Compare function.

Definition at line 24 of file CalLog.cxx.

Bool_t CalLog::IsSortable ( ) const
 

Definition at line 35 of file CalLog.cxx.

UShort_t CalLog::getAdc ( LogFace face,
short index ) const [inline]
 

Definition at line 121 of file CalLog.h.

UShort_t CalLog::getAdc ( UShort_t adcWord ) [inline, static, private]
 

Definition at line 99 of file CalLog.h.

Referenced by getAdc(), and getAdcSelectedRange().

UShort_t CalLog::getAdcId ( UShort_t adcWord ) [inline, static, private]
 

Definition at line 102 of file CalLog.h.

UShort_t CalLog::getAdcPinId ( UShort_t adcWord ) [inline, static, private]
 

Definition at line 105 of file CalLog.h.

Referenced by getAdcRange().

UShort_t CalLog::getAdcRange ( UShort_t adcWord ) [inline, static, private]
 

Definition at line 112 of file CalLog.h.

Referenced by getRange().

UShort_t CalLog::getAdcRangeScale ( UShort_t adcWord ) [inline, static, private]
 

Definition at line 108 of file CalLog.h.

Referenced by getAdcRange().

UShort_t CalLog::getAdcSelectedRange ( LogFace face,
AdcRange range = LowEnX4 ) const [inline]
 

Get ADC value for selected face and energy range.

Definition at line 125 of file CalLog.h.

LogId * CalLog::getLogId ( ) [inline]
 

Definition at line 154 of file CalLog.h.

Referenced by DigiEvent::getCalLog().

const CalTrigMode CalLog::getMode ( ) const [inline]
 

Retrieve readout mode.

Definition at line 141 of file CalLog.h.

UShort_t CalLog::getRange ( LogFace face,
short index ) const [inline]
 

Definition at line 136 of file CalLog.h.

Bool_t CalLog::setAdcId ( UShort_t newVal,
LogFace face,
AdcRange range = LowEnX4 )
 

Definition at line 54 of file CalLog.cxx.

Bool_t CalLog::setAdcPinId ( UShort_t newVal,
LogFace face,
AdcRange range = LowEnX4 )
 

Definition at line 69 of file CalLog.cxx.

Bool_t CalLog::setAdcRangeScale ( UShort_t newVal,
LogFace face,
AdcRange range = LowEnX4 )
 

Definition at line 84 of file CalLog.cxx.

Bool_t CalLog::setAdcValue ( UShort_t newVal,
LogFace face,
AdcRange range = LowEnX4 )
 

Definition at line 39 of file CalLog.cxx.

void CalLog::setAdcWord ( UShort_t newVal,
LogFace face,
AdcRange range = LowEnX4 ) [inline]
 

Definition at line 148 of file CalLog.h.

void CalLog::setTriggerMode ( CalTrigMode val ) [inline]
 

Definition at line 151 of file CalLog.h.


Member Data Documentation

UShort_t CalLog::m_AdcValues[8] [private]
 

Definition at line 93 of file CalLog.h.

LogId CalLog::m_log [private]
 

Definition at line 90 of file CalLog.h.

CalTrigMode CalLog::m_mode [static, private]
 

Cal readout mode is based on trigger type.

Definition at line 96 of file CalLog.h.


The documentation for this class was generated from the following files:
Generated at Wed Nov 14 20:41:47 2001 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000