CaloGeometry Class Reference

#include <CaloGeometry.h>

Public Member Functions
	CaloGeometry ()
std::shared_ptr< const CaloCellGeometry >	getGeometry (const DetId &id) const
	Get the cell geometry of a given detector id. More...
GlobalPoint	getPosition (const DetId &id) const
	Get the position of a given detector id. More...
const CaloSubdetectorGeometry *	getSubdetectorGeometry (const DetId &id) const
	access the subdetector geometry for the given subdetector directly More...
const CaloSubdetectorGeometry *	getSubdetectorGeometry (DetId::Detector det, int subdet) const
	access the subdetector geometry for the given subdetector directly More...
std::vector< DetId >	getValidDetIds () const
	Get the list of all valid detector ids. More...
const std::vector< DetId > &	getValidDetIds (DetId::Detector det, int subdet) const
	Get the list of valid detector ids for the given subdetector. More...
bool	present (const DetId &id) const
	is this detid present in the geometry? More...
void	setSubdetGeometry (DetId::Detector det, int subdet, const CaloSubdetectorGeometry *geom)
	Register a subdetector geometry. More...

Private Types
enum	{   kMaxDet = 10, kMinDet = 3, kNDets = kMaxDet - kMinDet + 1, kMaxSub = 6,   kNSubDets = kMaxSub + 1, kLength = kNDets * kNSubDets }

Private Member Functions
unsigned int	makeIndex (DetId::Detector det, int subdet, bool &ok) const

Private Attributes
std::vector< const CaloSubdetectorGeometry * >	m_geos

Static Private Attributes
static const std::vector< DetId >	k_emptyVec

Detailed Description

Interface class to the geometry information for all calorimetry subdetectors.

Revision

1.7

Author

J. Mans and P. Meridiani

Definition at line 21 of file CaloGeometry.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
kMaxDet
kMinDet
kNDets
kMaxSub
kNSubDets
kLength

Definition at line 59 of file CaloGeometry.h.

       {
    kMaxDet = 10,
    kMinDet = 3,
    kNDets = kMaxDet - kMinDet + 1,
    kMaxSub = 6,
    kNSubDets = kMaxSub + 1,
    kLength = kNDets * kNSubDets
  };

Constructor & Destructor Documentation

CaloGeometry()

CaloGeometry::CaloGeometry

(

)

Definition at line 9 of file CaloGeometry.cc.

: m_geos(kLength, nullptr) {}

Member Function Documentation

getGeometry()

std::shared_ptr< const CaloCellGeometry > CaloGeometry::getGeometry

(

const DetId &

id

)

const

Get the cell geometry of a given detector id.

Definition at line 60 of file CaloGeometry.cc.

References relativeConstraints::geom, and getSubdetectorGeometry().

Referenced by FWRecoGeometryESProducer::addCaloGeometry(), FWTGeoRecoGeometryESProducer::addCaloTowerGeometry(), FWTGeoRecoGeometryESProducer::addEcalCaloGeometry(), FWTGeoRecoGeometryESProducer::addHcalCaloGeometryBarrel(), FWTGeoRecoGeometryESProducer::addHcalCaloGeometryEndcap(), FWTGeoRecoGeometryESProducer::addHcalCaloGeometryForward(), FWTGeoRecoGeometryESProducer::addHcalCaloGeometryOuter(), EcalSimple2007H4TBAnalyzer::analyze(), EcalSimHitStudy::analyzeHits(), CaloTowersCreationAlgo::assignHitEcal(), EcalDetailedTimeRecHitProducer::deltaTimeOfFlight(), CaloTowersCreationAlgo::emCrystalShwrPos(), L2TauNNProducerAlpaka::fillCaloRecHits(), L2TauNNProducer::fillCaloRecHits(), EgammaRecHitIsolation::getSum_(), EgammaHcalIsolation::goodHitEnergy(), CaloTowersCreationAlgo::hadShwPosFromCells(), and SCEnergyCorrectorDRN::makeInput().

                                                                                     {
  const CaloSubdetectorGeometry* geom = getSubdetectorGeometry(id);
  if (geom) {
    auto cell = geom->getGeometry(id);
    return cell;
  } else {
    return std::shared_ptr<const CaloCellGeometry>();
  }
}

getPosition()

GlobalPoint CaloGeometry::getPosition

(

const DetId &

id

)

const

Get the position of a given detector id.

Definition at line 50 of file CaloGeometry.cc.

References relativeConstraints::geom, getSubdetectorGeometry(), and notFound.

