HcalCastorDetId Class Reference

#include <HcalCastorDetId.h>

Inheritance diagram for HcalCastorDetId:

Public Types
enum	{ kNumberModulesPerEnd = 14, kNumberSectorsPerEnd = 16, kNumberCellsPerEnd = kNumberModulesPerEnd * kNumberSectorsPerEnd, kSizeForDenseIndexing = kNumberCellsPerEnd }
enum	Section { Unknown = 0, EM = 1, HAD = 2 }
Public Types inherited from DetId
enum	Detector {   Tracker = 1, Muon = 2, Ecal = 3, Hcal = 4,   Calo = 5, Forward = 6, VeryForward = 7, HGCalEE = 8,   HGCalHSi = 9, HGCalHSc = 10, HGCalTrigger = 11 }

Public Member Functions
uint32_t	denseIndex () const
	HcalCastorDetId ()
	HcalCastorDetId (bool true_for_positive_eta, int sector, int module)
	HcalCastorDetId (const DetId &id)
	HcalCastorDetId (Section section, bool true_for_positive_eta, int sector, int module)
	HcalCastorDetId (uint32_t rawid)
int	module () const
	get the module (1-2 for EM, 1-12 for HAD) More...
HcalCastorDetId &	operator= (const DetId &id)
Section	section () const
	get the section More...
int	sector () const
	get the sector (1-16) More...
int	zside () const
	get the z-side of the cell (1/-1) More...
Public Member Functions inherited from DetId
constexpr Detector	det () const
	get the detector field from this detid More...
constexpr	DetId ()
	Create an empty or null id (also for persistence) More...
constexpr	DetId (Detector det, int subdet)
	Create an id, filling the detector and subdetector fields as specified. More...
constexpr	DetId (uint32_t id)
	Create an id from a raw number. More...
constexpr bool	null () const
	is this a null id ? More...
constexpr	operator uint32_t () const
constexpr bool	operator!= (DetId id) const
	inequality More...
constexpr uint32_t	operator() () const
constexpr bool	operator< (DetId id) const
	comparison More...
constexpr bool	operator== (DetId id) const
	equality More...
constexpr uint32_t	rawId () const
	get the raw id More...
