digiRootData Methods
Introduction

DigiEvent

AcdHeader 
AcdTile

AcdId

CalHeader 
CalLog
LogId

TkrHeader 
TkrLayer

StripID

L1T

LiveTime

Introduction

This document describes the current routines in the digiRootData classes.  These classes are used to define the structure of the raw/digi ROOT classes.

DigiEvent

DigiEvent Method

Description

Returns

getRunId( ) returns the Run Number 0 - ?
getEventId( ) returns the Event identifier 0 - ?
getAcdHeader( ) returns the ACD Header data AcdHeader*
getCalHeader( ) returns the CAL Header data CalHeader*
getTkrHeader( ) returns the TKR Header data TkrHeader*
getAcdDigi( ) returns the whole TClonesArray of ACD data
Note:  One may use getAcdTile( ) to retrieve data for one specific AcdTile.
TClonesArray*
getCalDigi( ) returns the whole TClonesArray of CalLogs 
Note:  One may use getCalLog( ) to retrieve data for one specific CalLog
TClonesArray*
getTkrDigi( ) returns the TObjArray of TkrLayers
Note:  One may use getTkrLayer( ) to retrieve data for one specific TkrLayer
TObjArray*
getXgtDigi( ) returns the TClonesArray of XGT data
Note:  One may use getXgt( ) to retrieve data for one specific XGT
TClonesArray*
getAcdTile(int id ) User provides an ACD id in base 10, and the AcdTile object is returned if it exists in the data array AcdTile* or null, if not found
getAcdTile(int l, int f, int r, int c ) User provides the layer, face, row, column to identify the ACD/XGT, and the AcdTile object is returned, if it exists in the data array AcdTile* or null, if not found
getAcdTile(AcdId id ) User provides an AcdId, and the method returns the AcdTile object, if it exists in the data array AcdTile* or null, if not found
getCalLog(LogId id ) User provides a LogId, and the corresponding CalLog object is returned if it exists in the data array. CalLog* or null, if not found
getCalLog(int t, int l, int c) User provides the tower, layer, and column numbers, and the corresponding CalLog object is returned if it exists in the data array CalLog* or null, if not found
getTkrLayer( int layerNum ) User provides a layer number, and the corresponding TkrLayer object is returned if it exists in the data array. TkrLayer* or null, if not found
getXgt(int id ) User provides an XGT id (2000,2001,2010,2011) in base 10, and the AcdTile object is returned if it exists in the data array AcdTile* or null, if not found
getLiveTime( ) returns the Live Time counter data LiveTime*
getL1T( ) returns the Level One Trigger data L1T*

 

AcdHeader

AcdHeader Method

Description

Range

getEventId( ) Event Id (L1T trigger count) as reported by the ACD subpacket 0 - ?
getTimerWord( ) 32 bit word  
getTreqStatus( )    
getDeadTime( )    
getDeadTimeCause( )    
getDeadTimeAndCause( )    
isL1tWait( ) Checks to see if the deadtime cause was L1T wait true/false
isCpuBusy( ) Checks to see if the deadtime cause was CPU busy true/false
isFifoFullTrap() checks to see if the deadtime cause is FIFO full Trap true/false
isFifoFull() checks to see if the deadtime cause is FIFO full true/false
isFifoHalfTrap( ) checks to see if deadtime cause is FIFO Half trap true/false
isAcdBusy() checks to see if deadtime cause is ACD Busy true/false

 

AcdTile

AcdTile Method

Description

Returns

getId( ) returns the AcdId object for this ACD/XGT AcdId*
getPulseHeight( ) returns the PHA value for this ACD/XGT 0 - 
getCNO( ) returns 1/0 denoting whether or not this ACD/XGT was over high (CNO) threshold 0 (not over threshold)
1 (over threshold)
getVeto( ) returns whether or not the ACD/XGT was over threshold 0 (not over threshold)
1 (over threshold)

 

AcdId

AcdId Method

Description

Range

getId(short base=10 ) returns the Id of this AcdId, either in base 10 or base 2, the default is base 10. 0 - 2011 (base 10)
getLayer( ) returns the layer number for this AcdId, based on the Ritz numbering convention. 0-2
getFace( ) returns the face number for this AcdId, based on the Ritz numbering convention. 0-4
getRow( ) returns the row number for this AcdId, based on the Ritz numbering convention.  
getColumn( ) returns the column number for this AcdId, based on the Ritz numbering convention.  
isTop( ) returns true if this ACD/XGT is located at the top of the instrument true/false
isSide( ) returns true if this ACD is located on the side true/false

 

CalHeader

CalHeader Method

Description

Range

getEventId( ) Event Id (L1T trigger count) as reported by the ACD subpacket 0 - ?
getTimerWord( ) 32 bit word  
getTreqStatus( )    
getDeadTime( )    
getDeadTimeCause( )    
getDeadTimeAndCause( )    
isL1tWait( ) Checks to see if the deadtime cause was L1T wait true/false
isCpuBusy( ) Checks to see if the deadtime cause was CPU busy true/false
isFifoFullTrap() checks to see if the deadtime cause is FIFO full Trap true/false
isFifoFull() checks to see if the deadtime cause is FIFO full true/false
isFifoHalfTrap( ) checks to see if deadtime cause is FIFO Half trap true/false
isCalBusy( ) checks to see if deadtime cause is CAL Busy true/false

 