Referenced by cms::ProducerAnalyzer::analyze(), EopTreeWriter::analyze(), ValidIsoTrkCalib::analyze(), EopElecTreeWriter::analyze(), CaloSimHitAnalysis::analyzeHits(), CaloSimHitStudy::analyzeHits(), MultipleAlgoIterator::calculateOrphanInput(), PhotonMVABasedHaloTagger::calmatchedESCoordForBothHypothesis(), PhotonMVABasedHaloTagger::calmatchedHBHECoordForBothHypothesis(), PhotonMVABasedHaloTagger::calphoClusCoordinECAL(), egammaisolation::EgammaRecHitExtractor::collect(), egammaisolation::EgammaHcalExtractor::deposit(), ecalEnergyInCone(), EcalRecHitWorkerRecover::estimateEnergy(), HcalIsoTrkSimAnalyzer::eThreshold(), HcalIsoTrkAnalyzer::eThreshold(), AlCaHcalIsotrkProducer::eThreshold(), reco::HcalNoiseInfoProducer::fillrechits(), EcalBadCalibFilter::filter(), HFNoisyHitsFilter::filter(), AlCaIsoTracksFilter::filter(), filterCellsInCone(), spr::findCone(), MultipleAlgoIterator::getEt(), ParametrizedSubtractor::getEt(), MultipleAlgoIterator::getEta(), ParametrizedSubtractor::getEta(), spr::getGpos(), HCaloDetIdAssociator::getPosition(), HcalHaloAlgo::getPosition(), EcalHaloAlgo::getPosition(), CSCHaloAlgo::getPosition(), HLTJetTimingProducer< T >::jetTimeFromEcalCells(), spr::matrixECALIds(), EgammaIsoDetIdCollectionProducer< T1 >::produce(), EcalIsolatedParticleCandidateProducer::produce(), IsolatedEcalPixelTrackCandidateProducer::produce(), reco::CentralityProducer::produce(), EcalRecHitWorkerRecover::run(), HiPuRhoProducer::setupGeometryMap(), and spr::timeOfFlight().

                                                           {
  const CaloSubdetectorGeometry* geom = getSubdetectorGeometry(id);
  if (geom) {
    GlobalPoint pos = geom->getGeometry(id)->getPosition();
    return pos;
  } else {
    return notFound;
  }
}

getSubdetectorGeometry() [1/2]

const CaloSubdetectorGeometry * CaloGeometry::getSubdetectorGeometry

(

const DetId &

id

)

const

access the subdetector geometry for the given subdetector directly

Definition at line 34 of file CaloGeometry.cc.

References m_geos, makeIndex(), and convertSQLiteXML::ok.

