CaloClusterCorr::DDHelper Class Reference

Collaboration diagram for CaloClusterCorr::DDHelper:

Public Member Functions
	DDHelper ()=delete
	delte default Constructor More...
	DDHelper (const CaloDetDescrManager *dd_man)
	Constructor with CaloDetDescManger as parameter. More...
const CaloDetDescrElement *	find_dd_elt (const CaloDetDescrManager *dd_mgr, int region, const xAOD::CaloCluster *cluster, float eta, float phi) const
	Find the detector descriptor element for a given position, correcting for DD edge bugs. More...

Private Member Functions
const CaloDetDescrElement *	dd_inner_strip_fixup (const CaloDetDescrManager *dd_man, int region, float eta, float phi) const
	Work around innermost strip problem. More...
void	make_dummy_elts (const CaloDetDescrManager *dd_man)
	Construct dummy DDEs used to work around innermost strip problem. More...

Static Private Member Functions
static const CaloDetDescrElement *	find_dd_elt1 (const CaloDetDescrManager *dd_mgr, int region, const CaloCluster *cluster, float eta, float phi)
	Find the detector descriptor element for a given position. More...
static const CaloDetDescrElement *	dd_try_gap (const CaloDetDescrManager *dd_man, int region, const CaloCluster *cluster, float eta, float phi)

Private Attributes
std::vector< std::unique_ptr< const CaloDetDescrElement > >	m_dummy_elts
	Collection of dummy elements. More...

Detailed Description

Definition at line 83 of file CaloClusterCorrectionCommon.cxx.

Constructor & Destructor Documentation

DDHelper() [1/2]

CaloClusterCorr::DDHelper::DDHelper ( )

delete

delte default Constructor

DDHelper() [2/2]

CaloClusterCorr::DDHelper::DDHelper

(

const CaloDetDescrManager *

dd_man

)

Constructor with CaloDetDescManger as parameter.

Constructor.

Parameters

dd_man

The detector descriptor manager.

Definition at line 140 of file CaloClusterCorrectionCommon.cxx.

{
  make_dummy_elts(dd_man);
}

Member Function Documentation

dd_inner_strip_fixup()

const CaloDetDescrElement * CaloClusterCorr::DDHelper::dd_inner_strip_fixup ( const CaloDetDescrManager *  dd_man, int  region, float  eta, float  phi  ) const

private

Work around innermost strip problem.

Parameters

region	A region code, as defined in the header.
dd_man	Detector descriptor manager.
eta	The \(\eta\) coordinate to find.
phi	The \(\phi\) coordinate to find.
dummy_elts	Vector of dummy elements for the innermost strip.

The innermost strip in sampling 1 in the barrel is disconnected. However, CaloDetDescr doesn't really know about that. If you ask for a cell in that region, it will instead return you a cell for some completely different calorimeter region! We call this in the case that we're unable to find a good det descr element. Here we check to see if we're actually asking for a location in this innermost strip. If so, then we cons up a new dummy element and return that.

Definition at line 307 of file CaloClusterCorrectionCommon.cxx.

{
  if (region == CaloClusterCorrectionCommon::EMB1 && fabs(eta) < 0.1) {
    const CaloDetDescriptor* descr =
      dd_man->get_descriptor (CaloCell_ID::LAREM,
                                1, true, eta, phi);
    if (!descr) return nullptr;
    int ieta = descr->eta_channel (eta);
    if (ieta == 0) {
      // If we get here, then we're looking at one of the problematic cells.
      int iphi = descr->phi_channel (phi);
      if (iphi < 0) return nullptr;
      unsigned int index = iphi;
      if (eta < 0)
        index += descr->n_phi();
      if (m_dummy_elts.size() <= index)
        return nullptr;
      return m_dummy_elts[index].get();
    }
  }
 
  return nullptr;
}

dd_try_gap()

const CaloDetDescrElement * CaloClusterCorr::DDHelper::dd_try_gap ( const CaloDetDescrManager *  dd_man, int  region, const CaloCluster *  cluster, float  eta, float  phi  )

