Skip to content

Commit

Permalink
Merge pull request #43167 from bsunanda/Phase2-hgx348A
Browse files Browse the repository at this point in the history 
Phase2-hgx348A Make use of constexpr in the scintillator DeId for HGCal for better processing
  • Loading branch information
@cmsbuild
cmsbuild authored Nov 6, 2023
2 parents 5915557 + 95c7bc2 commit 324fa41
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 136 deletions.
159 changes: 113 additions & 46 deletions DataFormats/ForwardDetId/interface/HGCScintillatorDetId.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#include <vector>
#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/ForwardDetId/interface/ForwardSubdetector.h"
#include "FWCore/Utilities/interface/Exception.h"

/* \brief description of the bit assigment
[0:8] iphi index wrt x-axis on +z side
Expand All @@ -23,81 +24,147 @@
class HGCScintillatorDetId : public DetId {
public:
/** Create a null cellid*/
HGCScintillatorDetId();
constexpr HGCScintillatorDetId() : DetId() {}
/** Create cellid from raw id (0=invalid tower id) */
HGCScintillatorDetId(uint32_t rawid);
constexpr HGCScintillatorDetId(uint32_t rawid) : DetId(rawid) {}
/** Constructor from subdetector, zplus, layer, module, cell numbers */
HGCScintillatorDetId(int type, int layer, int ring, int iphi, bool trigger = false, int sipm = 0);
constexpr HGCScintillatorDetId(int type, int layer, int ring, int phi, bool trigger = false, int sipm = 0)
: DetId(HGCalHSc, ForwardEmpty) {
int zside = (ring < 0) ? 1 : 0;
int itrig = trigger ? 1 : 0;
int ringAbs = std::abs(ring);
id_ |= (((type & kHGCalTypeMask) << kHGCalTypeOffset) | ((zside & kHGCalZsideMask) << kHGCalZsideOffset) |
((sipm & kHGCalSiPMMask) << kHGCalSiPMOffset) | ((itrig & kHGCalTriggerMask) << kHGCalTriggerOffset) |
((layer & kHGCalLayerMask) << kHGCalLayerOffset) | ((ringAbs & kHGCalRadiusMask) << kHGCalRadiusOffset) |
((phi & kHGCalPhiMask) << kHGCalPhiOffset));
}

/** Constructor from a generic cell id */
HGCScintillatorDetId(const DetId& id);
constexpr HGCScintillatorDetId(const DetId& gen) {
if (!gen.null()) {
if (gen.det() != HGCalHSc) {
throw cms::Exception("Invalid DetId")
<< "Cannot initialize HGCScintillatorDetId from " << std::hex << gen.rawId() << std::dec;
}
}
id_ = gen.rawId();
}

/** Assignment from a generic cell id */
HGCScintillatorDetId& operator=(const DetId& id);
constexpr HGCScintillatorDetId& operator=(const DetId& gen) {
if (!gen.null()) {
if (gen.det() != HGCalHSc) {
throw cms::Exception("Invalid DetId")
<< "Cannot assign HGCScintillatorDetId from " << std::hex << gen.rawId() << std::dec;
}
}
id_ = gen.rawId();
return (*this);
}

/** Converter for a geometry cell id */
HGCScintillatorDetId geometryCell() const;
constexpr HGCScintillatorDetId geometryCell() const {
if (trigger()) {
return HGCScintillatorDetId(type(), layer(), iradiusTrigger(), iphiTrigger(), false);
} else {
return HGCScintillatorDetId(type(), layer(), iradius(), iphi(), false);
}
}

/// get the subdetector
DetId::Detector subdet() const { return det(); }
constexpr DetId::Detector subdet() const { return det(); }

/// get/set the type
int type() const { return (id_ >> kHGCalTypeOffset) & kHGCalTypeMask; }
void setType(int type);
constexpr int type() const { return (id_ >> kHGCalTypeOffset) & kHGCalTypeMask; }
constexpr void setType(int type) {
id_ &= kHGCalTypeMask0;
id_ |= ((type & kHGCalTypeMask) << kHGCalTypeOffset);
}

/// get the z-side of the cell (1/-1)
int zside() const { return (((id_ >> kHGCalZsideOffset) & kHGCalZsideMask) ? -1 : 1); }
constexpr int zside() const { return (((id_ >> kHGCalZsideOffset) & kHGCalZsideMask) ? -1 : 1); }

/// get the layer #
int layer() const { return (id_ >> kHGCalLayerOffset) & kHGCalLayerMask; }
constexpr int layer() const { return (id_ >> kHGCalLayerOffset) & kHGCalLayerMask; }