Referenced by FWRecoGeometryESProducer::addCaloGeometry(), HcalTestSimHitID::analyze(), HcalSimHitAnalysis::analyze(), HcalSimHitsValidation::analyze(), cms::ProducerAnalyzer::analyze(), CaloSimHitAnalysis::analyze(), CaloSimHitStudy::analyze(), HcalRecHitsValidation::analyze(), ValidIsoTrkCalib::analyze(), EopElecTreeWriter::analyze(), IsolatedTracksCone::analyze(), PFRecHitQTestECALMultiThreshold::beginEvent(), LegacyPFRecHitProducer::beginRun(), ReducedESRecHitCollectionProducer::beginRun(), PFCandidateRecalibrator::beginRun(), IsolatedPixelTrackCandidateProducer::beginRun(), IsolatedPixelTrackCandidateL1TProducer::beginRun(), HcalHBHEMuonAnalyzer::beginRun(), HcalHBHEMuonHighEtaAnalyzer::beginRun(), AlCaHcalHBHEMuonProducer::beginRun(), PhotonEnergyCorrector::calculate(), HcalHaloAlgo::Calculate(), EcalHaloAlgo::Calculate(), CSCHaloAlgo::Calculate(), spr::chargeIsolationEcal(), Multi5x5ClusterProducer::clusterizeECALPart(), IslandClusterProducer::clusterizeECALPart(), CosmicClusterProducer::clusterizeECALPart(), egammaisolation::EgammaRecHitExtractor::deposit(), HcalDigisValidation::dqmBeginRun(), HcalRecHitsAnalyzer::dqmBeginRun(), TrackDetMatchInfo::dumpGeometry(), EcalBarrelTopology::EcalBarrelTopology(), EcalClusterLazyToolsBase::EcalClusterLazyToolsBase(), EcalEndcapTopology::EcalEndcapTopology(), EgammaRecHitIsolation::EgammaRecHitIsolation(), cms::MinBias::endJob(), GlobalHitsProdHist::fillECal(), GlobalHitsAnalyzer::fillECal(), GlobalHitsProducer::fillECal(), HCALRecHitAnalyzer::FillGeometry(), ECALRecHitAnalyzer::FillGeometry(), GlobalHitsProdHist::fillHCal(), GlobalHitsAnalyzer::fillHCal(), GlobalHitsProducer::fillHCal(), GlobalRecHitsProducer::fillHCal(), HcalRecHitsValidation::fillRecHitsTmp(), filterCellsInCone(), spr::findCone(), spr::findDetIdECAL(), spr::findDetIdHCAL(), hgcal::RecHitTools::getCellType(), CaloDetIdAssociator::getDetIdPoints(), HCaloDetIdAssociator::getDetIdPoints(), DisappearingMuonsSkimming::getECALIsolation(), getGeometry(), spr::getGpos(), FixedGridRhoProducerFastjetFromRecHit::getHitP4(), hgcal::RecHitTools::getLayer(), getPosition(), CaloDetIdAssociator::getPosition(), HCaloDetIdAssociator::getPosition(), TrackDetMatchInfo::getPosition(), hgcal::RecHitTools::getPositionLayer(), hgcal::RecHitTools::getSubdetectorGeometry(), EcalClusterCrackCorrection::getValue(), PFHBHERecHitCreator::importRecHits(), PFHcalRecHitCreator< Digi, Geometry, Layer, Detector >::importRecHits(), PFPSRecHitCreator::importRecHits(), PFHFRecHitCreator::importRecHits(), PFEcalBarrelRecHitCreator::importRecHits(), PFEcalEndcapRecHitCreator::importRecHits(), PFECALHashNavigator::init(), PFBadHcalPseudoClusterProducer::init(), CaloDetIdAssociator::insideElement(), HCaloDetIdAssociator::insideElement(), egammaTools::localEcalClusterCoordsEB(), egammaTools::localEcalClusterCoordsEE(), HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::makeFilteredColl(), ticl::SeedingRegionByHF::makeRegions(), spr::matrixECALIds(), spr::matrixHCALIds(), PhysicsTowerOrganizer::PhysicsTowerOrganizer(), present(), PreshowerClusterShapeProducer::produce(), PreshowerPhiClusterProducer::produce(), PreshowerClusterProducer::produce(), PFCandidateRecalibrator::produce(), AlCaHOCalibProducer::produce(), spr::propagateCALO(), spr::propagateCosmicCALO(), spr::propagateHCAL(), spr::propagateHCALBack(), spr::propagateIdECAL(), ecaldqm::PiZeroTask::runOnEBRecHits(), CaloDualConeSelector< T >::selectCallback(), CaloConeSelector< T >::selectCallback(), hgcal::RecHitTools::setGeometry(), CaloTowersCreationAlgo::setGeometry(), Calorimeter::setupGeometry(), CaloHitResponse::timeOfFlight(), spr::timeOfFlight(), ECAL2DPositionCalcWithDepthCorr::update(), PFECALSuperClusterAlgo::update(), EcalTimeDigiProducer::updateGeometry(), EcalDigiProducer_Ph2::updateGeometry(), EcalDigiProducer::updateGeometry(), and ValidateGeometry::validateCaloGeometry().

                                                                                         {
  bool ok;

  const unsigned int index(makeIndex(id.det(), id.subdetId(), ok));
  return (ok ? m_geos[index] : nullptr);
}

getSubdetectorGeometry() [2/2]

const CaloSubdetectorGeometry * CaloGeometry::getSubdetectorGeometry	(	DetId::Detector	det,
		int	subdet
	)		const

access the subdetector geometry for the given subdetector directly

Definition at line 41 of file CaloGeometry.cc.

References m_geos, makeIndex(), and convertSQLiteXML::ok.

                                                                                                       {
  bool ok;

  const unsigned int index(makeIndex(det, subdet, ok));
  return (ok ? m_geos[index] : nullptr);
}

getValidDetIds() [1/2]

std::vector< DetId > CaloGeometry::getValidDetIds

(

)

const

Get the list of all valid detector ids.

Definition at line 75 of file CaloGeometry.cc.

References DetId::Hcal, mps_fire::i, kLength, and m_geos.

