CaloDetIdAssociator Class Reference

#include <CaloDetIdAssociator.h>

Inheritance diagram for CaloDetIdAssociator:

Public Member Functions
	CaloDetIdAssociator ()
	CaloDetIdAssociator (const int nPhi, const int nEta, const double etaBinSize, CaloGeometry const *geom)
const GeomDet *	getGeomDet (const DetId &id) const override
const char *	name () const override
Public Member Functions inherited from DetIdAssociator
virtual void	buildMap ()
	make the look-up map More...
	DetIdAssociator (const int nPhi, const int nEta, const double etaBinSize)
double	etaBinSize () const
	look-up map bin size in eta dimension More...
virtual std::vector< DetId >	getCrossedDetIds (const std::set< DetId > &, const std::vector< GlobalPoint > &trajectory) const
virtual std::vector< DetId >	getCrossedDetIds (const std::set< DetId > &, const std::vector< SteppingHelixStateInfo > &trajectory, const double toleranceInSigmas=-1) const
virtual std::set< DetId >	getDetIdsCloseToAPoint (const GlobalPoint &, const int iN=0) const
virtual std::set< DetId >	getDetIdsCloseToAPoint (const GlobalPoint &direction, const unsigned int iNEtaPlus, const unsigned int iNEtaMinus, const unsigned int iNPhiPlus, const unsigned int iNPhiMinus) const
virtual std::set< DetId >	getDetIdsCloseToAPoint (const GlobalPoint &direction, const MapRange &mapRange) const
virtual std::set< DetId >	getDetIdsCloseToAPoint (const GlobalPoint &point, const double d=0) const
virtual std::set< DetId >	getDetIdsCloseToAPoint (const GlobalPoint &point, const double dThetaPlus, const double dThetaMinus, const double dPhiPlus, const double dPhiMinus) const
virtual std::set< DetId >	getDetIdsInACone (const std::set< DetId > &, const std::vector< GlobalPoint > &trajectory, const double dR) const
virtual int	iEta (const GlobalPoint &) const
	look-up map eta index More...
virtual int	iPhi (const GlobalPoint &) const
	look-up map phi index More...
int	nEtaBins () const
	number of bins of the look-up map in eta dimension More...
int	nPhiBins () const
	number of bins of the look-up map in phi dimension More...
virtual bool	selectAllInACone (const double dR) const
	helper to see if getDetIdsInACone is useful More...
const FiducialVolume &	volume () const
	get active detector volume More...
virtual	~DetIdAssociator ()

Protected Member Functions
void	check_setup () const override
bool	crossedElement (const GlobalPoint &, const GlobalPoint &, const DetId &id, const double tolerance=-1, const SteppingHelixStateInfo *=nullptr) const override
std::pair< const_iterator, const_iterator >	getDetIdPoints (const DetId &id, std::vector< GlobalPoint > &points) const override
GlobalPoint	getPosition (const DetId &id) const override
void	getValidDetIds (unsigned int subDetectorIndex, std::vector< DetId > &) const override
bool	insideElement (const GlobalPoint &point, const DetId &id) const override
Protected Member Functions inherited from DetIdAssociator
virtual void	dumpMapContent (int, int) const
virtual void	dumpMapContent (int, int, int, int) const
void	fillSet (std::set< DetId > &set, unsigned int iEta, unsigned int iPhi) const
virtual const unsigned int	getNumberOfSubdetectors () const
unsigned int	index (unsigned int iEta, unsigned int iPhi) const
virtual bool	nearElement (const GlobalPoint &point, const DetId &id, const double distance) const

Protected Attributes
std::vector< GlobalPoint >	dummy_
const CaloGeometry *	geometry_
Protected Attributes inherited from DetIdAssociator
std::vector< DetId >	container_
const double	etaBinSize_
std::vector< std::pair< unsigned int, unsigned int > >	lookupMap_
double	maxEta_
double	minTheta_
const int	nEta_
const int	nPhi_
bool	theMapIsValid_
FiducialVolume	volume_