constexpr int	subdetId () const
	get the contents of the subdetector field (not cast into any detector's numbering enum) More...

Static Public Member Functions
static HcalCastorDetId	detIdFromDenseIndex (uint32_t di)
static bool	validDenseIndex (uint32_t din)
static bool	validDetId (Section iSection, bool posEta, int iSector, int iMod)

Static Public Attributes
static const int	SubdetectorId = 3
Static Public Attributes inherited from DetId
static const int	kDetMask = 0xF
static const int	kDetOffset = 28
static const int	kSubdetMask = 0x7
static const int	kSubdetOffset = 25

Private Member Functions
void	buildMe (Section section, bool true_for_positive_eta, int sector, int module)

Additional Inherited Members
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Contents of the HcalCastorDetId : [9] Z position (true for positive) [8:7] Section (EM/HAD) [6:4] sector (depth) [3:0] module

NEW: [8] z position [7:4] sector [3:0] module

Author

P. Katsas, T. McCauley

Definition at line 23 of file HcalCastorDetId.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kNumberModulesPerEnd
kNumberSectorsPerEnd
kNumberCellsPerEnd
kSizeForDenseIndexing

Definition at line 67 of file HcalCastorDetId.h.

       {
    kNumberModulesPerEnd = 14,
    kNumberSectorsPerEnd = 16,
    kNumberCellsPerEnd = kNumberModulesPerEnd * kNumberSectorsPerEnd,
    kSizeForDenseIndexing = kNumberCellsPerEnd
  };

Section

enum HcalCastorDetId::Section

Enumerator
Unknown
EM
HAD

Definition at line 25 of file HcalCastorDetId.h.

{ Unknown = 0, EM = 1, HAD = 2 };

Constructor & Destructor Documentation

HcalCastorDetId() [1/5]

HcalCastorDetId::HcalCastorDetId

(

)

Create a null cellid

Definition at line 5 of file HcalCastorDetId.cc.

: DetId() {}

Referenced by detIdFromDenseIndex().

HcalCastorDetId() [2/5]

HcalCastorDetId::HcalCastorDetId

(

uint32_t

rawid

)

Create cellid from raw id (0=invalid tower id)

Definition at line 7 of file HcalCastorDetId.cc.

: DetId(rawid) {}

HcalCastorDetId() [3/5]

HcalCastorDetId::HcalCastorDetId	(	Section	section,
		bool	true_for_positive_eta,
		int	sector,
		int	module
	)

Constructor from section, z-side, sector and module

Definition at line 14 of file HcalCastorDetId.cc.

    : DetId(DetId::Calo, SubdetectorId) {
  buildMe(section, true_for_positive_eta, sector, module);
}

References buildMe(), module(), section(), and sector().

HcalCastorDetId() [4/5]

HcalCastorDetId::HcalCastorDetId	(	bool	true_for_positive_eta,
		int	sector,
		int	module
	)

Definition at line 19 of file HcalCastorDetId.cc.

    : DetId(DetId::Calo, SubdetectorId) {
  buildMe(Section(Unknown), true_for_positive_eta, sector, module);
}

References buildMe(), module(), sector(), and Unknown.

HcalCastorDetId() [5/5]

HcalCastorDetId::HcalCastorDetId

(

const DetId &

id

)

Constructor from a generic cell id

Definition at line 24 of file HcalCastorDetId.cc.

                                                 {
  if (!gen.null() && (gen.det() != DetId::Calo || gen.subdetId() != SubdetectorId)) {
    throw cms::Exception("Invalid DetId")
        << "Cannot initialize CASTORDetId from " << std::hex << gen.rawId() << std::dec;
  }
  id_ = gen.rawId();
}

References DetId::Calo, TauDecayModes::dec, Exception, DetId::id_, and SubdetectorId.

Member Function Documentation

buildMe()

void HcalCastorDetId::buildMe ( Section  section, bool  true_for_positive_eta, int  sector, int  module  )

private

Definition at line 9 of file HcalCastorDetId.cc.

                                                                                                 {
  sector -= 1;  // we count sector from 1-16 instead of 0-15
  id_ |= (true_for_positive_eta << 8) | (sector << 4) | module;
}

References DetId::id_, module(), and sector().

Referenced by HcalCastorDetId().

denseIndex()

uint32_t HcalCastorDetId::denseIndex

(

)

const

Definition at line 65 of file HcalCastorDetId.cc.

                                           {
  return (kNumberCellsPerEnd * (zside() + 1) / 2 + kNumberSectorsPerEnd * (module() - 1) + sector() - 1);
}

References kNumberCellsPerEnd, kNumberSectorsPerEnd, module(), sector(), and zside().

detIdFromDenseIndex()

HcalCastorDetId HcalCastorDetId::detIdFromDenseIndex ( uint32_t  di )

static

Definition at line 73 of file HcalCastorDetId.cc.

                                                                {
  return HcalCastorDetId(
      kNumberCellsPerEnd <= di, di % kNumberSectorsPerEnd + 1, (di % kNumberCellsPerEnd) / kNumberSectorsPerEnd + 1);
}

References HcalCastorDetId(), kNumberCellsPerEnd, and kNumberSectorsPerEnd.

Referenced by CaloGenericDetId::CaloGenericDetId().

module()

int HcalCastorDetId::module ( ) const

inline

get the module (1-2 for EM, 1-12 for HAD)

Definition at line 58 of file HcalCastorDetId.h.

{ return (id_ & 0xF); }

References DetId::id_.

Referenced by buildMe(), denseIndex(), CastorDigiMonitor::getDbData(), CastorTTRecord::getEnergy_fC(), CastorCondObjectContainer< CastorQIECoder >::hashed_id(), HcalCastorDetId(), CastorTopology::incModule(), CastorTopology::incSector(), HcalCondObjectContainerBase::indexFor(), CastorText2DetIdConverter::init(), CastorHardcodeGeometryLoader::makeCell(), CastorDigiMonitor::processEvent(), CastorLEDMonitor::processEvent(), CastorCellProducer::produce(), section(), and CaloGenericDetId::validDetId().

operator=()

HcalCastorDetId & HcalCastorDetId::operator=

(

const DetId &

id

)

Assignment from a generic cell id

Definition at line 32 of file HcalCastorDetId.cc.

                                                            {
  if (!gen.null() && (gen.det() != DetId::Calo || gen.subdetId() != SubdetectorId)) {
    throw cms::Exception("Invalid DetId") << "Cannot assign Castor DetId from " << std::hex << gen.rawId() << std::dec;
  }
 
  id_ = gen.rawId();
 
  return *this;
}

References DetId::Calo, TauDecayModes::dec, Exception, DetId::id_, and SubdetectorId.

section()

HcalCastorDetId::Section HcalCastorDetId::section

(

)

const

get the section

Definition at line 49 of file HcalCastorDetId.cc.

                                                      {
  const int mod = module();
 
  Section sect;
  if (mod <= 2) {
    sect = HcalCastorDetId::EM;
  } else {
    if (mod > 2 && mod <= 14) {
      sect = HcalCastorDetId::HAD;
    } else {
      sect = HcalCastorDetId::Unknown;
    }
  }
  return sect;
}

References EM, HAD, mod(), module(), and Unknown.

Referenced by HcalCastorDetId(), CastorTopology::incModule(), CastorTopology::incSector(), CastorText2DetIdConverter::init(), CastorHardcodeGeometryLoader::makeCell(), VarParsing.VarParsing::parseArguments(), and CaloGenericDetId::validDetId().

sector()

int HcalCastorDetId::sector ( ) const

inline

get the sector (1-16)

Definition at line 62 of file HcalCastorDetId.h.

{ return ((id_ >> 4) & 0xF) + 1; }

References DetId::id_.

Referenced by buildMe(), denseIndex(), CastorDigiMonitor::getDbData(), CastorTTRecord::getEnergy_fC(), CastorCondObjectContainer< CastorQIECoder >::hashed_id(), HcalCastorDetId(), CastorTopology::incModule(), CastorTopology::incSector(), geometryXMLparser.DTAlignable::index(), HcalCondObjectContainerBase::indexFor(), CastorText2DetIdConverter::init(), CastorHardcodeGeometryLoader::makeCell(), CastorDigiMonitor::processEvent(), CastorLEDMonitor::processEvent(), CastorCellProducer::produce(), and CaloGenericDetId::validDetId().

validDenseIndex()

static bool HcalCastorDetId::validDenseIndex ( uint32_t  din )

inlinestatic

Definition at line 78 of file HcalCastorDetId.h.

{ return (din < kSizeForDenseIndexing); }

References cropTnPTrees::din, and kSizeForDenseIndexing.

validDetId()

bool HcalCastorDetId::validDetId ( Section  iSection, bool  posEta, int  iSector, int  iMod  )

static

Definition at line 69 of file HcalCastorDetId.cc.

                                                                                        {
  return (0 < iSector && kNumberSectorsPerEnd >= iSector && 0 < iModule && kNumberModulesPerEnd >= iModule);
}

References kNumberModulesPerEnd, and kNumberSectorsPerEnd.

Referenced by CaloGenericDetId::validDetId(), and CastorTopology::validRaw().

zside()

int HcalCastorDetId::zside ( ) const

inline

get the z-side of the cell (1/-1)

Definition at line 50 of file HcalCastorDetId.h.

{ return 2 * ((id_ >> 8) & 0x1) - 1; }

References DetId::id_, and testProducerWithPsetDescEmpty_cfi::x1.

Referenced by denseIndex(), CastorCondObjectContainer< CastorQIECoder >::hashed_id(), CastorTopology::incModule(), CastorTopology::incSector(), HcalCondObjectContainerBase::indexFor(), CastorText2DetIdConverter::init(), CastorHardcodeGeometryLoader::makeCell(), CastorCellProducer::produce(), and CaloGenericDetId::validDetId().

Member Data Documentation

SubdetectorId

const int HcalCastorDetId::SubdetectorId = 3

static

Definition at line 28 of file HcalCastorDetId.h.

Referenced by CastorHitFilter::accepts(), HcalCondObjectContainer< HcalPedestalWidth >::addValues(), ValidateGeometry::analyze(), CastorSimpleReconstructor::CastorSimpleReconstructor(), CastorDigiProducer::checkGeometry(), CastorHitCorrection::delay(), HcalGenericDetId::genericSubdet(), CastorCondObjectContainer< CastorQIECoder >::getValues(), HcalCondObjectContainer< HcalPedestalWidth >::getValues(), HcalCastorDetId(), HcalCondObjectContainerBase::indexFor(), HcalCondObjectContainer< HcalPedestalWidth >::initContainer(), CaloGenericDetId::isCastor(), CastorHardcodeGeometryLoader::load(), operator=(), CastorSimpleReconstructor::produce(), CaloGeometryBuilder::produceAligned(), HcalCondObjectContainerBase::sizeFor(), CastorDigiProducer::sortHits(), HcalCondObjectContainerBase::textForId(), and CastorHitCorrection::timeOfFlight().