Helpers for creating calorimeter objects for unit tests. More...

#include <CaloTester.h>

Collaboration diagram for CaloTester:

Public Member Functions
	CaloTester ()
	Constructor.
StatusCode	record_mgr ()
	Record the CaloDetDescrManager in the detector store.
const CaloDetDescriptor *	find_dd (int hashid)
	Return a region descriptor corresponding to a given cell.
const CaloDetDescriptor *	find_dd (const Identifier &cell_id)
	Return a region descriptor corresponding to a given cell.
std::unique_ptr< CaloCell >	make_cell (int hashid)
	Create a calorimeter cell.
std::vector< CaloCell * >	get_cells ()
	Return a vector of all cells.
std::vector< const CaloCell * >	get_const_cells ()
	Return a vector of all cells as const pointers.
std::unique_ptr< CaloCellContainer >	make_ccc ()
	Return a CaloCellContainer for all cells.
CaloDetDescrManager &	mgr ()
	Return the CaloDetDescrManager.
const CaloHelpersTest &	helpers () const
	Return the ID helpers.
const LArEM_ID &	emID () const
	Return the LArEM ID helper.
const LArHEC_ID &	hecID () const
	Return the LArHEC ID helper.
const LArFCAL_ID &	fcalID () const
	Return the LArFCAL ID helper.
const LArMiniFCAL_ID &	minifcalID () const
	Return the LArMiniFCAL ID helper.
const TileID &	tileID () const
	Return the Tile ID helper.
const CaloCell_ID &	caloID () const
	Return the Calorimeter ID helper.

Private Member Functions
void	make_cells ()
	Create all calo cells and save in internal list.

Private Attributes
CaloHelpersTest	m_helpers
	The ID helpers.
std::vector< std::unique_ptr< CaloDetDescrElement > >	m_tileddes
	All Tile detdescr elements.
std::vector< std::unique_ptr< CaloCell > >	m_cells
	The cells made by `make_cells()`.
CaloDetDescrManager *	m_mgr
	The manager object.
std::unique_ptr< CaloDetDescrManager >	m_mgr_up
	Owning pointer to the manager object.

Detailed Description

Helpers for creating calorimeter objects for unit tests.

Helpers to create ID helpers, detector description, and cells for use in unit tests, etc. Builds an idealized geometry.

Warning: DD built here is known to be incorrect for tile/fcal. Some parts of DD are likely to be incomplete for all subcalorimeters. Use with care.

Definition at line 40 of file CaloTester.h.

Constructor & Destructor Documentation

◆ CaloTester()

CaloTester::CaloTester ( )

Constructor.

The constructor will create the ID helpers. A CaloDetDescrManager instance will also be created, but it will not be recorded in the detector store unless record_mgr is called.

Definition at line 28 of file CaloTester.cxx.

  : m_mgr_up (std::make_unique<CaloDetDescrManager>())
{
  // Make a manager instance.
  m_mgr = m_mgr_up.get();
  m_mgr->set_helper (&m_helpers.caloID());
  m_mgr->initialize();
}

Member Function Documentation

◆ caloID()

const CaloCell_ID & CaloTester::caloID ( ) const

inline

Return the Calorimeter ID helper.

Definition at line 136 of file CaloTester.h.

136{ return m_helpers.caloID(); }

◆ emID()

const LArEM_ID & CaloTester::emID ( ) const

inline

Return the LArEM ID helper.

Definition at line 116 of file CaloTester.h.

116{ return m_helpers.emID(); }

◆ fcalID()

const LArFCAL_ID & CaloTester::fcalID ( ) const

inline

Return the LArFCAL ID helper.

Definition at line 124 of file CaloTester.h.

124{ return m_helpers.fcalID(); }

◆ find_dd() [1/2]

const CaloDetDescriptor * CaloTester::find_dd ( const Identifier & cell_id )

Return a region descriptor corresponding to a given cell.

Parameters

reg_id Cell identifier.

The desciptor will be created if needed and registered with the manager.

Definition at line 121 of file CaloTester.cxx.

{
  return find_dd (m_helpers.caloID().calo_cell_hash (cell_id));
}

◆ find_dd() [2/2]

const CaloDetDescriptor * CaloTester::find_dd ( int hashid )

Return a region descriptor corresponding to a given cell.

Parameters

hashid Cell hash id.

The desciptor will be created if needed and registered with the manager.

Definition at line 62 of file CaloTester.cxx.