/// get the eta index
int ring() const;
int iradiusAbs() const { return ring(); }
int iradius() const { return zside() * ring(); }
int ietaAbs() const { return ring(); }
int ieta() const { return zside() * ring(); }
constexpr int ring() const {
if (trigger())
return (2 * ((id_ >> kHGCalRadiusOffset) & kHGCalRadiusMask));
else
return ((id_ >> kHGCalRadiusOffset) & kHGCalRadiusMask);
}
constexpr int iradiusAbs() const { return ring(); }
constexpr int iradius() const { return zside() * ring(); }
constexpr int ietaAbs() const { return ring(); }
constexpr int ieta() const { return zside() * ring(); }

/// get the phi index
int iphi() const;
std::pair<int, int> ietaphi() const { return std::pair<int, int>(ieta(), iphi()); }
std::pair<int, int> ringphi() const { return std::pair<int, int>(iradius(), iphi()); }
constexpr int iphi() const {
if (trigger())
return (2 * ((id_ >> kHGCalPhiOffset) & kHGCalPhiMask));
else
return ((id_ >> kHGCalPhiOffset) & kHGCalPhiMask);
}
constexpr std::pair<int, int> ietaphi() const { return std::pair<int, int>(ieta(), iphi()); }
constexpr std::pair<int, int> ringphi() const { return std::pair<int, int>(iradius(), iphi()); }

/// get/set the sipm size
int sipm() const { return (id_ >> kHGCalSiPMOffset) & kHGCalSiPMMask; }
void setSiPM(int sipm);
constexpr int sipm() const { return (id_ >> kHGCalSiPMOffset) & kHGCalSiPMMask; }
constexpr void setSiPM(int sipm) {
id_ &= kHGCalSiPMMask0;
id_ |= ((sipm & kHGCalSiPMMask) << kHGCalSiPMOffset);
}

/// trigger or detector cell
std::vector<HGCScintillatorDetId> detectorCells() const;
bool trigger() const { return (((id_ >> kHGCalTriggerOffset) & kHGCalTriggerMask) == 1); }
HGCScintillatorDetId triggerCell() const;

constexpr bool trigger() const { return (((id_ >> kHGCalTriggerOffset) & kHGCalTriggerMask) == 1); }
constexpr HGCScintillatorDetId triggerCell() const {
if (trigger())
return HGCScintillatorDetId(type(), layer(), iradius(), iphi(), true);
else
return HGCScintillatorDetId(type(), layer(), iradiusTrigger(), iphiTrigger(), true);
}

/// consistency check : no bits left => no overhead
bool isEE() const { return false; }
bool isHE() const { return true; }
bool isForward() const { return true; }
constexpr bool isEE() const { return false; }
constexpr bool isHE() const { return true; }
constexpr bool isForward() const { return true; }

static const HGCScintillatorDetId Undefined;

public:
static const int kHGCalPhiOffset = 0;
static const int kHGCalPhiMask = 0x1FF;
static const int kHGCalRadiusOffset = 9;
static const int kHGCalRadiusMask = 0xFF;
static const int kHGCalLayerOffset = 17;
static const int kHGCalLayerMask = 0x1F;
static const int kHGCalTriggerOffset = 22;
static const int kHGCalTriggerMask = 0x1;
static const int kHGCalSiPMOffset = 23;
static const int kHGCalSiPMMask = 0x1;
static const int kHGCalSiPMMask0 = 0xFF7FFFFF;
static const int kHGCalZsideOffset = 25;
static const int kHGCalZsideMask = 0x1;
static const int kHGCalTypeOffset = 26;
static const int kHGCalTypeMask = 0x3;
static const int kHGCalTypeMask0 = 0xF3FFFFFF;

int iradiusTriggerAbs() const;
int iradiusTrigger() const { return zside() * iradiusTriggerAbs(); }
int iphiTrigger() const;
static constexpr int kHGCalPhiOffset = 0;
static constexpr int kHGCalPhiMask = 0x1FF;
static constexpr int kHGCalRadiusOffset = 9;
static constexpr int kHGCalRadiusMask = 0xFF;
static constexpr int kHGCalLayerOffset = 17;
static constexpr int kHGCalLayerMask = 0x1F;
static constexpr int kHGCalTriggerOffset = 22;
static constexpr int kHGCalTriggerMask = 0x1;
static constexpr int kHGCalSiPMOffset = 23;
static constexpr int kHGCalSiPMMask = 0x1;
static constexpr int kHGCalSiPMMask0 = 0xFF7FFFFF;
static constexpr int kHGCalZsideOffset = 25;
static constexpr int kHGCalZsideMask = 0x1;
static constexpr int kHGCalTypeOffset = 26;
static constexpr int kHGCalTypeMask = 0x3;
static constexpr int kHGCalTypeMask0 = 0xF3FFFFFF;

constexpr int iradiusTriggerAbs() const {
if (trigger())
return ((ring() + 1) / 2);
else
return ring();
}
constexpr int iradiusTrigger() const { return zside() * iradiusTriggerAbs(); }
constexpr int iphiTrigger() const {
if (trigger())
return ((iphi() + 1) / 2);
else
return iphi();
}
};

