Decorate clusters with dead-material truth-energy contributions. More...

#include <CaloCalibClusterDecoratorToolDM.h>

Inheritance diagram for CaloCalibClusterDecoratorToolDM:

Collaboration diagram for CaloCalibClusterDecoratorToolDM:

Public Types
using	CalibHitIPhiIEtaRange
using	CellInfoSet_t = CaloCalibClusterMomentsMaker2::CellInfoSet_t
using	ClusInfo_t = CaloCalibClusterMomentsMaker2::ClusInfo_t
using	ClusList = CaloCalibClusterMomentsMaker2::ClusList

Public Member Functions
	CaloCalibClusterDecoratorToolDM (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *theClusColl) const override
	Execute on an entire collection of clusters.
virtual StatusCode	initialize () override
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
	DeclareInterfaceID (CaloClusterCollectionProcessor, 1, 0)

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
enum	keys_dm_energy_sharing { kMatchDmOff , kMatchDmLoose , kMatchDmMedium , kMatchDmTight }
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
template<class AddDeadMaterialEnergy>
void	accumulateDeadMaterialEnergy (const std::vector< const CaloCalibrationHitContainer * > &v_dmcchc, const xAOD::CaloClusterContainer &theClusColl, const ClusInfo_t &clusInfoVec, const ClusList &clusList, bool useParticleID, AddDeadMaterialEnergy &&addDeadMaterialEnergy) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::WriteDecorHandleKey< xAOD::CaloClusterContainer >	m_caloClusterWriteDecorHandleKeyNLeadingTruthParticlesDM
Gaudi::Property< unsigned int >	m_numTruthParticles
SG::ReadHandleKeyArray< CaloCalibrationHitContainer >	m_CalibrationHitContainerNames
SG::ReadHandleKeyArray< CaloCalibrationHitContainer >	m_DMCalibrationHitContainerNames
const CaloCell_ID *	m_calo_id {nullptr}
const CaloDmDescrManager *	m_caloDmDescrManager {nullptr}
int	m_n_phi_out {127}
int	m_n_eta_out {127}
double	m_out_phi_max {M_PI}
double	m_out_eta_max {6.0}
double	m_rmaxOut [3] {1.0, 0.5, 0.3}
std::array< std::vector< std::vector< CalibHitIPhiIEtaRange > >, 3 >	m_i_phi_eta
Gaudi::Property< int >	m_MatchDmType
Gaudi::Property< bool >	m_useParticleID
Gaudi::Property< float >	m_energyMin
Gaudi::Property< float >	m_energyMinCalib
Gaudi::Property< float >	m_apars_alpha
Gaudi::Property< float >	m_apars_r0
std::atomic< bool >	m_foundAllContainers {false}
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

Decorate clusters with dead-material truth-energy contributions.

The tool mirrors the ENG_CALIB_DEAD_TOT dead-material sharing logic from CaloCalibClusterMomentsMaker2, but keeps the assigned energy separated by truth-particle uniqueID/barcode. The final decoration is therefore a sorted vector of (truth ID, dead-material calibration-hit energy) pairs per cluster.

Definition at line 36 of file CaloCalibClusterDecoratorToolDM.h.

Member Typedef Documentation

◆ CalibHitIPhiIEtaRange

using CaloCalibClusterDecoratorToolDM::CalibHitIPhiIEtaRange

Initial value:

CaloCalibClusterMomentsMaker2::CalibHitIPhiIEtaRange

Definition CaloCalibClusterMomentsMaker2.h:46

Definition at line 41 of file CaloCalibClusterDecoratorToolDM.h.

◆ CellInfoSet_t

using CaloCalibClusterDecoratorToolDM::CellInfoSet_t = CaloCalibClusterMomentsMaker2::CellInfoSet_t

Definition at line 43 of file CaloCalibClusterDecoratorToolDM.h.

◆ ClusInfo_t

