#include <EcalTrigTowerDetId.h>

Inheritance diagram for EcalTrigTowerDetId:

Public Types
enum	{ kEETowersInPhiPerEndcap = 4* kEETowersInPhiPerQuadrant, kEEOuterEta = 18, kEEInnerEta = 28, kEETowersInEta = ( kEEInnerEta - kEEOuterEta + 1 ), kEBHalfTowers = kEBTowersPerSM18, kEBTotalTowers = kEBHalfTowers2, kEETowersPerEndcap = kEETowersInEtakEETowersInPhiPerEndcap - 72, kEETotalTowers = kEETowersPerEndcap2, kSizeForDenseIndexing = kEBTotalTowers + kEETotalTowers }
Public Member Functions
uint32_t	denseIndex () const
	EcalTrigTowerDetId (uint32_t rawid)
	EcalTrigTowerDetId (const DetId &id)
	EcalTrigTowerDetId ()
	EcalTrigTowerDetId (int zside, EcalSubdetector subdet, int i, int j, int mode=SUBDETIJMODE)
	Constructor from signed ieta, iphi.
int	hashedIndex () const
	get a compact index for arrays [TODO: NEEDS WORK]
int	iDCC () const
	get the ECAL DCC id - in the barrrel ism == iDCC
int	ieta () const
	get the tower ieta
int	ietaAbs () const
	get the absolute value of the tower ieta
int	iphi () const
	get the tower iphi
int	iquadrant () const
int	iTT () const
	sequential index within one DCC
EcalTrigTowerDetId &	operator= (const DetId &id)
EcalSubdetector	subDet () const
	get the subDetector associated to the Trigger Tower
int	zside () const
	get the z-side of the tower (1/-1)
Static Public Member Functions
static EcalTrigTowerDetId	detIdFromDenseIndex (uint32_t di)
static bool	validDenseIndex (uint32_t din)
static bool	validDetId (int iz, EcalSubdetector sd, int i, int j)
	check if a valid index combination
Static Public Attributes
static const int	kEBTowersInEta = 17
static const int	kEBTowersInPhi = 4
static const int	kEBTowersPerSM = 68
static const int	kEETowersInPhiPerQuadrant = 18
static const int	MAX_I = 127
static const int	MAX_J = 127
static const int	MIN_I = 1
static const int	MIN_J = 1
static const int	SUBDETDCCTTMODE = 1
static const int	SUBDETIJMODE = 0

Detailed Description

DetId for an Ecal Trigger tower

Id:: EcalTrigTowerDetId.h,v 1.9 2009/01/16 23:51:34 heltsley Exp

Definition at line 17 of file EcalTrigTowerDetId.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

kEETowersInPhiPerEndcap
kEEOuterEta
kEEInnerEta
kEETowersInEta
kEBHalfTowers
kEBTotalTowers
kEETowersPerEndcap
kEETotalTowers
kSizeForDenseIndexing

Definition at line 126 of file EcalTrigTowerDetId.h.

           { kEETowersInPhiPerEndcap = 4* kEETowersInPhiPerQuadrant ,
             kEEOuterEta             = 18 ,
             kEEInnerEta             = 28 ,
             kEETowersInEta          = ( kEEInnerEta - kEEOuterEta + 1 ) ,
             kEBHalfTowers           = kEBTowersPerSM*18 ,
             kEBTotalTowers          = kEBHalfTowers*2 ,
             kEETowersPerEndcap      = kEETowersInEta*kEETowersInPhiPerEndcap - 72,
             kEETotalTowers          = kEETowersPerEndcap*2,
             kSizeForDenseIndexing   = kEBTotalTowers + kEETotalTowers } ;

Constructor & Destructor Documentation

EcalTrigTowerDetId::EcalTrigTowerDetId ( )

Constructor of a null id

Definition at line 5 of file EcalTrigTowerDetId.cc.

Referenced by detIdFromDenseIndex().

{
}

EcalTrigTowerDetId::EcalTrigTowerDetId ( uint32_t rawid )

Constructor from a raw value

Definition at line 9 of file EcalTrigTowerDetId.cc.

                                                     : DetId(rawid) {
}

EcalTrigTowerDetId::EcalTrigTowerDetId	(	int	zside,
		EcalSubdetector	subdet,
		int	i,
		int	j,
		int	mode = `SUBDETIJMODE`
	)

Constructor from signed ieta, iphi.

Definition at line 12 of file EcalTrigTowerDetId.cc.