Additional Inherited Members
Public Types inherited from DetIdAssociator
typedef std::vector< GlobalPoint >::const_iterator	const_iterator
enum	PropagationTarget { Barrel, ForwardEndcap, BackwardEndcap }

Detailed Description

Definition at line 27 of file CaloDetIdAssociator.h.

Constructor & Destructor Documentation

CaloDetIdAssociator() [1/2]

CaloDetIdAssociator::CaloDetIdAssociator ( )

inline

Definition at line 29 of file CaloDetIdAssociator.h.

: DetIdAssociator(72, 70, 0.087), geometry_(nullptr){};

CaloDetIdAssociator() [2/2]

CaloDetIdAssociator::CaloDetIdAssociator ( const int  nPhi, const int  nEta, const double  etaBinSize, CaloGeometry const *  geom  )

inline

Definition at line 30 of file CaloDetIdAssociator.h.

      : DetIdAssociator(nPhi, nEta, etaBinSize), geometry_(geom){};

Member Function Documentation

check_setup()

void CaloDetIdAssociator::check_setup ( ) const

overrideprotectedvirtual

Reimplemented from DetIdAssociator.

Definition at line 197 of file CaloDetIdAssociator.cc.

References DetIdAssociator::check_setup(), Exception, and geometry_.

                                            {
  DetIdAssociator::check_setup();
  if (geometry_ == nullptr)
    throw cms::Exception("CaloGeometry is not set");
}

crossedElement()

bool CaloDetIdAssociator::crossedElement ( const GlobalPoint &  point1, const GlobalPoint &  point2, const DetId &  id, const double  tolerance = -1, const SteppingHelixStateInfo *  initialState = nullptr  ) const

overrideprotectedvirtual

Reimplemented from DetIdAssociator.

Definition at line 3 of file CaloDetIdAssociator.cc.