using CaloCalibClusterDecoratorToolDM::ClusInfo_t = CaloCalibClusterMomentsMaker2::ClusInfo_t

Definition at line 44 of file CaloCalibClusterDecoratorToolDM.h.

◆ ClusList

using CaloCalibClusterDecoratorToolDM::ClusList = CaloCalibClusterMomentsMaker2::ClusList

Definition at line 45 of file CaloCalibClusterDecoratorToolDM.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ keys_dm_energy_sharing

enum CaloCalibClusterDecoratorToolDM::keys_dm_energy_sharing

private

Enumerator
kMatchDmOff
kMatchDmLoose
kMatchDmMedium
kMatchDmTight

Definition at line 57 of file CaloCalibClusterDecoratorToolDM.h.

57{kMatchDmOff, kMatchDmLoose, kMatchDmMedium, kMatchDmTight};

CaloCalibClusterDecoratorToolDM::kMatchDmLoose

@ kMatchDmLoose

Definition CaloCalibClusterDecoratorToolDM.h:57

CaloCalibClusterDecoratorToolDM::kMatchDmOff

@ kMatchDmOff

Definition CaloCalibClusterDecoratorToolDM.h:57

CaloCalibClusterDecoratorToolDM::kMatchDmTight

@ kMatchDmTight

Definition CaloCalibClusterDecoratorToolDM.h:57

CaloCalibClusterDecoratorToolDM::kMatchDmMedium

@ kMatchDmMedium

Definition CaloCalibClusterDecoratorToolDM.h:57

Constructor & Destructor Documentation

◆ CaloCalibClusterDecoratorToolDM()

CaloCalibClusterDecoratorToolDM::CaloCalibClusterDecoratorToolDM	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 41 of file CaloCalibClusterDecoratorToolDM.cxx.

  : AthAlgTool(type, name, parent)
{
  declareInterface<CaloClusterCollectionProcessor>(this);
 
  for (int im = 0; im < 3; ++im) {
    m_i_phi_eta[im].resize(m_n_eta_out);
  }
}

Member Function Documentation

◆ accumulateDeadMaterialEnergy()

template<class AddDeadMaterialEnergy>

void CaloCalibClusterDecoratorToolDM::accumulateDeadMaterialEnergy	(	const std::vector< const CaloCalibrationHitContainer * > &	v_dmcchc,
		const xAOD::CaloClusterContainer &	theClusColl,
		const ClusInfo_t &	clusInfoVec,
		const ClusList &	clusList,
		bool	useParticleID,
		AddDeadMaterialEnergy &&	addDeadMaterialEnergy ) const

inlineprivate

