This algorithm builds TileCells from TileHits. More...

#include <TileHitToCell.h>

Inheritance diagram for TileHitToCell:

Collaboration diagram for TileHitToCell:

Public Member Functions
	TileHitToCell (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
virtual	~TileHitToCell ()
	Destructor.
virtual StatusCode	initialize () override
	initialize method
virtual StatusCode	execute () override
	execute method
virtual StatusCode	finalize () override
	finalize method
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< TileHitContainer >	m_hitContainerKey
SG::WriteHandleKey< CaloCellContainer >	m_cellContainerKey
SG::ReadCondHandleKey< TileSamplingFraction >	m_samplingFractionKey
	Name of TileSamplingFraction in condition store.
const TileID *	m_tileID {nullptr}
	Pointer to TileID helper.
const TileHWID *	m_tileHWID {nullptr}
	Pointer to TileHWID helper.
const TileDetDescrManager *	m_tileMgr {nullptr}
	Pointer to TileDetDescrManager.
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

This algorithm builds TileCells from TileHits.

Hits from the PMTs in the cell are merged and calibration constants applied to obtained cell energy, time and quality.

TileHitToCell groups some PMT's output (energy deposit) contained in TileHit. (For barrel and ext.barrel, two Hits feed into each cell; for the Gap cells, there is only one PMT.) Calibrations constants are applied, and the total energy in the cell, the mean time of the energy deposition, and the quality of the measurement are returned. Clearly different things are needed for different data, e.g., full simulation vs. fast simulation vs. data. LAr handles this by a strategy of having a top level algorithm that calls builder sub-algs and a list of cell-correction sub-algs. It is not clear to us yet how we (tile) will want to tie to the database nor what level of complexity will exist in Tile for this task, so we will start with the simplest thing, TileCellBuilderAlg, which will do both the converstion of Hit to Cell and correctsions/scaling.

Definition at line 54 of file TileHitToCell.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TileHitToCell()

TileHitToCell::TileHitToCell	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Constructor.

Definition at line 39 of file TileHitToCell.cxx.

  : AthAlgorithm(name, pSvcLocator)
{
}

◆ ~TileHitToCell()

TileHitToCell::~TileHitToCell ( )

virtual

Destructor.

Definition at line 44 of file TileHitToCell.cxx.

44 {

45}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode TileHitToCell::execute ( )

overridevirtual

execute method

Definition at line 73 of file TileHitToCell.cxx.

                                  {
 
  ATH_MSG_DEBUG( "Executing TileHitToCell" );
 
  SG::ReadCondHandle<TileSamplingFraction> samplingFraction(m_samplingFractionKey);
  ATH_CHECK( samplingFraction.isValid() );
 
  // step1: read hits from TES
  SG::ReadHandle<TileHitContainer> hitContainer(m_hitContainerKey);
  ATH_CHECK( hitContainer.isValid() );
 
  //Zero sums for monitoring.
  int nTwo = 0;
  int nChan = 0;
  int nCell = 0;
  double eHitTot = 0.0;
  double eCellTot = 0.0;
 
  // step2: to figure out the cell energy from the hits obtained above
  unsigned int nCellMax = m_tileMgr->tile_cell_size();
  std::vector<double> enePmt1;
  std::vector<double> enePmt2;
  enePmt1.resize(nCellMax);
  enePmt2.resize(nCellMax);
 
  SelectAllObject<TileHitContainer> selAll(hitContainer.cptr());
  SelectAllObject<TileHitContainer>::const_iterator hitItr = selAll.begin();
  SelectAllObject<TileHitContainer>::const_iterator lastHit = selAll.end();
 
  IdentifierHash cellHash_id;
  IdContext cellContext = m_tileID->cell_context();
 
  for (; hitItr != lastHit; ++hitItr) {
 
    // Get hit id (logical pmt id)
    Identifier pmt_id = (*hitItr)->identify();
    int pmt = m_tileID->pmt(pmt_id); // 0 or 1 - first or second PMT of the cell
 
    HWIdentifier pmt_hwid = (*hitItr)->pmt_HWID();
    int ros = m_tileHWID->ros(pmt_hwid);
    int drawer = m_tileHWID->drawer(pmt_hwid);
    int channel = m_tileHWID->channel(pmt_hwid);
    int drawerIdx = TileCalibUtils::getDrawerIdx(ros, drawer);
 
    // Get logical ID of cell
    Identifier cell_id = m_tileID->cell_id(pmt_id);
    m_tileID->get_hash(cell_id, cellHash_id, &cellContext);
 
    // Convert hit energy deposit to cell energy
    double eHit = (*hitItr)->energy();
    double fact = samplingFraction->getSamplingFraction(drawerIdx, channel);
    double eCell = eHit * fact;
 
    ++nChan;
    eHitTot += eHit;
    eCellTot += eCell;
 
    // Add energy to existing entry for this cell, or
    // make new cell entry if there is no previous entry for this cell
    if (0 == pmt) {
      ++nCell;
      enePmt1[cellHash_id] = eCell;
    } else {
      ++nTwo;
      enePmt2[cellHash_id] = eCell;
    }
 
    ATH_MSG_VERBOSE( "TileHitToCell: "
                    << " nChan=" << nChan
                    << " pmt_id=" << m_tileID->to_string(pmt_id, -1)
                    << " eHit=" << eHit
                    << " nCell=" << nCell
                    << " cell_id=" << m_tileID->to_string(cell_id, -2)
                    << " eCell=" << eCell );
  }
 
  // step3: form cells, and put them in container
 
  SG::WriteHandle<CaloCellContainer> cellContainer(m_cellContainerKey);
  ATH_CHECK( cellContainer.record(std::make_unique<CaloCellContainer>()) );
  ATH_MSG_VERBOSE( "TileCell container registered to the TES with name" << m_cellContainerKey.key() );
 
  for (unsigned int i = 0; i < nCellMax; ++i) {
    const CaloDetDescrElement* caloDDE = m_tileMgr->get_cell_element(i);
    TileCell* pCell = new TileCell(caloDDE, enePmt1[i], enePmt2[i], 0.0, 0.0, 0, 0
                                   , TileCell::MASK_AMPL, TileCell::MASK_AMPL
                                   , CaloGain::INVALIDGAIN, CaloGain::INVALIDGAIN); // gain is not known
    cellContainer->push_back(pCell);
  }
 
  // Execution completed.
  if (msgLvl(MSG::DEBUG))  {
    msg(MSG::DEBUG) << "TileHitToCell execution completed." << endmsg;
    msg(MSG::DEBUG) << " nChan=" << nChan
                    << " eHitTot=" << eHitTot
                    << " nCell=" << nCell
                    << " n2=" << nTwo
                    << " eneTot=" << eCellTot << endmsg;
  }
 
 
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode TileHitToCell::finalize ( )

overridevirtual

finalize method

Definition at line 178 of file TileHitToCell.cxx.

                                   {
 
  ATH_MSG_INFO( "TileHitToCell::finalize() end" );
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode TileHitToCell::initialize ( )

overridevirtual

initialize method

Definition at line 50 of file TileHitToCell.cxx.

                                     {
 
  // retrieve Tile detector manager, TileID helper from det store
 
  ATH_CHECK( detStore()->retrieve(m_tileMgr) );
 
  ATH_CHECK( detStore()->retrieve(m_tileID) );
 
  ATH_CHECK( detStore()->retrieve(m_tileHWID) );
 
  ATH_CHECK( m_hitContainerKey.initialize() );
  ATH_CHECK( m_cellContainerKey.initialize() );
 
  ATH_CHECK( m_samplingFractionKey.initialize() );
 
  ATH_MSG_INFO( "TileHitToCell initialisation completed" );
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_cellContainerKey

SG::WriteHandleKey<CaloCellContainer> TileHitToCell::m_cellContainerKey

private

Initial value:

{this,"TileCellContainer",
                                                             "TileCellContainer",
                                                             "Output Tile cell container key"}

Definition at line 70 of file TileHitToCell.h.

                                                          {this,"TileCellContainer",
                                                             "TileCellContainer",
                                                             "Output Tile cell container key"};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_hitContainerKey

SG::ReadHandleKey<TileHitContainer> TileHitToCell::m_hitContainerKey

private

Initial value:

{this,"TileHitContainer","TileHitContainer",

"input Tile hit container key"}

Definition at line 67 of file TileHitToCell.h.

67 {this,"TileHitContainer","TileHitContainer",

68 "input Tile hit container key"};

◆ m_samplingFractionKey

SG::ReadCondHandleKey<TileSamplingFraction> TileHitToCell::m_samplingFractionKey

private

Initial value:

{this,

"TileSamplingFraction", "TileSamplingFraction", "Input Tile sampling fraction"}

Name of TileSamplingFraction in condition store.

Definition at line 77 of file TileHitToCell.h.

77 {this,

78 "TileSamplingFraction", "TileSamplingFraction", "Input Tile sampling fraction"};

◆ m_tileHWID

const TileHWID* TileHitToCell::m_tileHWID {nullptr}

private

Pointer to TileHWID helper.

Definition at line 81 of file TileHitToCell.h.

81{nullptr};

◆ m_tileID

const TileID* TileHitToCell::m_tileID {nullptr}

private

Pointer to TileID helper.

Definition at line 80 of file TileHitToCell.h.

80{nullptr};

◆ m_tileMgr

const TileDetDescrManager* TileHitToCell::m_tileMgr {nullptr}

private

Pointer to TileDetDescrManager.

Definition at line 82 of file TileHitToCell.h.

82{nullptr};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TileHitToCell()

◆ ~TileHitToCell()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cellContainerKey

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_hitContainerKey

◆ m_samplingFractionKey

◆ m_tileHWID

◆ m_tileID

◆ m_tileMgr

◆ m_varHandleArraysDeclared

◆ m_vhka