References EcalBarrel, Exception, i, DetId::id_, j, MAX_I, MAX_J, MIN_J, SUBDETDCCTTMODE, and SUBDETIJMODE.

  : DetId(Ecal,EcalTriggerTower) 
{
  int tower_i=0;
  int tower_j=0;

  if (mode == SUBDETIJMODE)
    {
      tower_i=i;
      tower_j=j;
    }
  else if (mode == SUBDETDCCTTMODE)
    {
      throw cms::Exception("InvalidDetId") << "EcalTriggerTowerDetId:  Cannot create object. SUBDETDCCTTMODE not yet implemented.";   
    }
  else
    throw cms::Exception("InvalidDetId") << "EcalTriggerTowerDetId:  Cannot create object.  Unknown mode for (int, EcalSubdetector, int, int) constructor.";
  
  if (tower_i > MAX_I || tower_i < MIN_I  || tower_j > MAX_J || tower_j < MIN_J)
    throw cms::Exception("InvalidDetId") << "EcalTriggerTowerDetId:  Cannot create object.  Indexes out of bounds.";
  
  id_|= ((zside>0)?(0x8000):(0x0)) | ((subDet == EcalBarrel)?(0x4000):(0x0)) | (tower_i<<7) | (tower_j & 0x7F);

}

EcalTrigTowerDetId::EcalTrigTowerDetId ( const DetId & id )

Constructor from a generic cell id

Definition at line 37 of file EcalTrigTowerDetId.cc.

References DetId::det(), DetId::Ecal, EcalTriggerTower, Exception, DetId::id_, DetId::null(), DetId::rawId(), and DetId::subdetId().

{
  if (!gen.null() && ( gen.det()!=Ecal || gen.subdetId()!=EcalTriggerTower )) {
    throw cms::Exception("InvalidDetId");  }
  id_=gen.rawId();
}

Member Function Documentation

uint32_t EcalTrigTowerDetId::denseIndex ( ) const [inline]

Definition at line 92 of file EcalTrigTowerDetId.h.

References hashedIndex().

Referenced by EcalDQMBinningService::findBinsSuperCrystal_().

{ return hashedIndex() ; }

EcalTrigTowerDetId EcalTrigTowerDetId::detIdFromDenseIndex ( uint32_t di ) [static]

Definition at line 130 of file EcalTrigTowerDetId.cc.

References EcalBarrel, EcalEndcap, EcalTrigTowerDetId(), i, j, kEBHalfTowers, kEBTotalTowers, kEBTowersInPhi, kEBTowersPerSM, kEEOuterEta, kEETowersInPhiPerEndcap, kEETowersPerEndcap, sd, and validDetId().

Referenced by ecaldqm::TowerStatusTask::beginLuminosityBlock(), ecaldqm::TowerStatusTask::beginRun(), EcalDCSTowerStatusXMLTranslator::dumpXML(), EcalDAQTowerStatusXMLTranslator::dumpXML(), EcalDCSTowerStatusXMLTranslator::plot(), EcalDAQTowerStatusXMLTranslator::plot(), cond::PayLoadInspector< DataT >::plot(), ecaldqm::OccupancyClient::producePlots(), ecaldqm::TrigPrimClient::producePlots(), and ecaldqm::SelectiveReadoutTask::runOnDigis().

{
   const EcalSubdetector sd ( di < kEBTotalTowers ? EcalBarrel : EcalEndcap ) ;
   const int iz ( di < kEBTotalTowers ? 
                  ( di < kEBHalfTowers ?  1 : -1 ) :
                  ( di - kEBTotalTowers < kEETowersPerEndcap ? -1 : 1 ) ) ;
   int i ;
   int j ;
   if( di < kEBTotalTowers ) // barrel
   {
      const unsigned int itt ( di%kEBTowersPerSM ) ;
      const unsigned int idc ( di/kEBTowersPerSM ) ;
      j = (idc%18)*kEBTowersInPhi + 
         ( (1+iz)/2 )*kEBTowersInPhi - 
         iz*(itt%kEBTowersInPhi)  + 1 - (1+iz)/2 - 2 ;
      if( j < 1 ) j += 72 ;
      i = 1 + itt/kEBTowersInPhi ;
   }
   else
   {
      const int eonly ( ( di - kEBTotalTowers )%kEETowersPerEndcap ) ;
      i = kEEOuterEta + eonly/kEETowersInPhiPerEndcap ;
      j = 1 + eonly%kEETowersInPhiPerEndcap ;
      if( 27 == i ) // last two rings have half of normal phi elementes
      {
         if( j > kEETowersInPhiPerEndcap/2 )
         {
            ++i ; 
            j -= kEETowersInPhiPerEndcap/2 ;
         }
         j = 2*j ;
         if( 0 < iz ) --j ;
      }
   }
   assert( validDetId( iz, sd, i, j ) ) ;
   return EcalTrigTowerDetId( iz, sd, i, j ) ;
}

