ESDetId Class Reference

#include <ESDetId.h>

Inheritance diagram for ESDetId:

Public Types
enum	{ Subdet = EcalPreshower }
enum	{ kSizeForDenseIndexing = kLa }
Public Types inherited from DetId
enum	Detector {   Tracker =1, Muon =2, Ecal =3, Hcal =4,   Calo =5, Forward =6, VeryForward =7 }

Public Member Functions
uint32_t	denseIndex () const
	ESDetId ()
	ESDetId (uint32_t rawid)
	ESDetId (int strip, int ixs, int iys, int plane, int iz, bool doverify=false)
	constructor from strip, ix, iy, plane, and iz More...
	ESDetId (const DetId &id)
int	hashedIndex () const
	get a compact index for arrays [TODO: NEEDS WORK] More...
ESDetId &	operator= (const DetId &id)
int	plane () const
int	six () const
int	siy () const
int	strip () const
EcalSubdetector	subdet () const
	get the subdetector More...
int	zside () const
Public Member Functions inherited from DetId
Detector	det () const
	get the detector field from this detid More...
	DetId ()
	Create an empty or null id (also for persistence) More...
	DetId (uint32_t id)
	Create an id from a raw number. More...
	DetId (Detector det, int subdet)
	Create an id, filling the detector and subdetector fields as specified. More...
bool	null () const
	is this a null id ? More...
	operator uint32_t () const
bool	operator!= (DetId id) const
	inequality More...
uint32_t	operator() () const
bool	operator< (DetId id) const
	comparison More...
bool	operator== (DetId id) const
	equality More...
uint32_t	rawId () const
	get the raw id More...