{
  const CaloCell_Base_ID&     helper = m_helpers.caloID();
  
  Identifier id = helper.cell_id (hashid);
  Identifier reg_id;
  int subcalo = helper.sub_calo (id);
  if (subcalo == CaloCell_ID::TILE) {
    int section = helper.section (id);
    int side = helper.side (id);
    reg_id = helper.region_id (subcalo, section, side, 0);
  }
  else {
    int sampling = helper.sampling (id);
    int posneg = helper.pos_neg (id);
    int region = helper.region (id);
    reg_id = helper.region_id (subcalo, posneg, sampling, region);
  }
 
  const CaloDetDescriptor* dd = m_mgr->get_descriptor (reg_id);
  if (!dd) {
    auto ddp = std::make_unique<CaloDetDescriptor> (reg_id,
                                                    &m_helpers.tileID(),
                                                    &helper);
 
    if (subcalo != CaloCell_ID::TILE) {
      float eta0 = helper.eta0 (reg_id);
      float eta1 = eta0 + (helper.eta_max (reg_id) - helper.eta_min (reg_id)) * helper.etaGranularity (reg_id);
 
      if (ddp->calo_sign() >= 0) {
        ddp->setLArRegMin (eta0);
        ddp->setLArRegMax (eta1);
        ddp->setCaloEtaMin (eta0);
        ddp->setCaloEtaMax (eta1);
      }
      else {
        ddp->setLArRegMin (-eta1);
        ddp->setLArRegMax (-eta0);
        ddp->setCaloEtaMin (-eta1);
        ddp->setCaloEtaMax (-eta0);
      }
 
      ddp->setLArEtaMin (eta0);
      ddp->setLArPhiMin (0);
    }
 
    dd = ddp.get();
    m_mgr->add (std::move (ddp));
  }
  return dd;
}

◆ get_cells()

std::vector< CaloCell * > CaloTester::get_cells ( )

Return a vector of all cells.

The cells remain owned by the Tester object.

Definition at line 187 of file CaloTester.cxx.

{
  if (m_cells.empty()) {
    make_cells();
  }
  std::vector<CaloCell*> cells;
  cells.reserve (m_cells.size());
  for (const std::unique_ptr<CaloCell>& cell : m_cells) {
    cells.push_back (cell.get());
  }
  return cells;
}

◆ get_const_cells()

std::vector< const CaloCell * > CaloTester::get_const_cells ( )

Return a vector of all cells as const pointers.

The cells remain owned by the Tester object.

Definition at line 205 of file CaloTester.cxx.

{
  if (m_cells.empty()) {
    make_cells();
  }
  std::vector<const CaloCell*> cells;
  cells.reserve (m_cells.size());
  for (const std::unique_ptr<CaloCell>& cell : m_cells) {
    cells.push_back (cell.get());
  }
  return cells;
}

◆ hecID()

const LArHEC_ID & CaloTester::hecID ( ) const

inline

Return the LArHEC ID helper.

Definition at line 120 of file CaloTester.h.

120{ return m_helpers.hecID(); }

◆ helpers()

const CaloHelpersTest & CaloTester::helpers ( ) const

inline

Return the ID helpers.

Definition at line 112 of file CaloTester.h.

112{ return m_helpers; }

◆ make_ccc()

std::unique_ptr< CaloCellContainer > CaloTester::make_ccc ( )

Return a CaloCellContainer for all cells.

This will be a view container; the cells remain owned by the Tester object.

Definition at line 224 of file CaloTester.cxx.

{
  if (m_cells.empty()) {
    make_cells();
  }
  auto ccc = std::make_unique<CaloCellContainer> (SG::VIEW_ELEMENTS);
  for (std::unique_ptr<CaloCell>& cell : m_cells) {
    ccc->push_back (cell.get());
  }
  ccc->initializeLookUpTable();
  return ccc;
}

◆ make_cell()

std::unique_ptr< CaloCell > CaloTester::make_cell ( int hashid )

Create a calorimeter cell.

Parameters

hashid Cell hash id.

Definition at line 131 of file CaloTester.cxx.