int EcalTrigTowerDetId::hashedIndex ( ) const

get a compact index for arrays [TODO: NEEDS WORK]

Definition at line 117 of file EcalTrigTowerDetId.cc.

References EcalBarrel, iDCC(), ietaAbs(), iphi(), iTT(), kEBTotalTowers, kEBTowersPerSM, kEEOuterEta, kEETowersInPhiPerEndcap, kEETowersPerEndcap, subDet(), and zside().

Referenced by denseIndex(), EcalDQMBinningService::findBinsTriggerTower_(), popcon::EcalDCSHandler::getNewObjects(), popcon::EcalDAQHandler::getNewObjects(), EcalBarrelRecHitsMaker::init(), EcalBarrelRecHitsMaker::loadEcalBarrelRecHits(), EcalBarrelRecHitsMaker::loadPCaloHits(), and EcalEndcapRecHitsMaker::TThashedIndexforEE().

{
   const unsigned int iea ( ietaAbs() ) ;
   const unsigned int iph ( iphi()    ) ;
   return ( subDet() == EcalBarrel  ? 
            ( iDCC() - 1 )*kEBTowersPerSM + iTT() - 1 :
            kEBTotalTowers + ( ( zside() + 1 )/2 )*kEETowersPerEndcap +
            ( ( iea < 27 ? iea : 27 ) - kEEOuterEta )*kEETowersInPhiPerEndcap + 
            ( iea < 27 ? iph : // for iphi=27,28 only half TT present, odd for EE-, even EE+
              ( iea - 27 )*kEETowersInPhiPerEndcap/2 + ( iph + 1 )/2 ) - 1 ) ;
}

int EcalTrigTowerDetId::iDCC ( ) const

get the ECAL DCC id - in the barrrel ism == iDCC

Definition at line 53 of file EcalTrigTowerDetId.cc.

References EcalBarrel, Exception, iphi(), kEBTowersInPhi, subDet(), and zside().

Referenced by hashedIndex().

{
  if ( subDet() == EcalBarrel )
    {
      //Correction since iphi is uniformized with HB convention 
      int iphi_simple = iphi() + 2 ;
      if (iphi_simple > 72 ) iphi_simple = iphi_simple % 72;
      int id = ( iphi_simple - 1 ) / kEBTowersInPhi + 1;
      if ( zside() < 0 ) id += 18;
      return id;
    }
  else
    throw cms::Exception("MethodNotImplemented") << "EcalTriggerTowerDetId: iDCC not yet implemented";
}

int EcalTrigTowerDetId::ieta ( ) const [inline]

get the tower ieta

Definition at line 49 of file EcalTrigTowerDetId.h.

References ietaAbs(), and zside().

Referenced by EBSelectiveReadoutTask::anaDigi(), EcalTPGParamBuilder::analyze(), EcalTPGAnalyzer::analyze(), EBSelectiveReadoutTask::analyze(), EcalTrigPrimAnalyzer::analyze(), EcalTrigPrimAnalyzerMIPs::analyze(), EcalDQMBinningService::channelName(), EcalTrigPrimCompactColl::compressedEt(), EcalSelectiveReadoutValidation::dccCh(), TCCBlockFormatter::DigiToRaw(), EcalTPGTowerStatusXMLTranslator::dumpXML(), EcalTrigPrimCompactColl::fineGrain(), EcalSimRawData::getSrfs(), EcalSelectiveReadout::getTowerInterest(), EcalSimRawData::getTp(), EcalDCSTowerStatusXMLTranslator::plot(), EcalDAQTowerStatusXMLTranslator::plot(), EcalTPGTowerStatusXMLTranslator::plot(), cond::PayLoadInspector< DataT >::plot(), EcalSelectiveReadoutProducer::printSrFlags(), EcalFEtoDigi::produce(), EcalTrigPrimCompactColl::raw(), EcalSelectiveReadoutValidation::setTtEtSums(), EcalSelectiveReadoutSuppressor::setTtFlags(), EcalTrigPrimCompactColl::sFGVB(), EcalTrigPrimCompactColl::toEcalTrigPrimDigiCollection(), EcalTrigPrimCompactColl::ttFlag(), and xuti::writeCell().

    { 
      /*       if ( subDet() == EcalBarrel) */
      return zside()*ietaAbs(); 
      /*       else */
      /*        throw(std::runtime_error("EcalTrigTowerDetId: ieta not applicable for this subDetector.")); */
    }