References custom_jme_cff::area, Plane::build(), makePileupJSON::denom, Exception, getDetIdPoints(), SteppingHelixStateInfo::getStateOnSurface(), h, TrajectoryStateOnSurface::hasError(), mps_fire::i, TrajectoryStateOnSurface::isValid(), ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it, dqmiolumiharvest::j, TrajectoryStateOnSurface::localError(), M_PI, mag(), SiStripPI::max, HLT_2023v12_cff::maxPhi, HLT_2023v12_cff::minPhi, AlCaHLTBitMon_ParallelJobs::p, LaserDQM_cfg::p1, SiStripOfflineCRack_cfg::p2, phi, PV3DBase< T, PVType, FrameType >::phi(), hiPixelPairStep_cff::points, LocalTrajectoryError::positionError(), funct::pow(), dttmaxenums::r32, LocalError::rotate(), idealTransformation::rotation, LocalError::scale(), mathSSE::sqrt(), edm::swap(), unit(), trackerHitRTTI::vector, PV3DBase< T, PVType, FrameType >::x(), multiplicitycorr_cfi::xMax, photonAnalyzer_cfi::xMin, geometryCSVtoXML::xx, LocalError::xx(), geometryCSVtoXML::xy, LocalError::xy(), PV3DBase< T, PVType, FrameType >::y(), multiplicitycorr_cfi::yMax, photonAnalyzer_cfi::yMin, geometryCSVtoXML::yy, LocalError::yy(), PV3DBase< T, PVType, FrameType >::z(), photonAnalyzer_cfi::zMax, and photonAnalyzer_cfi::zMin.

                                                                                           {
  std::vector<GlobalPoint> pointBuffer;
  const std::pair<const_iterator, const_iterator>& points = getDetIdPoints(id, pointBuffer);
  // fast check
  bool xLess(false), xIn(false), xMore(false);
  bool yLess(false), yIn(false), yMore(false);
  bool zLess(false), zIn(false), zMore(false);
  double xMin(point1.x()), xMax(point2.x());
  double yMin(point1.y()), yMax(point2.y());
  double zMin(point1.z()), zMax(point2.z());
  if (xMin > xMax)
    std::swap(xMin, xMax);
  if (yMin > yMax)
    std::swap(yMin, yMax);
  if (zMin > zMax)
    std::swap(zMin, zMax);
  for (std::vector<GlobalPoint>::const_iterator it = points.first; it != points.second; ++it) {
    if (it->x() < xMin) {
      xLess = true;
    } else {
      if (it->x() > xMax)
        xMore = true;
      else
        xIn = true;
    }
    if (it->y() < yMin) {
      yLess = true;
    } else {
      if (it->y() > yMax)
        yMore = true;
      else
        yIn = true;
    }
    if (it->z() < zMin) {
      zLess = true;
    } else {
      if (it->z() > zMax)
        zMore = true;
      else
        zIn = true;
    }
  }
  if (((xLess && !xIn && !xMore) || (!xLess && !xIn && xMore)) ||
      ((yLess && !yIn && !yMore) || (!yLess && !yIn && yMore)) ||
      ((zLess && !zIn && !zMore) || (!zLess && !zIn && zMore)))
    return false;

  // Define plane normal to the trajectory direction at the first point
  GlobalVector vector = (point2 - point1).unit();
  float r21 = 0;
  float r22 = vector.z() / sqrt(1 - pow(vector.x(), 2));
  float r23 = -vector.y() / sqrt(1 - pow(vector.x(), 2));
  float r31 = vector.x();
  float r32 = vector.y();
  float r33 = vector.z();
  float r11 = r22 * r33 - r23 * r32;
  float r12 = r23 * r31;
  float r13 = -r22 * r31;

  Surface::RotationType rotation(r11, r12, r13, r21, r22, r23, r31, r32, r33);
  Plane::PlanePointer plane = Plane::build(point1, rotation);
  double absoluteTolerance = -1;
  if (toleranceInSigmas > 0 && initialState) {
    TrajectoryStateOnSurface tsos = initialState->getStateOnSurface(*plane);
    if (tsos.isValid() and tsos.hasError()) {
      LocalError localErr = tsos.localError().positionError();
      localErr.scale(toleranceInSigmas);
      float xx = localErr.xx();
      float xy = localErr.xy();
      float yy = localErr.yy();

      float denom = yy - xx;
      float phi = 0.;
      if (xy == 0 && denom == 0)
        phi = M_PI_4;
      else
        phi = 0.5 * atan2(2. * xy, denom);  // angle of MAJOR axis
      // Unrotate the error ellipse to get the semimajor and minor axes. Then place points on
      // the endpoints of semiminor an seminajor axes on original(rotated) error ellipse.
      LocalError rotErr = localErr.rotate(-phi);  // xy covariance of rotErr should be zero
      float semi1 = sqrt(rotErr.xx());
      float semi2 = sqrt(rotErr.yy());
      absoluteTolerance = std::max(semi1, semi2);
    }
  }

  // distance between the points.
  double trajectorySegmentLength = (point2 - point1).mag();

  // we need to find the angle that covers all points.
  // if it's bigger than 180 degree, we are inside
  // otherwise we are outside, i.e. the volume is not crossed
  bool allBehind = true;
  bool allTooFar = true;
  std::vector<GlobalPoint>::const_iterator p = points.first;
  if (p == points.second) {
    edm::LogWarning("TrackAssociator") << "calo geometry for element " << id.rawId() << "is empty. Ignored";
    return false;
  }
  LocalPoint localPoint = plane->toLocal(*p);
  double minPhi = localPoint.phi();
  double maxPhi = localPoint.phi();
  if (localPoint.z() < 0)
    allTooFar = false;
  else {
    allBehind = false;
    if (localPoint.z() < trajectorySegmentLength)
      allTooFar = false;
  }
  ++p;
  for (; p != points.second; ++p) {
    localPoint = plane->toLocal(*p);
    double localPhi = localPoint.phi();
    if (localPoint.z() < 0)
      allTooFar = false;
    else {
      allBehind = false;
      if (localPoint.z() < trajectorySegmentLength)
        allTooFar = false;
    }
    if (localPhi >= minPhi && localPhi <= maxPhi)
      continue;
    if (localPhi + 2 * M_PI >= minPhi && localPhi + 2 * M_PI <= maxPhi)
      continue;
    if (localPhi - 2 * M_PI >= minPhi && localPhi - 2 * M_PI <= maxPhi)
      continue;
    // find the closest limit
    if (localPhi > maxPhi) {
      double delta1 = fabs(localPhi - maxPhi);
      double delta2 = fabs(localPhi - 2 * M_PI - minPhi);
      if (delta1 < delta2)
        maxPhi = localPhi;
      else
        minPhi = localPhi - 2 * M_PI;
      continue;
    }
    if (localPhi < minPhi) {
      double delta1 = fabs(localPhi - minPhi);
      double delta2 = fabs(localPhi + 2 * M_PI - maxPhi);
      if (delta1 < delta2)
        minPhi = localPhi;
      else
        maxPhi = localPhi + 2 * M_PI;
      continue;
    }
    cms::Exception("FatalError")
        << "Algorithm logic error - this should never happen. Problems with trajectory-volume matching.";
  }
  if (allBehind)
    return false;
  if (allTooFar)
    return false;
  if (fabs(maxPhi - minPhi) > M_PI)
    return true;

  // now if the tolerance is positive, check how far we are
  // from the closest line segment
  if (absoluteTolerance < 0)
    return false;
  double distanceToClosestLineSegment = 1e9;
  std::vector<GlobalPoint>::const_iterator i, j;
  for (i = points.first; i != points.second; ++i)
    for (j = i + 1; j != points.second; ++j) {
      LocalPoint p1(plane->toLocal(*i));
      LocalPoint p2(plane->toLocal(*j));
      // now we deal with high school level math to get
      // the triangle paramaters
      double side1squared = p1.perp2();
      double side2squared = p2.perp2();
      double side3squared = (p2.x() - p1.x()) * (p2.x() - p1.x()) + (p2.y() - p1.y()) * (p2.y() - p1.y());
      double area = fabs(p1.x() * p2.y() - p2.x() * p1.y()) / 2;
      // all triangle angles must be smaller than 90 degree
      // otherwise the projection is out of the line segment
      if (side1squared + side2squared > side3squared && side2squared + side3squared > side1squared &&
          side1squared + side3squared > side1squared) {
        double h(2 * area / sqrt(side3squared));
        if (h < distanceToClosestLineSegment)
          distanceToClosestLineSegment = h;
      } else {
        if (sqrt(side1squared) < distanceToClosestLineSegment)
          distanceToClosestLineSegment = sqrt(side1squared);
        if (sqrt(side2squared) < distanceToClosestLineSegment)
          distanceToClosestLineSegment = sqrt(side2squared);
      }
    }
  if (distanceToClosestLineSegment < absoluteTolerance)
    return true;
  return false;
}

