HcalTrigTowerGeometry Class Reference

#include <HcalTrigTowerGeometry.h>

Public Member Functions
std::vector< HcalDetId >	detIds (const HcalTrigTowerDetId &) const
int	firstHFTower (int version) const
	HcalTrigTowerGeometry (const HcalTopology *topology)
int	nTowers (int version) const
	number of towers (version dependent) More...
const HcalTopology &	topology () const
void	towerEtaBounds (int ieta, int version, double &eta1, double &eta2) const
	where this tower begins and ends in eta More...
std::vector< HcalTrigTowerDetId >	towerIds (const HcalDetId &cellId) const
	the mapping to and from DetIds More...
bool	use1x1 () const
bool	useRCT () const

Private Member Functions
int	firstHFRingInTower (int ietaTower) const
	since the towers are irregular in eta in HF More...
int	hfTowerEtaSize (int ieta) const
int	nPhiBins (int ieta, int version) const
	the number of phi bins in this eta ring More...

Private Attributes
const HcalTopology *	theTopology
bool	use1x1_
bool	use2017_
bool	useRCT_

Detailed Description

Definition at line 10 of file HcalTrigTowerGeometry.h.

Constructor & Destructor Documentation

HcalTrigTowerGeometry()

HcalTrigTowerGeometry::HcalTrigTowerGeometry

(

const HcalTopology *

topology

)

Definition at line 8 of file HcalTrigTowerGeometry.cc.

References or, theTopology, HcalTopology::triggerMode(), HcalTopologyMode::TriggerMode_2016, HcalTopologyMode::TriggerMode_2017, HcalTopologyMode::TriggerMode_2018legacy, use1x1_, use2017_, and useRCT_.

                                                                         : theTopology(topology) {
  auto tmode = theTopology->triggerMode();
  useRCT_ = tmode <= HcalTopologyMode::TriggerMode_2016;
  use1x1_ = tmode >= HcalTopologyMode::TriggerMode_2016;
  use2017_ = tmode >= HcalTopologyMode::TriggerMode_2017 or tmode == HcalTopologyMode::TriggerMode_2018legacy;
}

Member Function Documentation

detIds()

std::vector< HcalDetId > HcalTrigTowerGeometry::detIds

(

const HcalTrigTowerDetId &

hcalTrigTowerDetId

)

const

Definition at line 84 of file HcalTrigTowerGeometry.cc.

References funct::abs(), HcalTopology::depthBinInformation(), HcalTopology::firstHEDoublePhiRing(), HcalTopology::firstHERing(), HcalTopology::firstHFRing(), firstHFRingInTower(), HcalBarrel, HcalEndcap, HcalForward, HcalOuter, hfTowerEtaSize(), HcalTrigTowerDetId::ieta(), HcalTrigTowerDetId::iphi(), HcalTopology::lastHBRing(), HcalTopology::lastHERing(), HcalTopology::lastHORing(), nPhiBins(), mysort::results, theTopology, use2017_, HcalTrigTowerDetId::version(), HcalTrigTowerDetId::zside(), and ecaldqm::zside().