{
  const CaloDetDescriptor* descr = find_dd (hashid);
  auto ddep = std::make_unique<DummyDetDescrElement> (hashid -
                                                      descr->caloCellMin(),
                                                      0,
                                                      0,
                                                      descr);
  CaloDetDescrElement* dde = ddep.get();
 
  int ieta_min = m_helpers.caloID().eta_min (descr->identify());
  int iphi_min = m_helpers.caloID().phi_min (descr->identify());
  int ieta = m_helpers.caloID().eta (dde->identify());
  int iphi = m_helpers.caloID().phi (dde->identify());
  float r = 0; // FIXME; not filled in
  float phi = descr->calo_phi_min() + (iphi - iphi_min) * descr->dphi();
  float eta;
  if (descr->calo_sign() > 0) {
    eta = descr->calo_eta_min() + (ieta - ieta_min) * descr->deta();
  }
  else {
    eta = descr->calo_eta_max() - (ieta - ieta_min) * descr->deta();
  }
 
  ddep->set_cylindric (eta, phi, r);
  ddep->set_cylindric_size (descr->deta(), descr->dphi(), 0);
 
  // mgr takes ownership of LAr ddes, but not tile...
  m_mgr->add (dde);
  if (m_helpers.caloID().is_tile (hashid)) {
    m_tileddes.push_back (std::move (ddep));
  }
  else {
    ddep.release();
  }
 
  return std::make_unique<CaloCell> (dde, 1, 1, 1, CaloGain::LARHIGHGAIN);
}

◆ make_cells()

void CaloTester::make_cells ( )

private

Create all calo cells and save in internal list.

Definition at line 174 of file CaloTester.cxx.

{
  size_t hashmax = m_helpers.caloID().calo_cell_hash_max();
  m_cells.reserve (hashmax);
  for (size_t i = 0; i < hashmax; i++)
    m_cells.push_back (make_cell (i));
}

◆ mgr()

CaloDetDescrManager & CaloTester::mgr ( )

inline

Return the CaloDetDescrManager.

Definition at line 108 of file CaloTester.h.

108{ return *m_mgr; }

◆ minifcalID()

const LArMiniFCAL_ID & CaloTester::minifcalID ( ) const

inline

Return the LArMiniFCAL ID helper.

Definition at line 128 of file CaloTester.h.

128{ return m_helpers.minifcalID(); }

◆ record_mgr()

StatusCode CaloTester::record_mgr ( )

Record the CaloDetDescrManager in the detector store.

Record the CaloDetDescrManager in the ConditionStore.

This may create the detector store as a side effect.

Definition at line 41 of file CaloTester.cxx.

{
  //Mock ConditonStore-infrastructure 
  Athena_test::DummyRCUSvc rcu;
  EventContext ctx(0, 0);
  DataObjID id1 ("testDetDescr");
  ServiceHandle<StoreGateSvc> condStore ("ConditionStore", "test");
  auto mgr_cc=std::make_unique<CondCont<CaloDetDescrManager> >(rcu, id1);
  CHECK_WITH_CONTEXT(mgr_cc->insert(IOVInfiniteRange::infiniteTime(),std::move(m_mgr_up),ctx),"CaloTester");
  CHECK_WITH_CONTEXT(condStore->record(std::move(mgr_cc),"CaloDetDescrManager"),"CaloTester");
 
  return StatusCode::SUCCESS;
}

◆ tileID()

const TileID & CaloTester::tileID ( ) const

inline

Return the Tile ID helper.

Definition at line 132 of file CaloTester.h.

132{ return m_helpers.tileID(); }

Member Data Documentation

◆ m_cells

std::vector<std::unique_ptr<CaloCell> > CaloTester::m_cells

private

The cells made by make_cells().

Definition at line 153 of file CaloTester.h.

◆ m_helpers

CaloHelpersTest CaloTester::m_helpers

private

The ID helpers.

Definition at line 146 of file CaloTester.h.

◆ m_mgr

CaloDetDescrManager* CaloTester::m_mgr

private

The manager object.

Definition at line 156 of file CaloTester.h.

◆ m_mgr_up

std::unique_ptr<CaloDetDescrManager> CaloTester::m_mgr_up

private

Owning pointer to the manager object.

This is set at the start, and cleared if the object is recorded in SG.

Definition at line 160 of file CaloTester.h.

◆ m_tileddes

std::vector<std::unique_ptr<CaloDetDescrElement> > CaloTester::m_tileddes

private

All Tile detdescr elements.

The manager does not take ownership of these.

Definition at line 150 of file CaloTester.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CaloTester()

Member Function Documentation

◆ caloID()

◆ emID()

◆ fcalID()

◆ find_dd() [1/2]

◆ find_dd() [2/2]

◆ get_cells()

◆ get_const_cells()

◆ hecID()

◆ helpers()

◆ make_ccc()

◆ make_cell()

◆ make_cells()

◆ mgr()

◆ minifcalID()

◆ record_mgr()

◆ tileID()

Member Data Documentation

◆ m_cells

◆ m_helpers

◆ m_mgr

◆ m_mgr_up

◆ m_tileddes