staticprivate

Definition at line 336 of file CaloClusterCorrectionCommon.cxx.

{
  const CaloDetDescrElement* elt1 = find_dd_elt1 (dd_man,region, cluster,
                                                  eta + 1e-4, phi);
  if (!elt1) return nullptr;
  const CaloDetDescrElement* elt2 = find_dd_elt1 (dd_man,region, cluster,
                                                  eta - 1e-4, phi);
  if (!elt2) return nullptr;
  if (eta > 0)
    return elt2;
  return elt1;
}

find_dd_elt()

const CaloDetDescrElement * CaloClusterCorr::DDHelper::find_dd_elt	(	const CaloDetDescrManager *	dd_mgr,
		int	region,
		const xAOD::CaloCluster *	cluster,
		float	eta,
		float	phi
	)		const

Find the detector descriptor element for a given position, correcting for DD edge bugs.

Parameters

region	A region code, as defined in the header.
cluster	The cluster being corrected.
eta	The \(\eta\) coordinate to find.
phi	The \(\phi\) coordinate to find.

Looks up the DD element containing eta, phi in the region specified by region. Returns 0 if there's no such cell.

Sometimes when you look up a position near the edge of a cell, DD can erroneously return an adjacent cell. This routine attempts to work around this bug. After we get an element, we test to see if it in fact contains the position requested. If not, we shift the request by half a cell and try again.

Definition at line 165 of file CaloClusterCorrectionCommon.cxx.

{
  const CaloDetDescrElement* elt = nullptr;
  float eta_offs = 0;
  float phi_offs = 0;
  int n = 0;
  int good = 0;
  
  while (good != 2) {
    elt = find_dd_elt1 (dd_man,region, cluster,
                        eta + eta_offs, CaloPhiRange::fix (phi + phi_offs));
 
    if (!elt) {
      elt = dd_inner_strip_fixup (dd_man,region, eta, phi);
      if (elt) return elt;
      elt = dd_try_gap (dd_man,region, cluster, eta, phi);
      return elt;
    }
 
    // Don't do this more than twice.
    // Originally, we were aborting if we couldn't find a good element
    // after two passes.  However, it turns out that there are some
    // small gaps between the @f$\eta@f$ ranges of adjacent cells, so if
    // we demanded that the @f$\eta@f$ we provide be within the
    // @f$\eta@f$ range of the element we return, we wouldn't succeed.
    // Downstream code will just have to Deal With It.
    if (++n >= 2)
      return elt;
 
    float deta = elt->deta();
    float dphi = elt->dphi();
 
    good = 0;
 
    if (eta > elt->eta() + deta/2)
      eta_offs += deta/2;
    else if (eta < elt->eta() - deta/2)
      eta_offs -= deta/2;
    else
      ++good;
 
    // Assume that cells don't wrap around the phi boundary...
    if (phi > elt->phi() + dphi/2)
      phi_offs += dphi/2;
    else if (phi < elt->phi() - dphi/2)
      phi_offs -= dphi/2;
    else
      ++good;
 
    if (good != 2 && n == 1) {
      elt = dd_inner_strip_fixup (dd_man,region, eta, phi);
      if (elt) break;
    }
  }
 
  return elt;
}

find_dd_elt1()

const CaloDetDescrElement * CaloClusterCorr::DDHelper::find_dd_elt1 ( const CaloDetDescrManager *  dd_man, int  region, const CaloCluster *  cluster, float  eta, float  phi  )

staticprivate

Find the detector descriptor element for a given position.

Parameters

region	A region code, as defined in the header.
cluster	The cluster being corrected.
eta	The \(\eta\) coordinate to find.
phi	The \(\phi\) coordinate to find.

Looks up the DD element containing eta, phi in the region specified by region. Returns 0 if there's no such cell.

Definition at line 239 of file CaloClusterCorrectionCommon.cxx.