Referenced by L1EGCrystalClusterEmulatorProducer::produce().

                                                                                                     {
  // Written, tested by E. Berry (Princeton)
  std::vector<HcalDetId> results;

  int tower_ieta = hcalTrigTowerDetId.ieta();
  int tower_iphi = hcalTrigTowerDetId.iphi();

  int cell_ieta = tower_ieta;
  int cell_iphi = tower_iphi;

  int min_depth, n_depths;

  // HB

  if (abs(cell_ieta) <= theTopology->lastHBRing()) {
    theTopology->depthBinInformation(
        HcalBarrel, abs(tower_ieta), tower_iphi, hcalTrigTowerDetId.zside(), n_depths, min_depth);
    for (int cell_depth = min_depth; cell_depth <= min_depth + n_depths - 1; cell_depth++)
      results.emplace_back(HcalDetId(HcalBarrel, cell_ieta, cell_iphi, cell_depth));
  }

  // HO

  if (abs(cell_ieta) <= theTopology->lastHORing()) {
    theTopology->depthBinInformation(
        HcalOuter, abs(tower_ieta), tower_iphi, hcalTrigTowerDetId.zside(), n_depths, min_depth);
    for (int ho_depth = min_depth; ho_depth <= min_depth + n_depths - 1; ho_depth++)
      results.emplace_back(HcalDetId(HcalOuter, cell_ieta, cell_iphi, ho_depth));
  }

  // HE

  if (abs(cell_ieta) >= theTopology->firstHERing() && abs(cell_ieta) < theTopology->lastHERing()) {
    theTopology->depthBinInformation(
        HcalEndcap, abs(tower_ieta), tower_iphi, hcalTrigTowerDetId.zside(), n_depths, min_depth);

    // Special for double-phi cells
    if (abs(cell_ieta) >= theTopology->firstHEDoublePhiRing())
      if (tower_iphi % 2 == 0)
        cell_iphi = tower_iphi - 1;

    if (use2017_) {
      if (abs(tower_ieta) == 26)
        --n_depths;
      if (tower_ieta == 27)
        results.emplace_back(HcalDetId(HcalEndcap, cell_ieta - 1, cell_iphi, 7));
      if (tower_ieta == -27)
        results.emplace_back(HcalDetId(HcalEndcap, cell_ieta + 1, cell_iphi, 7));
    }

    for (int cell_depth = min_depth; cell_depth <= min_depth + n_depths - 1; cell_depth++)
      results.emplace_back(HcalDetId(HcalEndcap, cell_ieta, cell_iphi, cell_depth));

    // Special for split-eta cells
    if (abs(tower_ieta) == 28) {
      theTopology->depthBinInformation(
          HcalEndcap, abs(tower_ieta) + 1, tower_iphi, hcalTrigTowerDetId.zside(), n_depths, min_depth);
      for (int cell_depth = min_depth; cell_depth <= min_depth + n_depths - 1; cell_depth++) {
        if (tower_ieta < 0)
          results.emplace_back(HcalDetId(HcalEndcap, tower_ieta - 1, cell_iphi, cell_depth));
        if (tower_ieta > 0)
          results.emplace_back(HcalDetId(HcalEndcap, tower_ieta + 1, cell_iphi, cell_depth));
      }
    }
  }

  // HF

  if (abs(cell_ieta) >= theTopology->firstHFRing()) {
    if (hcalTrigTowerDetId.version() == 0) {
      int HfTowerPhiSize = 72 / nPhiBins(tower_ieta, 0);

      int HfTowerEtaSize = hfTowerEtaSize(tower_ieta);
      int FirstHFRingInTower = firstHFRingInTower(abs(tower_ieta));

      for (int iHFTowerPhiSegment = 0; iHFTowerPhiSegment < HfTowerPhiSize; iHFTowerPhiSegment++) {
        cell_iphi = (tower_iphi / HfTowerPhiSize) * HfTowerPhiSize;  // Find the minimum phi segment
        cell_iphi -= 2;                   // The first trigger tower starts at HCAL iphi = 71, not HCAL iphi = 1
        cell_iphi += iHFTowerPhiSegment;  // Get all of the HCAL iphi values in this trigger tower
        cell_iphi += 72;                  // Don't want to take the mod of a negative number
        cell_iphi = cell_iphi % 72;       // There are, at most, 72 cells.
        cell_iphi += 1;                   // There is no cell at iphi = 0

        if (cell_iphi % 2 == 0)
          continue;  // These cells don't exist.

        for (int iHFTowerEtaSegment = 0; iHFTowerEtaSegment < HfTowerEtaSize; iHFTowerEtaSegment++) {
          cell_ieta = FirstHFRingInTower + iHFTowerEtaSegment;

          if (cell_ieta >= 40 && cell_iphi % 4 == 1)
            continue;  // These cells don't exist.

          theTopology->depthBinInformation(
              HcalForward, cell_ieta, tower_iphi, hcalTrigTowerDetId.zside(), n_depths, min_depth);

          // Negative tower_ieta -> negative cell_ieta
          int zside = 1;
          if (tower_ieta < 0)
            zside = -1;

          cell_ieta *= zside;

          for (int cell_depth = min_depth; cell_depth <= min_depth + n_depths - 1; cell_depth++)
            results.emplace_back(HcalDetId(HcalForward, cell_ieta, cell_iphi, cell_depth));

          if (zside * cell_ieta == 30) {
            theTopology->depthBinInformation(
                HcalForward, 29 * zside, tower_iphi, hcalTrigTowerDetId.zside(), n_depths, min_depth);
            for (int cell_depth = min_depth; cell_depth <= min_depth + n_depths - 1; cell_depth++)
              results.emplace_back(HcalDetId(HcalForward, 29 * zside, cell_iphi, cell_depth));
          }
        }
      }
    } else if (hcalTrigTowerDetId.version() == 1) {
      theTopology->depthBinInformation(
          HcalForward, tower_ieta, tower_iphi, hcalTrigTowerDetId.zside(), n_depths, min_depth);
      for (int cell_depth = min_depth; cell_depth <= min_depth + n_depths - 1; cell_depth++)
        results.emplace_back(HcalDetId(HcalForward, tower_ieta, tower_iphi, cell_depth));
      if (abs(tower_ieta) == 30) {
        int i29 = 29;
        if (tower_ieta < 0)
          i29 = -29;
        theTopology->depthBinInformation(HcalForward, i29, tower_iphi, hcalTrigTowerDetId.zside(), n_depths, min_depth);
        for (int cell_depth = min_depth; cell_depth <= min_depth + n_depths - 1; cell_depth++)
          results.emplace_back(HcalDetId(HcalForward, i29, tower_iphi, cell_depth));
      }
    }
  }

  return results;
}