Definition at line 131 of file CaloCalibClusterDecoratorToolDM.h.

  {
    for (const CaloCalibrationHitContainer* dmcchc : v_dmcchc) {
      for (const CaloCalibrationHit* hit : *dmcchc) {
        const Identifier myId = hit->cellID();
        if (!m_calo_id->is_lar_dm(myId) && !m_calo_id->is_tile_dm(myId)) {
          continue;
        }
 
        const CaloDmDescrElement* myCDDE = m_caloDmDescrManager->get_element(myId);
        if (!myCDDE) {
          continue;
        }
 
        int uniqueID = HepMC::UNDEFINED_ID;
        if (useParticleID) {
          uniqueID = HepMC::uniqueID(hit);
        }
 
        const int jeO = static_cast<int>(std::floor(m_n_eta_out * (myCDDE->eta() / m_out_eta_max)));
        if (jeO < -m_n_eta_out || jeO >= m_n_eta_out) {
          continue;
        }
 
        int jpO = static_cast<int>(std::floor(m_n_phi_out * (myCDDE->phi() / m_out_phi_max)));
        if (jpO < -m_n_phi_out) {
          jpO += 2 * m_n_phi_out;
        }
        if (jpO >= m_n_phi_out) {
          jpO -= 2 * m_n_phi_out;
        }
 
        const int nDmArea = m_caloDmDescrManager->get_dm_area(myId);
        const CaloDmRegion* dmRegion = m_caloDmDescrManager->get_dm_region(myId);
        if (!dmRegion) {
          continue;
        }
 
        std::vector<int> hitClusIndex;
        std::vector<double> hitClusEffEnergy;
        hitClusIndex.reserve(theClusColl.size());
        hitClusEffEnergy.reserve(theClusColl.size());
        double hitClusNorm = 0.0;
 
        const std::vector<int>& matchingClusters =
            clusList[(jpO + m_n_phi_out) * (2 * m_n_eta_out + 1) + jeO + m_n_eta_out];
 
        for (int iClus : matchingClusters) {
          const xAOD::CaloCluster* theCluster = theClusColl.at(iClus);
          const auto& clusInfo = clusInfoVec[iClus];
          auto pos = clusInfo.engCalibParticle.find(uniqueID);
          if (pos == clusInfo.engCalibParticle.end()) {
            continue;
          }
 
          const double engClusTruthUniqueIDCalib = pos->second.engTot;
          if (engClusTruthUniqueIDCalib <= m_energyMinCalib || theCluster->e() <= m_energyMin) {
            continue;
          }
 
          double sum_smp_energy = 0.0;
          for (unsigned int i_smp = 0; i_smp < dmRegion->m_CaloSampleNeighbours.size(); ++i_smp) {
            const CaloSampling::CaloSample nsmp =
                static_cast<CaloSampling::CaloSample>(dmRegion->m_CaloSampleNeighbours[i_smp]);
            if ((dmRegion->m_CaloSampleEtaMin[i_smp] - 0.5) <= theCluster->eta() &&
                theCluster->eta() <= (dmRegion->m_CaloSampleEtaMax[i_smp] + 0.5)) {
              sum_smp_energy += pos->second.engSmp[nsmp];
            }
          }
          if (sum_smp_energy <= 0.0) {
            continue;
          }
 
          double phi_diff = myCDDE->phi() - theCluster->phi();
          if (phi_diff <= -M_PI) {
            phi_diff += 2. * M_PI;
          }
          else if (phi_diff > M_PI) {
            phi_diff -= 2. * M_PI;
          }
          const double eta_diff = myCDDE->eta() - theCluster->eta();
          const float distance = std::sqrt(eta_diff * eta_diff + phi_diff * phi_diff);
          const double effEner = std::pow(sum_smp_energy, m_apars_alpha.value()) * std::exp(-distance / m_apars_r0.value());
 
          hitClusIndex.push_back(iClus);
          hitClusEffEnergy.push_back(effEner);
          hitClusNorm += effEner;
        }
 
        if (hitClusNorm <= 0.0) {
          continue;
        }
 
        const double inv_hitClusNorm = 1.0 / hitClusNorm;
        for (std::size_t i = 0; i < hitClusIndex.size(); ++i) {
          const int iClus = hitClusIndex[i];
          const double dm_weight = hitClusEffEnergy[i] * inv_hitClusNorm;
          addDeadMaterialEnergy(iClus, uniqueID, nDmArea, hit->energyTotal() * dm_weight);
        }
      }
    }
  }

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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());
 
  }

◆ DeclareInterfaceID()

CaloClusterCollectionProcessor::DeclareInterfaceID	(	CaloClusterCollectionProcessor	,
		1	,
		0	)

inherited

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode CaloCalibClusterDecoratorToolDM::execute	(	const EventContext &	ctx,
		xAOD::CaloClusterContainer *	collection ) const

overridevirtual

Execute on an entire collection of clusters.

Parameters

collection The container of clusters. param ctx The event context.

Implements CaloClusterCollectionProcessor.

Definition at line 74 of file CaloCalibClusterDecoratorToolDM.cxx.