getDetIdPoints()

std::pair< DetIdAssociator::const_iterator, DetIdAssociator::const_iterator > CaloDetIdAssociator::getDetIdPoints ( const DetId &  id, std::vector< GlobalPoint > &  points  ) const

overrideprotectedvirtual

Implements DetIdAssociator.

Definition at line 214 of file CaloDetIdAssociator.cc.

References dummy_, geometry_, CaloGeometry::getSubdetectorGeometry(), LogDebug, and GeomDetEnumerators::subDetGeom.

Referenced by crossedElement().

                                                           {
  const CaloSubdetectorGeometry* subDetGeom = geometry_->getSubdetectorGeometry(id);
  if (!subDetGeom) {
    LogDebug("TrackAssociator") << "Cannot find sub-detector geometry for " << id.rawId() << "\n";
    return std::pair<const_iterator, const_iterator>(dummy_.end(), dummy_.end());
  }
  auto cellGeom = subDetGeom->getGeometry(id);
  if (!cellGeom) {
    LogDebug("TrackAssociator") << "Cannot find CaloCell geometry for " << id.rawId() << "\n";
    return std::pair<const_iterator, const_iterator>(dummy_.end(), dummy_.end());
  }
  const CaloCellGeometry::CornersVec& cor(cellGeom->getCorners());
  return std::pair<const_iterator, const_iterator>(cor.begin(), cor.end());
}