firstHFRingInTower()

int HcalTrigTowerGeometry::firstHFRingInTower ( int  ietaTower ) const

private

since the towers are irregular in eta in HF

Definition at line 223 of file HcalTrigTowerGeometry.cc.

References funct::abs(), HcalTopology::firstHFRing(), firstHFTower(), hfTowerEtaSize(), mps_fire::result, and theTopology.

Referenced by detIds(), and towerIds().

                                                                 {
  // count up to the correct HF ring
  int inputTower = abs(ietaTower);
  int result = theTopology->firstHFRing();
  for (int iTower = firstHFTower(0); iTower != inputTower; ++iTower) {
    result += hfTowerEtaSize(iTower);
  }

  // negative in, negative out.
  if (ietaTower < 0)
    result *= -1;
  return result;
}

firstHFTower()

int HcalTrigTowerGeometry::firstHFTower ( int  version ) const

inline

Definition at line 18 of file HcalTrigTowerGeometry.h.

References BeamSplash_cfg::version.

Referenced by firstHFRingInTower(), hfTowerEtaSize(), CaloTPGTranscoderULUT::loadHCALCompress(), L1CaloHcalScaleConfigOnlineProd::newObject(), nPhiBins(), HcalTriggerPrimitiveAlgo::run(), towerEtaBounds(), and towerIds().

{ return (version == 1) ? (30) : (29); }

hfTowerEtaSize()

int HcalTrigTowerGeometry::hfTowerEtaSize ( int  ieta ) const

private

the number of HF eta rings in this trigger tower ieta starts at firstHFTower()

Definition at line 216 of file HcalTrigTowerGeometry.cc.

References funct::abs(), cms::cuda::assert(), firstHFTower(), LEDCalibrationChannels::ieta, and nTowers().