std::ostream& operator<<(std::ostream&, const HGCScintillatorDetId& id);
Expand Down
90 changes: 0 additions & 90 deletions DataFormats/ForwardDetId/src/HGCScintillatorDetId.cc
View file
Original file line number Diff line number Diff line change
@@ -1,84 +1,9 @@
#include "DataFormats/ForwardDetId/interface/HGCScintillatorDetId.h"
#include "FWCore/Utilities/interface/Exception.h"
#include <ostream>
#include <iostream>

const HGCScintillatorDetId HGCScintillatorDetId::Undefined(0, 0, 0, 0, false);

HGCScintillatorDetId::HGCScintillatorDetId() : DetId() {}

HGCScintillatorDetId::HGCScintillatorDetId(uint32_t rawid) : DetId(rawid) {}

HGCScintillatorDetId::HGCScintillatorDetId(int type, int layer, int ring, int phi, bool trigger, int sipm)
: DetId(HGCalHSc, ForwardEmpty) {
int zside = (ring < 0) ? 1 : 0;
int itrig = trigger ? 1 : 0;
int ringAbs = std::abs(ring);
id_ |= (((type & kHGCalTypeMask) << kHGCalTypeOffset) | ((zside & kHGCalZsideMask) << kHGCalZsideOffset) |
((sipm & kHGCalSiPMMask) << kHGCalSiPMOffset) | ((itrig & kHGCalTriggerMask) << kHGCalTriggerOffset) |
((layer & kHGCalLayerMask) << kHGCalLayerOffset) | ((ringAbs & kHGCalRadiusMask) << kHGCalRadiusOffset) |
((phi & kHGCalPhiMask) << kHGCalPhiOffset));
}

HGCScintillatorDetId::HGCScintillatorDetId(const DetId& gen) {
if (!gen.null()) {
if (gen.det() != HGCalHSc) {
throw cms::Exception("Invalid DetId")
<< "Cannot initialize HGCScintillatorDetId from " << std::hex << gen.rawId() << std::dec;
}
}
id_ = gen.rawId();
}

HGCScintillatorDetId& HGCScintillatorDetId::operator=(const DetId& gen) {
if (!gen.null()) {
if (gen.det() != HGCalHSc) {
throw cms::Exception("Invalid DetId")
<< "Cannot assign HGCScintillatorDetId from " << std::hex << gen.rawId() << std::dec;
}
}
id_ = gen.rawId();
return (*this);
}

int HGCScintillatorDetId::ring() const {
if (trigger())
return (2 * ((id_ >> kHGCalRadiusOffset) & kHGCalRadiusMask));
else
return ((id_ >> kHGCalRadiusOffset) & kHGCalRadiusMask);
}

int HGCScintillatorDetId::iradiusTriggerAbs() const {
if (trigger())
return ((ring() + 1) / 2);
else
return ring();
}

int HGCScintillatorDetId::iphi() const {
if (trigger())
return (2 * ((id_ >> kHGCalPhiOffset) & kHGCalPhiMask));
else
return ((id_ >> kHGCalPhiOffset) & kHGCalPhiMask);
}

int HGCScintillatorDetId::iphiTrigger() const {
if (trigger())
return ((iphi() + 1) / 2);
else
return iphi();
}

void HGCScintillatorDetId::setType(int type) {
id_ &= kHGCalTypeMask0;
id_ |= ((type & kHGCalTypeMask) << kHGCalTypeOffset);
}

void HGCScintillatorDetId::setSiPM(int sipm) {
id_ &= kHGCalSiPMMask0;
id_ |= ((sipm & kHGCalSiPMMask) << kHGCalSiPMOffset);
}

std::vector<HGCScintillatorDetId> HGCScintillatorDetId::detectorCells() const {
std::vector<HGCScintillatorDetId> cells;
int irad = ring();
Expand All @@ -95,21 +20,6 @@ std::vector<HGCScintillatorDetId> HGCScintillatorDetId::detectorCells() const {
return cells;
}

HGCScintillatorDetId HGCScintillatorDetId::geometryCell() const {
if (trigger()) {
return HGCScintillatorDetId(type(), layer(), iradiusTrigger(), iphiTrigger(), false);
} else {
return HGCScintillatorDetId(type(), layer(), iradius(), iphi(), false);
}
}

HGCScintillatorDetId HGCScintillatorDetId::triggerCell() const {
if (trigger())
return HGCScintillatorDetId(type(), layer(), iradius(), iphi(), true);
else
return HGCScintillatorDetId(type(), layer(), iradiusTrigger(), iphiTrigger(), true);
}

std::ostream& operator<<(std::ostream& s, const HGCScintillatorDetId& id) {
return s << " HGCScintillatorDetId::EE:HE= " << id.isEE() << ":" << id.isHE() << " trigger= " << id.trigger()
<< " type= " << id.type() << " SiPM= " << id.sipm() << " layer= " << id.layer() << " ring= " << id.iradius()
Expand Down

0 comments on commit 324fa41

Please sign in to comment.