int EcalTrigTowerDetId::ietaAbs ( ) const [inline]

get the absolute value of the tower ieta

Definition at line 40 of file EcalTrigTowerDetId.h.

References DetId::id_.

Referenced by EcalTPGParamBuilder::analyze(), TPGCheck::analyze(), EcalTrigPrimAnalyzer::analyze(), EcalTrigPrimAnalyzerMIPs::analyze(), EcalSelectiveReadoutValidation::analyzeEB(), EcalSelectiveReadoutValidation::dccId(), TCCBlockFormatter::DigiToRaw(), hashedIndex(), ieta(), iTT(), ecaldqm::OccupancyClient::producePlots(), EcalTrigPrimFunctionalAlgo::run_part2(), and EcalTrigTowerConstituentsMap::wrapEcalTrigTowerDetId().

   { 
     /*       if ( subDet() == EcalBarrel) */
     return (id_>>7)&0x7f; 
     /*       else */
     /*         throw(std::runtime_error("EcalTrigTowerDetId: ietaAbs not applicable for this subDetector.")); */
   }

int EcalTrigTowerDetId::iphi ( ) const [inline]

get the tower iphi

Definition at line 58 of file EcalTrigTowerDetId.h.

References DetId::id_.

Referenced by EBSelectiveReadoutTask::anaDigi(), EcalTPGParamBuilder::analyze(), EcalTPGAnalyzer::analyze(), EcalTrigPrimAnalyzer::analyze(), EcalTrigPrimAnalyzerMIPs::analyze(), EcalSelectiveReadoutValidation::analyzeEB(), EcalDQMBinningService::channelName(), EcalTrigPrimCompactColl::compressedEt(), EcalSelectiveReadoutValidation::dccCh(), TCCBlockFormatter::DigiToRaw(), EcalTPGTowerStatusXMLTranslator::dumpXML(), EcalTrigPrimCompactColl::fineGrain(), EcalSimRawData::getSrfs(), EcalSelectiveReadout::getTowerInterest(), EcalSimRawData::getTp(), hashedIndex(), iDCC(), iquadrant(), iTT(), EcalDCSTowerStatusXMLTranslator::plot(), EcalDAQTowerStatusXMLTranslator::plot(), EcalTPGTowerStatusXMLTranslator::plot(), cond::PayLoadInspector< DataT >::plot(), EcalSelectiveReadoutProducer::printSrFlags(), EcalFEtoDigi::produce(), EcalTrigPrimCompactColl::raw(), EcalTrigPrimFunctionalAlgo::run_part2(), EcalSelectiveReadoutValidation::setTtEtSums(), EcalSelectiveReadoutSuppressor::setTtFlags(), EcalTrigPrimCompactColl::sFGVB(), EcalTrigPrimCompactColl::toEcalTrigPrimDigiCollection(), EcalTrigPrimCompactColl::ttFlag(), EcalTrigTowerConstituentsMap::wrapEcalTrigTowerDetId(), and xuti::writeCell().

    { 
      /*       if ( subDet() == EcalBarrel) */
      return id_&0x7F; 
      /*       else */
      /*        throw(std::runtime_error("EcalTrigTowerDetId: iphi not applicable for this subDetector.")); */
      
    }

int EcalTrigTowerDetId::iquadrant ( ) const

Definition at line 88 of file EcalTrigTowerDetId.cc.

References EcalEndcap, Exception, iphi(), kEETowersInPhiPerQuadrant, and subDet().

Referenced by EcalTrigTowerConstituentsMap::wrapEcalTrigTowerDetId().

{
  if ( subDet() == EcalEndcap )
    return int((iphi()-1)/kEETowersInPhiPerQuadrant)+1;
  else
    throw cms::Exception("MethodNotApplicable") << "EcalTriggerTowerDetId: iquadrant not applicable";
}

int EcalTrigTowerDetId::iTT ( ) const

sequential index within one DCC

Definition at line 68 of file EcalTrigTowerDetId.cc.

References EcalBarrel, Exception, ietaAbs(), iphi(), kEBTowersInPhi, subDet(), and zside().

Referenced by hashedIndex(), ecaldqm::towerId(), and ecaldqm::ttId().