CalLog

CalLog Method

Description

Returns

getLogId( ) returns the LogId LogId*
getAdc(LogFace face, int index ) returns the ADC value for a specific LogFace (POS = 0, NEG = 1) and index (for the BFEM index = [0,3] 0 - 4095
getAdcSelectedRange(LogFace face, AdcRange range ) returns the ADC value for a LogFace (POS = 0, NEG=1, and AdcRange ( 0 - 4095
getRange(LogFace face, int index ) returns the range for a given LogFace (POS = 0, NEG = 1) and index=[0,3] for BFEM LowEnX4 = 0
LowEnX1 = 1
HiEnX8 = 2
HiEnX1 = 3
getMode( ) returns the readout mode for this CalLog BESTRANGE = 0
ALLRANGE = 2
NOTE:  BFEM uses ALLRANGE

 

LogId

LogId Method

Description

Returns

getId( ) returns the unique id, constructed using the Tower, Layer, and Column.  
getTower( ) returns the tower number  
getLayer( ) returns the layer number of this LogId 0 - 7, assigned according to the standard Ritz numbering convention, where layer 0 is closest to the TKR.
getColumn( ) returns the column number of this LogId 0 - 9 for the BFEM, assigned according to the standard numbering convention, where 
getXY( ) returns the orientation of the layer, where X = 0, denotes a layer that is oriented along the x-axis, measures Y and Y = 1 denotes a layer that is oriented along the y-axis, measures X. 0 - measures Y

1 - measures X

 

TkrHeader

CalHeader Method

Description

Range

getEventId( ) Event Id (L1T trigger count) as reported by the ACD subpacket 0 - ?
getTimerWord( ) 32 bit word  
getTreqStatus( )    
getDeadTime( )    
getDeadTimeCause( )    
getDeadTimeAndCause( )    
isL1tWait( ) Checks to see if the deadtime cause was L1T wait true/false
isCpuBusy( ) Checks to see if the deadtime cause was CPU busy true/false
isFifoFullTrap() checks to see if the deadtime cause is FIFO full Trap true/false
isFifoFull() checks to see if the deadtime cause is FIFO full true/false
isFifoHalfTrap( ) checks to see if deadtime cause is FIFO Half trap true/false
isTkrBusy() checks to see if deadtime cause is TKR Busy true/false

 

TkrLayer

TkrLayer Method

Description

Returns

getLayerNum( ) returns the layer number of this TkrLayer - num 0 -
0th layer is the back-most layer, closest to the CAL.
getPlaneNum( ) returns the plane number, where plane refers to an XY pair. 0 - 
0th plane is the back-most plane, closest to the CAL.
getXY( ) returns the orientation of the layer X=0, measures X
Y=1, measures Y
getStrips( ) returns the TObjArray of StripIds TObjArray*
getHit( int i ) returns the ith StripId StripId
getNumHits( ) returns the number of hit strips in this TkrLayer 0 - 1599
getTot(int cntrlNum ) return the Time Over Threshold for either the left(0) or right(1) controller  
getErrf( )    

 

StripId

StripId Method

Description

Returns

getId( ) id for this Silicon Strip  0 - 1599
getController( )    
getTag( )    

 

L1T

L1T Method

Description

Returns

getTrigCount( ) event number - counts number of triggers seen a number, 0 - 
getTrigTime( )    
getXCapture( )    
getYCapture( )    
getDeadTime( )    
getDeadTimeCause( )    

 

LiveTime

LiveTime Method Description Returns
getL1TCount( ) event id - the number of triggers seen during this run UInt_t
getL1TTime( ) 32 bits of a 48 bit word representing the L1T time, 50 ns FPGA clock pulses without interruption. UInt_t
getL1TTimeOverFlow( ) 16 bits of the 48 bit word representing the L1T Time UShort_t
getPPSCount( ) number of GPS receiver pulse-per-second (PPS) pulses since power on. UInt_t
getPPSTime( ) 32 bits of a 48 bit word representing the L1T time latched at the rising edge of the GPS receiver PPS signal UInt_t
getPPSTimeOverFlow( ) 16 bits of a 48 bit word representing the L1T time latched at the rising edge of the GPS receiver PPS signal UShort_t
getLiveTime( ) 32 bits of the 48 bit word representing the live time, 50 ns FPGA clock pulses while the L1T Enable is high AND Level-1 Trigger is high.  The count value is held between runs. UInt_t
getLiveTimeOverFlow( ) 16 bits of the 48 bit word representing the live time UShort_t
getRunTime( ) 32 bits of the 48 bit word representing the run time, 50 ns FPGA clock pulses continuously while L1T enable is high, indicating a run is in progress.  The count value is held between runs. UInt_t
getRunTimeOverFlow( ) 16 bits of the 48 bit word representing the run time UShort_t
getRunCount( ) run number UInt_t
getTREQCapture()   UInt_t
getLTCDeadWord()   UInt_t