getGeomDet()

const GeomDet* CaloDetIdAssociator::getGeomDet ( const DetId &  id ) const

inlineoverridevirtual

Implements DetIdAssociator.

Definition at line 33 of file CaloDetIdAssociator.h.

{ return nullptr; };

getPosition()

GlobalPoint CaloDetIdAssociator::getPosition ( const DetId &  id ) const

overrideprotectedvirtual

Implements DetIdAssociator.

Definition at line 203 of file CaloDetIdAssociator.cc.

References geometry_, CaloSubdetectorGeometry::getGeometry(), and CaloGeometry::getSubdetectorGeometry().

                                                                  {
  return geometry_->getSubdetectorGeometry(id)->getGeometry(id)->getPosition();
}

getValidDetIds()

void CaloDetIdAssociator::getValidDetIds ( unsigned int  subDetectorIndex, std::vector< DetId > &  detIds  ) const

overrideprotectedvirtual

Implements DetIdAssociator.

Reimplemented in HcalDetIdAssociator, EcalDetIdAssociator, HODetIdAssociator, and PreshowerDetIdAssociator.

Definition at line 207 of file CaloDetIdAssociator.cc.

References DetId::Calo, Exception, geometry_, and CaloGeometry::getValidDetIds().

                                                                                                    {
  if (subDectorIndex != 0)
    cms::Exception("FatalError")
        << "Calo sub-dectors are all handle as one sub-system, but subDetectorIndex is not zero.\n";
  detIds = geometry_->getValidDetIds(DetId::Calo, 1);
}

insideElement()

bool CaloDetIdAssociator::insideElement ( const GlobalPoint &  point, const DetId &  id  ) const

inlineoverrideprotectedvirtual

Implements DetIdAssociator.

Definition at line 47 of file CaloDetIdAssociator.h.

References geometry_, CaloSubdetectorGeometry::getGeometry(), CaloGeometry::getSubdetectorGeometry(), and point.

                                                                               {
    return geometry_->getSubdetectorGeometry(id)->getGeometry(id)->inside(point);
  };

name()

const char* CaloDetIdAssociator::name ( void  ) const

inlineoverridevirtual

Implements DetIdAssociator.

Reimplemented in HcalDetIdAssociator, EcalDetIdAssociator, HODetIdAssociator, and PreshowerDetIdAssociator.

Definition at line 35 of file CaloDetIdAssociator.h.

Referenced by config.CFG::__str__(), and validation.Sample::digest().

{ return "CaloTowers"; }

Member Data Documentation

dummy_

std::vector<GlobalPoint> CaloDetIdAssociator::dummy_

protected

Definition at line 57 of file CaloDetIdAssociator.h.

Referenced by getDetIdPoints().

geometry_

const CaloGeometry* CaloDetIdAssociator::geometry_

protected

Definition at line 56 of file CaloDetIdAssociator.h.

Referenced by check_setup(), getDetIdPoints(), getPosition(), HODetIdAssociator::getValidDetIds(), PreshowerDetIdAssociator::getValidDetIds(), EcalDetIdAssociator::getValidDetIds(), HcalDetIdAssociator::getValidDetIds(), getValidDetIds(), and insideElement().