{
  if ( subDet() == EcalBarrel )
    {
      int ie = ietaAbs() -1;
      int ip;
      int iphi_simple = iphi() + 2 ;
      if (iphi_simple > 72 )  iphi_simple = iphi_simple % 72;
      if (zside() < 0) {
        ip = (( iphi_simple -1 ) % kEBTowersInPhi ) + 1;
      } else {
        ip = kEBTowersInPhi - ((iphi_simple -1 ) % kEBTowersInPhi );
      }
      
      return (ie * kEBTowersInPhi) + ip;
    }
  else
    throw cms::Exception("MethodNotImplemented") << "EcalTriggerTowerDetId: iTT not yet implemented";
}

EcalTrigTowerDetId & EcalTrigTowerDetId::operator= ( const DetId & id )

Assignment from a generic cell id

Definition at line 44 of file EcalTrigTowerDetId.cc.

References DetId::det(), DetId::Ecal, EcalTriggerTower, Exception, DetId::id_, DetId::null(), DetId::rawId(), and DetId::subdetId().

                                                                  {
  if (!gen.null() && ( gen.det()!=Ecal || gen.subdetId()!=EcalTriggerTower )) {
    throw cms::Exception("InvalidDetId");
  }
  id_=gen.rawId();
  return *this;
}

EcalSubdetector EcalTrigTowerDetId::subDet ( ) const [inline]

get the subDetector associated to the Trigger Tower

Definition at line 37 of file EcalTrigTowerDetId.h.

References EcalBarrel, EcalEndcap, and DetId::id_.

Referenced by EcalTPGParamBuilder::analyze(), TPGCheck::analyze(), EcalTrigPrimAnalyzer::analyze(), TCCBlockFormatter::DigiToRaw(), EcalDQMBinningService::findBinsProjEta_(), EcalDQMBinningService::findBinsProjPhi_(), EcalDQMBinningService::findBinsTriggerTower_(), EcalTPGScale::getTPGInADC(), EcalTPGScale::getTPGInGeV(), hashedIndex(), iDCC(), iquadrant(), iTT(), EcalDigiToRaw::produce(), EcalTrigPrimFunctionalAlgo::run_part2(), and EcalTrigTowerConstituentsMap::wrapEcalTrigTowerDetId().

{ return (id_&0x4000) ? EcalBarrel:EcalEndcap; }

static bool EcalTrigTowerDetId::validDenseIndex ( uint32_t din ) [inline, static]

Definition at line 94 of file EcalTrigTowerDetId.h.

References kSizeForDenseIndexing.

{ return ( din < kSizeForDenseIndexing ) ; }

bool EcalTrigTowerDetId::validDetId	(	int	iz,
		EcalSubdetector	sd,
		int	i,
		int	j
	)		`[static]`

check if a valid index combination

Definition at line 97 of file EcalTrigTowerDetId.cc.

References abs, EcalBarrel, EcalEndcap, kEBTowersInEta, kEEInnerEta, kEEOuterEta, and kEETowersInPhiPerEndcap.

Referenced by EBDaqInfoTask::beginLuminosityBlock(), EBDcsInfoTask::beginLuminosityBlock(), EcalDQMStatusReader::beginRun(), detIdFromDenseIndex(), popcon::EcalDCSHandler::getNewObjects(), popcon::EcalDAQHandler::getNewObjects(), popcon::EcalDCSHandler::insertHVDataSetToOffline(), popcon::EcalDCSHandler::insertLVDataSetToOffline(), L1CaloEcalScaleConfigOnlineProd::newObject(), EcalTrivialConditionRetriever::produceEcalDAQTowerStatus(), EcalTrivialConditionRetriever::produceEcalDCSTowerStatus(), EcalTrivialConditionRetriever::produceEcalDQMTowerStatus(), and EcalDQMStatusWriter::readEcalDQMTowerStatusFromFile().

{
   return ( 1 == abs( iz )               &&
            0 <  i                       &&
            0 <  j                       &&
            kEETowersInPhiPerEndcap >= j &&
            ( ( EcalBarrel     == sd &&
                kEBTowersInEta >=  i     ) ||
              ( EcalEndcap     == sd &&
                kEEOuterEta    <=  i &&
                kEEInnerEta    >=  i &&
                ( 27 > i ||
                  (  ( 0 >  iz  &&
                       0 == j%2    ) ||
                     ( 0 <  iz  &&
                       1 == j%2         ) ) ) ) ) ) ;
            
}