{
  SG::WriteDecorHandle<xAOD::CaloClusterContainer,
                       std::vector<std::pair<unsigned int, double> > >
    caloClusterWriteDecorHandleNLeadingTruthParticlesDM(
        m_caloClusterWriteDecorHandleKeyNLeadingTruthParticlesDM, ctx);
 
  bool foundAllContainers(true);
  std::vector<const CaloCalibrationHitContainer*> v_cchc;
  std::vector<const CaloCalibrationHitContainer*> v_dmcchc;
 
  for (const SG::ReadHandleKey<CaloCalibrationHitContainer>& key :
       m_CalibrationHitContainerNames) {
    SG::ReadHandle<CaloCalibrationHitContainer> cchc(key, ctx);
    if (!cchc.isValid()) {
      if (m_foundAllContainers) {
        ATH_MSG_ERROR("SG does not contain calibration hit container " << key.key());
      }
      foundAllContainers = false;
    }
    else {
      v_cchc.push_back(cchc.cptr());
    }
  }
 
  for (const SG::ReadHandleKey<CaloCalibrationHitContainer>& key :
       m_DMCalibrationHitContainerNames) {
    SG::ReadHandle<CaloCalibrationHitContainer> dmcchc(key, ctx);
    if (!dmcchc.isValid()) {
      if (m_foundAllContainers) {
        ATH_MSG_ERROR("SG does not contain DM calibration hit container " << key.key());
      }
      foundAllContainers = false;
    }
    else {
      v_dmcchc.push_back(dmcchc.cptr());
    }
  }
 
  if (!m_foundAllContainers && foundAllContainers) {
    m_foundAllContainers = true;
  }
 
  if (!foundAllContainers) {
    return StatusCode::SUCCESS;
  }
 
  ClusInfo_t clusInfoVec(theClusColl->size());
 
  CellInfoSet_t cellInfo;
  CaloCalibClusterMomentsMaker2::buildCellInfoMap(*theClusColl, cellInfo);
 
  unsigned int nHitsTotal = 0;
  unsigned int nHitsWithoutParticleUID = 0;
  CaloCalibClusterMomentsMaker2::accumulateClusterCalibHits(
      v_cchc,
      cellInfo,
      *m_calo_id,
      clusInfoVec,
      nHitsTotal,
      nHitsWithoutParticleUID,
      m_useParticleID,
      [this]() {
        ATH_MSG_ERROR("Invalid uniqueID detected - this sample cannot be properly analysed.");
      });
 
  bool useParticleID = m_useParticleID;
  if (m_useParticleID && (nHitsTotal == nHitsWithoutParticleUID)) {
    ATH_MSG_INFO("Calibration hits do not have ParticleUID, ids of particle-caused hits are always 0. Continuing without ParticleID machinery.");
    useParticleID = false;
  }
 
  std::array<ClusList, 3> clusLists;
  const std::array<bool, 3> doClusterLists{{
      m_MatchDmType == kMatchDmLoose,
      m_MatchDmType == kMatchDmMedium,
      m_MatchDmType == kMatchDmTight}};
 
  for (unsigned int ii = 0; ii < 3; ++ii) {
    if (doClusterLists[ii]) {
      clusLists[ii].resize((2 * m_n_phi_out + 1) * (2 * m_n_eta_out + 1));
    }
  }
 
  std::array<ClusList*, 3> clusListPtrs{{&clusLists[0], &clusLists[1], &clusLists[2]}};
  CaloCalibClusterMomentsMaker2::buildOutOfClusterClusterLists(
      *theClusColl,
      clusInfoVec,
      m_n_phi_out,
      m_n_eta_out,
      m_out_phi_max,
      m_out_eta_max,
      m_i_phi_eta,
      doClusterLists,
      clusListPtrs);
 
  const ClusList* pClusList = nullptr;
  if (m_MatchDmType == kMatchDmLoose) {
    pClusList = &clusLists[0];
  }
  else if (m_MatchDmType == kMatchDmMedium) {
    pClusList = &clusLists[1];
  }
  else if (m_MatchDmType == kMatchDmTight) {
    pClusList = &clusLists[2];
  }
 
  std::vector<std::unordered_map<unsigned int, double> > engCalibDeadByTruth(theClusColl->size());
 
  if (pClusList != nullptr) {
    accumulateDeadMaterialEnergy(
        v_dmcchc,
        *theClusColl,
        clusInfoVec,
        *pClusList,
        useParticleID,
        [&engCalibDeadByTruth](int iClus, unsigned int uniqueID, int /*nDmArea*/, double energy) {
          engCalibDeadByTruth[iClus][uniqueID] += energy;
        });
  }
 
  // Match ENG_CALIB_DEAD_TOT semantics: add the in-cluster dead-like samplings
  // that MomentsMaker2 adds on top of the assigned DMA_ALL dead-material energy.
  for (std::size_t iClus = 0; iClus < clusInfoVec.size(); ++iClus) {
    const auto& particleMap = clusInfoVec[iClus].engCalibParticle;
    for (const auto& [uniqueID, calibEnergy] : particleMap) {
      const double inClusterDeadEnergy =
          calibEnergy.engSmp[CaloSampling::PreSamplerB]
        + calibEnergy.engSmp[CaloSampling::PreSamplerE]
        + calibEnergy.engSmp[CaloSampling::TileGap3];
      if (inClusterDeadEnergy != 0.0) {
        engCalibDeadByTruth[iClus][uniqueID] += inClusterDeadEnergy;
      }
    }
  }
 
  int clusIdx = -1;
  for (const xAOD::CaloCluster* thisCaloCluster : *theClusColl) {
    ++clusIdx;
    const std::unordered_map<unsigned int, double>& truthMap = engCalibDeadByTruth[clusIdx];
    if (!truthMap.empty()) {
      caloClusterWriteDecorHandleNLeadingTruthParticlesDM(*thisCaloCluster) =
          makeSortedTruthPairs(truthMap, m_numTruthParticles);
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ initialize()

StatusCode CaloCalibClusterDecoratorToolDM::initialize ( )

overridevirtual

Definition at line 54 of file CaloCalibClusterDecoratorToolDM.cxx.

{
  ATH_CHECK(m_caloClusterWriteDecorHandleKeyNLeadingTruthParticlesDM.initialize());
  ATH_CHECK(detStore()->retrieve(m_calo_id, "CaloCell_ID"));
  m_caloDmDescrManager = CaloDmDescrManager::instance();
 
  CaloCalibClusterMomentsMaker2::initializeOutOfClusterDistanceTables(
      m_n_phi_out,
      m_n_eta_out,
      m_out_phi_max,
      m_out_eta_max,
      m_rmaxOut,
      m_i_phi_eta);
 
  ATH_CHECK(m_CalibrationHitContainerNames.initialize());
  ATH_CHECK(m_DMCalibrationHitContainerNames.initialize());
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_apars_alpha

Gaudi::Property<float> CaloCalibClusterDecoratorToolDM::m_apars_alpha

private

Initial value:

{
      this,
      "AparsAlpha",
      0.5,
      "Power-law exponent for dead-material sharing effective energy"}

Definition at line 118 of file CaloCalibClusterDecoratorToolDM.h.

                                    {
      this,
      "AparsAlpha",
      0.5,
      "Power-law exponent for dead-material sharing effective energy"};

◆ m_apars_r0

Gaudi::Property<float> CaloCalibClusterDecoratorToolDM::m_apars_r0

private

Initial value:

{
      this,
      "AparsR0",
      0.2,
      "Distance scale for dead-material sharing effective energy"}

Definition at line 124 of file CaloCalibClusterDecoratorToolDM.h.

                                 {
      this,
      "AparsR0",
      0.2,
      "Distance scale for dead-material sharing effective energy"};

◆ m_CalibrationHitContainerNames

SG::ReadHandleKeyArray<CaloCalibrationHitContainer> CaloCalibClusterDecoratorToolDM::m_CalibrationHitContainerNames

private

Initial value:

{
      this,
      "CalibrationHitContainerNames",
      {},
      "Calibration-hit containers inside the calorimeter volume"}

Definition at line 72 of file CaloCalibClusterDecoratorToolDM.h.

                                                                                  {
      this,
      "CalibrationHitContainerNames",
      {},
      "Calibration-hit containers inside the calorimeter volume"};

◆ m_calo_id

const CaloCell_ID* CaloCalibClusterDecoratorToolDM::m_calo_id {nullptr}

private

Definition at line 84 of file CaloCalibClusterDecoratorToolDM.h.

84{nullptr};

◆ m_caloClusterWriteDecorHandleKeyNLeadingTruthParticlesDM

SG::WriteDecorHandleKey<xAOD::CaloClusterContainer> CaloCalibClusterDecoratorToolDM::m_caloClusterWriteDecorHandleKeyNLeadingTruthParticlesDM

private

Initial value:

{
      this,
      "CaloClusterWriteDecorHandleKey_NLeadingTruthParticlesDM",
      "CaloTopoClustersNew.calclus_NLeadingTruthParticleBarcodeEnergyPairs_DM",
      "Dead-material truth-particle barcode/energy decoration"}

Definition at line 60 of file CaloCalibClusterDecoratorToolDM.h.

                                                            {
      this,
      "CaloClusterWriteDecorHandleKey_NLeadingTruthParticlesDM",
      "CaloTopoClustersNew.calclus_NLeadingTruthParticleBarcodeEnergyPairs_DM",
      "Dead-material truth-particle barcode/energy decoration"};

◆ m_caloDmDescrManager

const CaloDmDescrManager* CaloCalibClusterDecoratorToolDM::m_caloDmDescrManager {nullptr}

private

Definition at line 85 of file CaloCalibClusterDecoratorToolDM.h.

85{nullptr};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_DMCalibrationHitContainerNames

SG::ReadHandleKeyArray<CaloCalibrationHitContainer> CaloCalibClusterDecoratorToolDM::m_DMCalibrationHitContainerNames

private

Initial value:

{
      this,
      "DMCalibrationHitContainerNames",
      {},
      "Dead-material calibration-hit containers"}

Definition at line 78 of file CaloCalibClusterDecoratorToolDM.h.

                                                                                    {
      this,
      "DMCalibrationHitContainerNames",
      {},
      "Dead-material calibration-hit containers"};

◆ m_energyMin

Gaudi::Property<float> CaloCalibClusterDecoratorToolDM::m_energyMin

private

Initial value:

{
      this,
      "EnergyMin",
      200.0 * CLHEP::MeV,
      "Minimum cluster energy used in dead-material sharing"}

Definition at line 106 of file CaloCalibClusterDecoratorToolDM.h.

                                  {
      this,
      "EnergyMin",
      200.0 * CLHEP::MeV,
      "Minimum cluster energy used in dead-material sharing"};

◆ m_energyMinCalib

Gaudi::Property<float> CaloCalibClusterDecoratorToolDM::m_energyMinCalib

private

Initial value:

{
      this,
      "EnergyMinCalib",
      20.0 * CLHEP::MeV,
      "Minimum in-cluster calibration energy used in dead-material sharing"}

Definition at line 112 of file CaloCalibClusterDecoratorToolDM.h.

                                       {
      this,
      "EnergyMinCalib",
      20.0 * CLHEP::MeV,
      "Minimum in-cluster calibration energy used in dead-material sharing"};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_foundAllContainers

std::atomic<bool> CaloCalibClusterDecoratorToolDM::m_foundAllContainers {false}

mutableprivate

Definition at line 240 of file CaloCalibClusterDecoratorToolDM.h.

240{false};

◆ m_i_phi_eta

std::array<std::vector<std::vector<CalibHitIPhiIEtaRange> >, 3> CaloCalibClusterDecoratorToolDM::m_i_phi_eta

private

Definition at line 92 of file CaloCalibClusterDecoratorToolDM.h.

◆ m_MatchDmType

Gaudi::Property<int> CaloCalibClusterDecoratorToolDM::m_MatchDmType

private

Initial value:

{
      this,
      "MatchDmType",
      kMatchDmLoose,
      "Dead-material matching type: 0=off, 1=loose, 2=medium, 3=tight"}

Definition at line 94 of file CaloCalibClusterDecoratorToolDM.h.

                                  {
      this,
      "MatchDmType",
      kMatchDmLoose,
      "Dead-material matching type: 0=off, 1=loose, 2=medium, 3=tight"};

◆ m_n_eta_out

int CaloCalibClusterDecoratorToolDM::m_n_eta_out {127}

private

Definition at line 88 of file CaloCalibClusterDecoratorToolDM.h.

88{127};

◆ m_n_phi_out

int CaloCalibClusterDecoratorToolDM::m_n_phi_out {127}

private

Definition at line 87 of file CaloCalibClusterDecoratorToolDM.h.

87{127};

◆ m_numTruthParticles

Gaudi::Property<unsigned int> CaloCalibClusterDecoratorToolDM::m_numTruthParticles

private

Initial value:

{
      this,
      "NumTruthParticles",
      100,
      "Number of truth particles per CaloCluster/PFO for which to store dead-material calibration-hit energy"}

Definition at line 66 of file CaloCalibClusterDecoratorToolDM.h.

                                                 {
      this,
      "NumTruthParticles",
      100,
      "Number of truth particles per CaloCluster/PFO for which to store dead-material calibration-hit energy"};

◆ m_out_eta_max

double CaloCalibClusterDecoratorToolDM::m_out_eta_max {6.0}

private

Definition at line 90 of file CaloCalibClusterDecoratorToolDM.h.

90{6.0};

◆ m_out_phi_max

double CaloCalibClusterDecoratorToolDM::m_out_phi_max {M_PI}

private

Definition at line 89 of file CaloCalibClusterDecoratorToolDM.h.

89{M_PI};

◆ m_rmaxOut

double CaloCalibClusterDecoratorToolDM::m_rmaxOut[3] {1.0, 0.5, 0.3}

private

Definition at line 91 of file CaloCalibClusterDecoratorToolDM.h.

91{1.0, 0.5, 0.3};

◆ m_useParticleID

Gaudi::Property<bool> CaloCalibClusterDecoratorToolDM::m_useParticleID

private

Initial value:

{
      this,
      "UseParticleID",
      true,
      "Use calibration-hit particle uniqueID for dead-material truth attribution"}

Definition at line 100 of file CaloCalibClusterDecoratorToolDM.h.

                                     {
      this,
      "UseParticleID",
      true,
      "Use calibration-hit particle uniqueID for dead-material truth attribution"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CalibHitIPhiIEtaRange

◆ CellInfoSet_t

◆ ClusInfo_t

◆ ClusList

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ keys_dm_energy_sharing

Constructor & Destructor Documentation

◆ CaloCalibClusterDecoratorToolDM()

Member Function Documentation

◆ accumulateDeadMaterialEnergy()

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_apars_alpha

◆ m_apars_r0

◆ m_CalibrationHitContainerNames

◆ m_calo_id

◆ m_caloClusterWriteDecorHandleKeyNLeadingTruthParticlesDM

◆ m_caloDmDescrManager

◆ m_detStore

◆ m_DMCalibrationHitContainerNames

◆ m_energyMin

◆ m_energyMinCalib

◆ m_evtStore

◆ m_foundAllContainers

◆ m_i_phi_eta

◆ m_MatchDmType

◆ m_n_eta_out

◆ m_n_phi_out

◆ m_numTruthParticles

◆ m_out_eta_max

◆ m_out_phi_max

◆ m_rmaxOut

◆ m_useParticleID

◆ m_varHandleArraysDeclared

◆ m_vhka