Referenced by FWRecoGeometryESProducer::addCaloGeometry(), FWTGeoRecoGeometryESProducer::addCaloTowerGeometry(), FWTGeoRecoGeometryESProducer::addEcalCaloGeometry(), FWTGeoRecoGeometryESProducer::addHcalCaloGeometryBarrel(), FWTGeoRecoGeometryESProducer::addHcalCaloGeometryEndcap(), FWTGeoRecoGeometryESProducer::addHcalCaloGeometryForward(), FWTGeoRecoGeometryESProducer::addHcalCaloGeometryOuter(), cms::MinBias::beginRun(), EcalDccWeightBuilder::computeAllWeights(), EcalMixingModuleValidation::computeSDBunchDigi(), HEcalDetIdAssociator::getASetOfValidDetIds(), HHcalDetIdAssociator::getASetOfValidDetIds(), HCaloDetIdAssociator::getASetOfValidDetIds(), HODetIdAssociator::getValidDetIds(), PreshowerDetIdAssociator::getValidDetIds(), EcalDetIdAssociator::getValidDetIds(), HcalDetIdAssociator::getValidDetIds(), getValidDetIds(), CaloDetIdAssociator::getValidDetIds(), PFHCALDenseIdNavigator< HcalDetId, HcalTopology, false >::init(), HiPuRhoProducer::setupGeometryMap(), HcalTBDigiProducer::updateGeometry(), and HcalDigitizer::updateGeometry().

                                                    {
  std::vector<DetId> returnValue;
  returnValue.reserve(kLength);

  bool doneHcal(false);
  for (unsigned int i(0); i != m_geos.size(); ++i) {
    if (nullptr != m_geos[i]) {
      const std::vector<DetId>& aVec = m_geos[i]->getValidDetIds();
      if (aVec.empty()) {
        edm::LogWarning("CaloGeometry") << "Valid det id list at index " << i << " is empty!";
      }
      const bool isHcal(!aVec.empty() && DetId::Hcal == aVec.front().det());
      if (!doneHcal || !isHcal) {
        returnValue.insert(returnValue.end(), aVec.begin(), aVec.end());
        if (!doneHcal && isHcal)
          doneHcal = true;
      }
    }
  }
  return returnValue;
}

getValidDetIds() [2/2]

const std::vector< DetId > & CaloGeometry::getValidDetIds	(	DetId::Detector	det,
		int	subdet
	)		const

Get the list of valid detector ids for the given subdetector.

Definition at line 97 of file CaloGeometry.cc.

References getValidDetIds(), k_emptyVec, m_geos, makeIndex(), and convertSQLiteXML::ok.

                                                                                        {
  bool ok;

  const unsigned int index(makeIndex(det, subdet, ok));

  return (ok && (nullptr != m_geos[index]) ? m_geos[index]->getValidDetIds(det, subdet) : k_emptyVec);
}

makeIndex()

unsigned int CaloGeometry::makeIndex ( DetId::Detector  det, int  subdet, bool &  ok  ) const

private

Definition at line 11 of file CaloGeometry.cc.

References kMaxDet, kMaxSub, kMinDet, kNSubDets, and convertSQLiteXML::ok.

Referenced by getSubdetectorGeometry(), getValidDetIds(), and setSubdetGeometry().

                                                                                  {
  const unsigned int idet(det);

  ok = (kMinDet <= idet && kMaxDet >= idet && 0 <= subdet && kMaxSub >= subdet);
  if (!ok)
    edm::LogWarning("CaloGeometry") << "Det:Subdet " << idet << ":" << subdet << " min|max Det " << kMinDet << ":"
                                    << kMaxDet << " min|max subdet 0:" << kMaxSub;

  return ((det - kMinDet) * kNSubDets + subdet);
}

present()

bool CaloGeometry::present

(

const DetId &

id

)

const

is this detid present in the geometry?

Definition at line 70 of file CaloGeometry.cc.

References relativeConstraints::geom, and getSubdetectorGeometry().

                                                {
  const CaloSubdetectorGeometry* geom = getSubdetectorGeometry(id);
  return (nullptr == geom ? false : geom->present(id));
}

setSubdetGeometry()

void CaloGeometry::setSubdetGeometry	(	DetId::Detector	det,
		int	subdet,
		const CaloSubdetectorGeometry *	geom
	)

Register a subdetector geometry.

Definition at line 22 of file CaloGeometry.cc.

References cms::cuda::assert(), relativeConstraints::geom, createfilelist::int, m_geos, makeIndex(), and convertSQLiteXML::ok.

                                                                                                       {
  bool ok;
  const unsigned int index = makeIndex(det, subdet, ok);
  if (ok)
    m_geos[index] = geom;

  edm::LogVerbatim("CaloGeometry") << "Detector=" << (int)det << ", subset=" << subdet << ", index=" << index
                                   << ", size=" << m_geos.size();

  assert(ok);
}

Member Data Documentation

k_emptyVec

const std::vector< DetId > CaloGeometry::k_emptyVec

staticprivate

Definition at line 53 of file CaloGeometry.h.

Referenced by getValidDetIds().

m_geos

std::vector<const CaloSubdetectorGeometry*> CaloGeometry::m_geos

private

Definition at line 55 of file CaloGeometry.h.

Referenced by getSubdetectorGeometry(), getValidDetIds(), and setSubdetGeometry().