Referenced by detIds(), and firstHFRingInTower().

                                                        {
  int ietaAbs = abs(ieta);
  assert(ietaAbs >= firstHFTower(0) && ietaAbs <= nTowers(0));
  // the first three come from rings 29-31, 32-34, 35-37. The last has 4 rings: 38-41
  return (ietaAbs == nTowers(0)) ? 4 : 3;
}

nPhiBins()

int HcalTrigTowerGeometry::nPhiBins ( int  ieta, int  version  ) const

inlineprivate

the number of phi bins in this eta ring

Definition at line 35 of file HcalTrigTowerGeometry.h.

References funct::abs(), firstHFTower(), LEDCalibrationChannels::ieta, and BeamSplash_cfg::version.

Referenced by detIds().

                                            {
    int nPhiBinsHF = (18);
    return (abs(ieta) < firstHFTower(version)) ? 72 : nPhiBinsHF;
  }

nTowers()

int HcalTrigTowerGeometry::nTowers ( int  version ) const

inline

number of towers (version dependent)

Definition at line 24 of file HcalTrigTowerGeometry.h.

References BeamSplash_cfg::version.

Referenced by hfTowerEtaSize().

{ return (version == 1) ? (41) : (32); }

topology()

const HcalTopology& HcalTrigTowerGeometry::topology ( ) const

inline

Definition at line 27 of file HcalTrigTowerGeometry.h.

References theTopology.

Referenced by HcalTriggerPrimitiveAlgo::analyzeQIE11().

{ return *theTopology; }

towerEtaBounds()

void HcalTrigTowerGeometry::towerEtaBounds	(	int	ieta,
		int	version,
		double &	eta1,
		double &	eta2
	)		const

where this tower begins and ends in eta

Definition at line 237 of file HcalTrigTowerGeometry.cc.

References funct::abs(), HLT_2023v12_cff::eta1, HLT_2023v12_cff::eta2, HcalTopology::etaRange(), EnergyCorrector::etas, firstHFTower(), HcalBarrel, HcalForward, LEDCalibrationChannels::ieta, theTopology, createJobs::tmp, and BeamSplash_cfg::version.

Referenced by CaloTPGTranscoderULUT::loadHCALCompress(), HcaluLUTTPGCoder::make_cosh_ieta_map(), and L1CaloHcalScaleConfigOnlineProd::newObject().

                                                                                                  {
  int ietaAbs = abs(ieta);
  std::pair<double, double> etas = (ietaAbs < firstHFTower(version)) ? theTopology->etaRange(HcalBarrel, ietaAbs)
                                                                     : theTopology->etaRange(HcalForward, ietaAbs);
  eta1 = etas.first;
  eta2 = etas.second;

  // get the signs and order right
  if (ieta < 0) {
    double tmp = eta1;
    eta1 = -eta2;
    eta2 = -tmp;
  }
}

towerIds()

std::vector< HcalTrigTowerDetId > HcalTrigTowerGeometry::towerIds

(

const HcalDetId &

cellId

)

const

the mapping to and from DetIds

Definition at line 15 of file HcalTrigTowerGeometry.cc.

References LEDCalibrationChannels::depth, HcalDetId::depth(), HcalTopology::firstHEDoublePhiRing(), firstHFRingInTower(), firstHFTower(), HcalForward, l1ctLayer2EG_cff::id, LEDCalibrationChannels::ieta, HcalDetId::ieta(), HcalDetId::ietaAbs(), LEDCalibrationChannels::iphi, HcalDetId::iphi(), HcalTopology::lastHBRing(), HcalTopology::lastHERing(), HcalTopology::maxDepthHE(), mysort::results, HcalDetId::subdet(), theTopology, use1x1_, use2017_, useRCT_, and HcalDetId::zside().