{
  const CaloDetDescrElement* elt = nullptr;
 
  // Decode the region.
  switch (region) {
  case CaloClusterCorrectionCommon::EMB1:
  case CaloClusterCorrectionCommon::EMB2:
  case CaloClusterCorrectionCommon::EME1:
  case CaloClusterCorrectionCommon::EME2:
    // Simple case, it's a specific sampling.
    elt = dd_man->get_element
      (CaloCell_ID::LAREM, sampling (region), barrel_p (region), eta, phi);
    break;
 
  case CaloClusterCorrectionCommon::COMBINED2:
  case CaloClusterCorrectionCommon::CLUSTER:
    // We're combining both the barrel and endcap.
    // Look for elements in both.
    // If we actually get both, make the decision by choosing
    // the one with the most energy in sampling 2.
    {
      const CaloDetDescrElement* elt_b = dd_man->get_element
        (CaloCell_ID::LAREM, 2,  true, eta, phi);
      const CaloDetDescrElement* elt_e = dd_man->get_element
        (CaloCell_ID::LAREM, 2, false, eta, phi);
 
      if (elt_b == nullptr)
        elt = elt_e;
      else if (elt_e == nullptr)
        elt = elt_b;
      else if (cluster->eSample (CaloSampling::EMB2) >
               cluster->eSample (CaloSampling::EME2))
        elt = elt_b;
      else
        elt = elt_e;      
    }
    break;
  default:
    abort();
  }
 
  return elt;
}

make_dummy_elts()

void CaloClusterCorr::DDHelper::make_dummy_elts ( const CaloDetDescrManager *  dd_man )

private

Construct dummy DDEs used to work around innermost strip problem.

Definition at line 357 of file CaloClusterCorrectionCommon.cxx.

{
  const CaloDetDescriptor* descr = dd_man->get_descriptor (CaloCell_ID::LAREM,
                               1, true, 0.05, 0);
  if (descr) {
    int nphi = descr->n_phi();
    m_dummy_elts.resize (nphi*2);
    for (int etasgn = 1; etasgn >= -1; etasgn -= 2) {
      for (int iphi = 0; iphi < nphi; iphi++) {
        // Make a new dummy cell.
        // First, try to find the adjacent strip.  Punt if we can't
        // find _that_!
        const CaloCell_ID* cellid_mgr = dd_man->getCaloCell_ID();
        Identifier cellId2 = cellid_mgr->cell_id (descr->identify(),
                                                  1, iphi);
        IdentifierHash cellIdHash2 = cellid_mgr->calo_cell_hash (cellId2);
        // Verify that we don't have another nonexistent cell!
        if (cellid_mgr->cell_id (cellIdHash2) != cellId2)
          continue;
        const CaloDetDescrElement* elt2 = dd_man->get_element (cellIdHash2);
        if (!elt2) continue;
 
        auto elt = std::make_unique<DummyDetDescrElement>
          (descr->subcalo_hash(),
           0,
           0,
           descr);
 
        // Copy geometry from the adjacent cell, shifting eta.
        elt->set_cylindric_size (elt2->deta(),
                                 elt2->dphi(),
                                 elt2->dr());
        elt->set_cylindric (elt2->eta() - etasgn * elt2->deta(),
                            elt2->phi(),
                            elt2->r());
        elt->set_cylindric_raw (elt2->eta_raw() - etasgn * elt2->deta(),
                                elt2->phi_raw(),
                                elt2->r_raw());
 
        int index = iphi;
        if (etasgn < 0) index += nphi;
        m_dummy_elts[index] = std::move(elt);
      }
    }
  }
}

Member Data Documentation

m_dummy_elts

std::vector<std::unique_ptr<const CaloDetDescrElement> > CaloClusterCorr::DDHelper::m_dummy_elts

private

Collection of dummy elements.

Definition at line 132 of file CaloClusterCorrectionCommon.cxx.

---

The documentation for this class was generated from the following file:

• CaloClusterCorrectionCommon.cxx