int	subdetId () const
	get the contents of the subdetector field (not cast into any detector's numbering enum) More...

Static Public Member Functions
static ESDetId	detIdFromDenseIndex (uint32_t din)
static ESDetId	unhashIndex (int hi)
	get a DetId from a compact index for arrays More...
static bool	validDenseIndex (uint32_t din)
static bool	validDetId (int istrip, int ixs, int iys, int iplane, int iz)
	check if a valid index combination More...
static bool	validHashIndex (int hi)
static void	verify (int istrip, int ixs, int iys, int iplane, int iz)

Static Public Attributes
static const int	ISTRIP_MAX =32
static const int	ISTRIP_MIN =1
static const int	IX_MAX =40
static const int	IX_MIN =1
static const int	IY_MAX =40
static const int	IY_MIN =1
static const int	IZ_NUM =2
static const int	PLANE_MAX =2
static const int	PLANE_MIN =1
Static Public Attributes inherited from DetId
static const int	kDetOffset = 28
static const int	kSubdetOffset = 25

Private Types
enum	{   kXYMAX =1072, kXYMIN = 1, kXMAX = 40, kYMAX = 40,   kXMIN = 1, kYMIN = 1, kNa =IZ_NUM, kNb =PLANE_MAX - PLANE_MIN + 1,   kNc =kXYMAX - kXYMIN + 1, kNd =ISTRIP_MAX - ISTRIP_MIN + 1, kLd =kNd, kLc =kLd*kNc,   kLb =kLc*kNb, kLa =kLb*kNa }

Static Private Attributes
static const unsigned short	hx1 [kXYMAX]
static const unsigned short	hx2 [kXYMAX]
static const unsigned short	hxy1 [kXMAX][kYMAX]
static const unsigned short	hxy2 [kXMAX][kYMAX]
static const unsigned short	hy1 [kXYMAX]
static const unsigned short	hy2 [kXYMAX]

Additional Inherited Members
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Det id for a preshower (endcap) strip

Definition at line 14 of file ESDetId.h.

Member Enumeration Documentation

anonymous enum

Enumerator
Subdet

Definition at line 17 of file ESDetId.h.

{ Subdet = EcalPreshower } ;

anonymous enum

private

Enumerator
kXYMAX
kXYMIN
kXMAX
kYMAX
kXMIN
kYMIN
kNa
kNb
kNc
kNd
kLd
kLc
kLb
kLa

Definition at line 82 of file ESDetId.h.

           { kXYMAX=1072,
         kXYMIN=   1,
         kXMAX =  40,
         kYMAX =  40,
         kXMIN =   1,
         kYMIN =   1,
         // now normalize to A-D notation for ease of use
         kNa   =IZ_NUM,
         kNb   =PLANE_MAX - PLANE_MIN + 1,
         kNc   =kXYMAX - kXYMIN + 1,
         kNd   =ISTRIP_MAX - ISTRIP_MIN + 1,
         kLd   =kNd,
         kLc   =kLd*kNc,
         kLb   =kLc*kNb,
         kLa   =kLb*kNa } ;

anonymous enum

Enumerator
kSizeForDenseIndexing

Definition at line 108 of file ESDetId.h.

{ kSizeForDenseIndexing = kLa } ;

Constructor & Destructor Documentation

ESDetId::ESDetId ( )

inline

Constructor of a null id

Definition at line 19 of file ESDetId.h.

Referenced by unhashIndex().

{}

ESDetId::ESDetId ( uint32_t  rawid )

inline

Constructor from a raw value

Definition at line 21 of file ESDetId.h.

: DetId( rawid ) {}

ESDetId::ESDetId ( int  strip, int  ixs, int  iys, int  plane, int  iz, bool  doverify = false  )

inline

constructor from strip, ix, iy, plane, and iz

Definition at line 25 of file ESDetId.h.

References DetId::id_, and verify().

                                                                               :
   DetId( Ecal, EcalPreshower ) {
   id_ |=  (strip&0x3F) |
         ((ixs&0x3F)<<6) |
         ((iys&0x3F)<<12) |
         (((plane-1)&0x1)<<18) |
         ((iz>0)?(1<<19):(0))
       ;
   if (doverify) verify(strip, ixs, iys, plane, iz); 
  }

ESDetId::ESDetId ( const DetId &  id )

inline

constructor from a generic DetId

Definition at line 115 of file ESDetId.h.

References DetId::det(), DetId::Ecal, EcalPreshower, Exception, DetId::null(), and DetId::subdetId().

                                   : DetId(gen) 
{
#ifdef EDM_ML_DEBUG
   if( !gen.null() &&
       ( gen.det()  != Ecal          ||
         gen.subdetId() != EcalPreshower    ) )
   {
      throw cms::Exception("InvalidDetId");
   }
#endif
}

Member Function Documentation

uint32_t ESDetId::denseIndex ( ) const

inline

Definition at line 56 of file ESDetId.h.

References hashedIndex().

{ return hashedIndex() ; }

static ESDetId ESDetId::detIdFromDenseIndex ( uint32_t  din )

inlinestatic

Definition at line 60 of file ESDetId.h.

References unhashIndex().

Referenced by CaloGenericDetId::CaloGenericDetId(), and ESHitResponse::ESHitResponse().

{ return unhashIndex( din ) ; }

int ESDetId::hashedIndex

(

)

const

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

Definition at line 44 of file ESDetId.cc.

References hxy1, hxy2, cuy::ib, kLb, kLc, kLd, plane(), six(), siy(), strip(), and zside().

Referenced by denseIndex(), and ESRecHitSimAlgo::reconstruct().

{
   const int ia ( 1 == zside() ? 2 : 1 ) ;
   const int ib ( plane() ) ;
   const int ix ( six() ) ;
   const int iy ( siy() ) ;
   const int ic ( 1 == ib ?
          hxy1[ ix - 1 ][ iy - 1 ] :
          hxy2[ ix - 1 ][ iy - 1 ] ) ;
   const int id ( strip() ) ;

   return ( ( ia - 1 )*kLb +
        ( ib - 1 )*kLc +
        ( ic - 1 )*kLd + 
        id             - 1 ) ;
}

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

inline

assignment from a generic DetId

Definition at line 129 of file ESDetId.h.

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

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

int ESDetId::plane ( ) const

inline

get the plane

Definition at line 46 of file ESDetId.h.

References DetId::id_.

Referenced by EcalPreshowerDigisValidation::analyze(), EcalPreshowerRecHitsValidation::analyze(), EcalDigisValidation::analyze(), EcalMixingModuleValidation::analyze(), ESDataFormatterV1_1::DigiToRaw(), ESDataFormatterV4::DigiToRaw(), EndcapPiZeroDiscriminatorAlgo::findPreshVector(), hashedIndex(), EcalPreshowerGeometry::initializeParms(), PreshowerPhiClusterAlgo::makeOneCluster(), PreshowerClusterAlgo::makeOneCluster(), ESDigiToRaw::produce(), SelectedElectronFEDListProducer< TEle, TCand >::produce(), EcalSimHitsValidProducer::update(), CaloGenericDetId::validDetId(), and ESUnpacker::word2digi().

{ return ((id_>>18)&0x1)+1; }

int ESDetId::six ( ) const

inline

get the sensor ix

Definition at line 48 of file ESDetId.h.

References DetId::id_.

Referenced by EcalPreshowerDigisValidation::analyze(), EcalPreshowerRecHitsValidation::analyze(), EcalRecHitsValidation::analyze(), EcalDigisValidation::analyze(), EcalMixingModuleValidation::analyze(), ESDataFormatterV1_1::DigiToRaw(), ESDataFormatterV4::DigiToRaw(), hashedIndex(), ESDigiToRaw::produce(), SelectedElectronFEDListProducer< TEle, TCand >::produce(), CaloGenericDetId::validDetId(), and ESUnpacker::word2digi().

{ return (id_>>6)&0x3F; }

int ESDetId::siy ( ) const

inline

get the sensor iy

Definition at line 50 of file ESDetId.h.

References DetId::id_.

Referenced by EcalPreshowerDigisValidation::analyze(), EcalPreshowerRecHitsValidation::analyze(), EcalRecHitsValidation::analyze(), EcalDigisValidation::analyze(), EcalMixingModuleValidation::analyze(), ESDataFormatterV1_1::DigiToRaw(), ESDataFormatterV4::DigiToRaw(), hashedIndex(), ESDigiToRaw::produce(), SelectedElectronFEDListProducer< TEle, TCand >::produce(), CaloGenericDetId::validDetId(), and ESUnpacker::word2digi().

{ return (id_>>12)&0x3F; }

int ESDetId::strip ( ) const

inline

get the strip

Definition at line 52 of file ESDetId.h.

References DetId::id_.

Referenced by EcalPreshowerDigisValidation::analyze(), EcalPreshowerRecHitsValidation::analyze(), EcalRecHitsValidation::analyze(), EcalDigisValidation::analyze(), EcalMixingModuleValidation::analyze(), ESDataFormatterV1_1::DigiToRaw(), ESDataFormatterV4::DigiToRaw(), EndcapPiZeroDiscriminatorAlgo::findPreshVector(), hashedIndex(), PreshowerClusterAlgo::makeOneCluster(), CaloGenericDetId::validDetId(), and ESUnpacker::word2digi().

{ return (id_&0x3F); }

EcalSubdetector ESDetId::subdet ( ) const

inline

get the subdetector

Definition at line 42 of file ESDetId.h.

References DetId::subdetId().

{ return EcalSubdetector(subdetId()); }

ESDetId ESDetId::unhashIndex ( int  hi )

static

get a DetId from a compact index for arrays

Definition at line 62 of file ESDetId.cc.

References ESDetId(), hx1, hx2, hy1, hy2, cuy::ib, kLb, kLc, kLd, and validHashIndex().

Referenced by detIdFromDenseIndex(), and ESTrivialConditionRetriever::getChannelStatusFromConfiguration().

{
   if( validHashIndex( hi ) )
   {
      const int id ( hi%kLd + 1 ) ;
      const int nd ( hi - id + 1 ) ;
      const int ic ( ( nd%kLc )/kLd + 1 ) ;
      const int nc ( nd - ( ic - 1 )*kLd ) ;
      const int ib ( ( nc%kLb )/kLc + 1 ) ;
      const int nb ( nc - ( ib - 1 )*kLc ) ;
      const int ia ( nb/kLb + 1 );// + 1 ) ;

      const int st    ( id ) ;
      const int pl    ( ib ) ;
      int ix ;
      int iy ;
      const int ic1 ( ic - 1 ) ;
      if( 1 == pl )
      {
     ix = hx1[ ic1 ] ;
     iy = hy1[ ic1 ] ;
      }
      else
      {
     ix = hx2[ ic1 ] ;
     iy = hy2[ ic1 ] ;
      }
      const int iz ( 1 == ia ? -1 : 1 ) ;

      return ESDetId( st, ix, iy, pl, iz ) ;
   }
   else
   {
      return ESDetId() ;
   }
}

static bool ESDetId::validDenseIndex ( uint32_t  din )

inlinestatic

Definition at line 58 of file ESDetId.h.

References validHashIndex().

{ return validHashIndex( din ) ; }

bool ESDetId::validDetId ( int  istrip, int  ixs, int  iys, int  iplane, int  iz  )

static

check if a valid index combination

Definition at line 22 of file ESDetId.cc.

References funct::abs(), hxy1, hxy2, ISTRIP_MAX, ISTRIP_MIN, IX_MAX, IX_MIN, IY_MAX, IY_MIN, PLANE_MAX, and PLANE_MIN.

Referenced by EcalPreshowerTopology::decrementIx(), EcalPreshowerTopology::decrementIy(), EcalPreshowerTopology::decrementIz(), EcalPreshowerGeometry::getClosestCellInPlane(), EcalPreshowerTopology::incrementIx(), EcalPreshowerTopology::incrementIy(), EcalPreshowerTopology::incrementIz(), CaloGenericDetId::validDetId(), verify(), and ESUnpacker::word2digi().

{
  return ( !( ( istrip < ISTRIP_MIN ) ||
          ( istrip > ISTRIP_MAX ) ||
          ( ixs    < IX_MIN     ) || 
          ( ixs    > IX_MAX     ) ||
          ( iys    < IY_MIN     ) ||
          ( iys    > IY_MAX     ) ||
          ( abs( iz ) != 1      ) ||
          ( iplane < PLANE_MIN  ) ||
          ( iplane > PLANE_MAX  ) ||
          ( ( 1 == iplane ) &&
        0 == hxy1[ixs-1][iys-1]  ) ||
          ( ( 2 == iplane ) &&
        0 == hxy2[ixs-1][iys-1]  )    ) ) ;
}

static bool ESDetId::validHashIndex ( int  hi )

inlinestatic

Definition at line 64 of file ESDetId.h.

References kSizeForDenseIndexing.

Referenced by unhashIndex(), and validDenseIndex().

{ return ( hi < kSizeForDenseIndexing ) ; }

void ESDetId::verify ( int  istrip, int  ixs, int  iys, int  iplane, int  iz  )

static

Definition at line 6 of file ESDetId.cc.

References Exception, hxy1, hxy2, and validDetId().

Referenced by ESDetId().

{
   if( !validDetId( strip, ixs, iys, plane, iz) )
      throw cms::Exception("InvalidDetId") 
        << "ESDetId:  Cannot create object.  Indexes out of bounds \n" 
        << " strip = " << strip << " x = " << ixs << " y = " << iys << "\n" 
        << " plane = " << plane << " z = " << iz
        << " hxy = " << (1==plane?hxy1[ixs-1][iys-1]:hxy2[ixs-1][iys-1])
        << "\n";
}

int ESDetId::zside ( ) const

inline

get the zside

Definition at line 44 of file ESDetId.h.

References DetId::id_.

Referenced by ESOccupancyTask::analyze(), ESPedestalTask::analyze(), ESTimingTask::analyze(), ESTrendTask::analyze(), EcalPreshowerRecHitsValidation::analyze(), EcalPreshowerDigisValidation::analyze(), EcalDigisValidation::analyze(), EcalMixingModuleValidation::analyze(), ESDataFormatterV1_1::DigiToRaw(), ESDataFormatterV4::DigiToRaw(), hashedIndex(), EcalPreshowerGeometry::initializeParms(), ESDigiToRaw::produce(), SelectedElectronFEDListProducer< TEle, TCand >::produce(), EcalSimHitsValidProducer::update(), CaloGenericDetId::validDetId(), and ESUnpacker::word2digi().

{ return (id_&0x80000)?(1):(-1); }

Member Data Documentation

const unsigned short ESDetId::hx1

staticprivate

Definition at line 99 of file ESDetId.h.

Referenced by unhashIndex().

const unsigned short ESDetId::hx2

staticprivate

Definition at line 103 of file ESDetId.h.

Referenced by unhashIndex().

const unsigned short ESDetId::hxy1

staticprivate

Definition at line 98 of file ESDetId.h.

Referenced by hashedIndex(), validDetId(), and verify().

const unsigned short ESDetId::hxy2

staticprivate

Definition at line 102 of file ESDetId.h.

Referenced by hashedIndex(), validDetId(), and verify().

const unsigned short ESDetId::hy1

staticprivate

Definition at line 100 of file ESDetId.h.

Referenced by unhashIndex().

const unsigned short ESDetId::hy2

staticprivate

Definition at line 104 of file ESDetId.h.

Referenced by unhashIndex().

const int ESDetId::ISTRIP_MAX =32

static

Definition at line 75 of file ESDetId.h.

Referenced by ESTrivialConditionRetriever::getChannelStatusFromConfiguration(), EcalPreshowerGeometry::getClosestCellInPlane(), ESTrivialConditionRetriever::produceESChannelStatus(), ESTrivialConditionRetriever::produceESIntercalibConstants(), ESTrivialConditionRetriever::produceESPedestals(), ESTrivialConditionRetriever::produceESWeightStripGroups(), and validDetId().

const int ESDetId::ISTRIP_MIN =1

static

Definition at line 74 of file ESDetId.h.

Referenced by ESTrivialConditionRetriever::getChannelStatusFromConfiguration(), EcalPreshowerGeometry::getClosestCellInPlane(), ESTrivialConditionRetriever::produceESChannelStatus(), ESTrivialConditionRetriever::produceESIntercalibConstants(), ESTrivialConditionRetriever::produceESPedestals(), ESTrivialConditionRetriever::produceESWeightStripGroups(), and validDetId().

const int ESDetId::IX_MAX =40

static

Definition at line 72 of file ESDetId.h.

Referenced by ESTrivialConditionRetriever::getChannelStatusFromConfiguration(), ESTrivialConditionRetriever::produceESChannelStatus(), ESTrivialConditionRetriever::produceESIntercalibConstants(), ESTrivialConditionRetriever::produceESPedestals(), ESTrivialConditionRetriever::produceESWeightStripGroups(), and validDetId().

const int ESDetId::IX_MIN =1

static

Definition at line 70 of file ESDetId.h.

Referenced by ESTrivialConditionRetriever::getChannelStatusFromConfiguration(), ESTrivialConditionRetriever::produceESChannelStatus(), ESTrivialConditionRetriever::produceESIntercalibConstants(), ESTrivialConditionRetriever::produceESPedestals(), ESTrivialConditionRetriever::produceESWeightStripGroups(), and validDetId().

const int ESDetId::IY_MAX =40

static

Definition at line 73 of file ESDetId.h.

Referenced by ESTrivialConditionRetriever::getChannelStatusFromConfiguration(), ESTrivialConditionRetriever::produceESChannelStatus(), ESTrivialConditionRetriever::produceESIntercalibConstants(), ESTrivialConditionRetriever::produceESPedestals(), ESTrivialConditionRetriever::produceESWeightStripGroups(), and validDetId().

const int ESDetId::IY_MIN =1

static

Definition at line 71 of file ESDetId.h.

Referenced by ESTrivialConditionRetriever::getChannelStatusFromConfiguration(), ESTrivialConditionRetriever::produceESChannelStatus(), ESTrivialConditionRetriever::produceESIntercalibConstants(), ESTrivialConditionRetriever::produceESPedestals(), ESTrivialConditionRetriever::produceESWeightStripGroups(), and validDetId().

const int ESDetId::IZ_NUM =2

static

Definition at line 78 of file ESDetId.h.

const int ESDetId::PLANE_MAX =2

static

Definition at line 77 of file ESDetId.h.

Referenced by validDetId().

const int ESDetId::PLANE_MIN =1

static

Definition at line 76 of file ESDetId.h.

Referenced by validDetId().