Referenced by HcalTriggerPrimitiveAlgo::addSignal(), HcalTriggerPrimitiveAlgo::addUpgradeTDCFG(), HcalTriggerPrimitiveAlgo::analyzeQIE11(), HcalTriggerPrimitiveAlgo::runFEFormatError(), and CaloTPGTranscoderULUT::setup().

                                                                                           {
  std::vector<HcalTrigTowerDetId> results;

  if (cellId.subdet() == HcalForward) {
    if (useRCT_) {
      // first do eta
      int hfRing = cellId.ietaAbs();
      int ieta = firstHFTower(0);
      // find the tower that contains this ring
      while (hfRing >= firstHFRingInTower(ieta + 1)) {
        ++ieta;
      }

      ieta *= cellId.zside();

      // now for phi
      // HF towers are quad, 18 in phi.
      // go two cells per trigger tower.

      int iphi = (((cellId.iphi() + 1) / 4) * 4 + 1) % 72;  // 71+1 --> 1, 3+5 --> 5
      results.emplace_back(HcalTrigTowerDetId(ieta, iphi));
    }
    if (use1x1_) {
      int hfRing = cellId.ietaAbs();
      if (hfRing == 29)
        hfRing = 30;  // sum 29 into 30.

      int ieta = hfRing * cellId.zside();
      int iphi = cellId.iphi();

      HcalTrigTowerDetId id(ieta, iphi);
      id.setVersion(1);  // version 1 for 1x1 HF granularity
      results.emplace_back(id);
    }

  } else {
    // the first twenty rings are one-to-one
    if (cellId.ietaAbs() <= theTopology->lastHBRing()) {
      results.emplace_back(HcalTrigTowerDetId(cellId.ieta(), cellId.iphi()));
    } else if (theTopology->maxDepthHE() == 0) {
      // Ignore these
    } else if (cellId.ietaAbs() < theTopology->firstHEDoublePhiRing()) {
      results.emplace_back(HcalTrigTowerDetId(cellId.ieta(), cellId.iphi()));
    } else {
      // the remaining rings are two-to-one in phi
      int iphi1 = cellId.iphi();
      int ieta = cellId.ieta();
      int depth = cellId.depth();
      // the last eta ring in HE is split.  Recombine.
      if (ieta == theTopology->lastHERing())
        --ieta;
      if (ieta == -theTopology->lastHERing())
        ++ieta;

      if (use2017_) {
        if (ieta == 26 and depth == 7)
          ++ieta;
        if (ieta == -26 and depth == 7)
          --ieta;
      }

      results.emplace_back(HcalTrigTowerDetId(ieta, iphi1));
      results.emplace_back(HcalTrigTowerDetId(ieta, iphi1 + 1));
    }
  }

  return results;
}

use1x1()

bool HcalTrigTowerGeometry::use1x1 ( ) const

inline

Definition at line 31 of file HcalTrigTowerGeometry.h.

References use1x1_.

Referenced by L1TCaloLayer1FetchLUTs().

{ return use1x1_; }

useRCT()

bool HcalTrigTowerGeometry::useRCT ( ) const

inline

Definition at line 30 of file HcalTrigTowerGeometry.h.

References useRCT_.

{ return useRCT_; }

Member Data Documentation

theTopology

const HcalTopology* HcalTrigTowerGeometry::theTopology

private

Definition at line 48 of file HcalTrigTowerGeometry.h.

Referenced by detIds(), firstHFRingInTower(), HcalTrigTowerGeometry(), topology(), towerEtaBounds(), and towerIds().

use1x1_

bool HcalTrigTowerGeometry::use1x1_

private

Definition at line 51 of file HcalTrigTowerGeometry.h.

Referenced by HcalTrigTowerGeometry(), towerIds(), and use1x1().

use2017_

bool HcalTrigTowerGeometry::use2017_

private

Definition at line 52 of file HcalTrigTowerGeometry.h.

Referenced by detIds(), HcalTrigTowerGeometry(), and towerIds().

useRCT_

bool HcalTrigTowerGeometry::useRCT_

private

Definition at line 50 of file HcalTrigTowerGeometry.h.

Referenced by HcalTrigTowerGeometry(), towerIds(), and useRCT().