Calibration hit truth information decoration of xAOD::CaloClusters. More...

#include <CaloCalibClusterDecoratorTool.h>

Inheritance diagram for CaloCalibClusterDecoratorTool:

Collaboration diagram for CaloCalibClusterDecoratorTool:

Public Member Functions
	CaloCalibClusterDecoratorTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor.
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *theClusColl) const override final
	Execute on an entire collection of clusters.
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
virtual	~CaloCalibClusterDecoratorTool ()
	Destructor.
virtual StatusCode	execute (xAOD::CaloClusterContainer *collection) final
	Execute on an entire collection of clusters.
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
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	calculateTruthEnergies (const xAOD::CaloCluster &theCaloCluster, unsigned int numTruthParticles, const std::map< Identifier, std::vector< const CaloCalibrationHit * > > &identifierToCaloHitMap, std::vector< std::pair< unsigned int, double > > &truthIDTrueCalHitEnergy) const
	Calculate truth energies for a given cluster.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< std::map< Identifier, std::vector< const CaloCalibrationHit * > > >	m_mapIdentifierToCalibHitsReadHandleKey
	ReadHandleKey for the map between Identifiers and sets of calibration hits.
SG::WriteDecorHandleKey< xAOD::CaloClusterContainer >	m_caloClusterWriteDecorHandleKeyNLeadingTruthParticles
	Write handle key to decorate CaloCluster with threeN leading truth particle barcode and energy.
Gaudi::Property< unsigned int >	m_numTruthParticles
	Allow user to set the number of truth particles per clusterCaloCluster or PFO, in descending pt order, for which to store calibration hit enery.
Gaudi::Property< bool >	m_useCellWeights
	Toggle whether to use cell weights or not to calculate calibration hit contribution.
Gaudi::Property< bool >	m_storeFullTruthEnergy
	Toggle whether to store full truth energy (include invisible + escaped)
ToolHandle< ICaloCalibClusterTruthAttributerTool >	m_truthAttributerTool
	External tool that handles calculation logic of truth energies.
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

Calibration hit truth information decoration of xAOD::CaloClusters.

This algorithm decorates xAOD::CaloCluster with calibration hit truth information. It relies on upstream creation of several maps in CaloCalibClusterTruthMapMakerAlgorithm, stored in Storegate, to provide fast access to required information. The actual calculations are taken care of by an ICaloCalibClusterTruthAttributerTool. The user may toggle how many truth particles to consider per xAOD::CaloCluster, ordered in leading calibration hit truth pt, via a Gaudi Property "NumTruthParticles".

Definition at line 40 of file CaloCalibClusterDecoratorTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CaloCalibClusterDecoratorTool()

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

Constructor.

Definition at line 10 of file CaloCalibClusterDecoratorTool.cxx.

14 : AthAlgTool(type, name, parent)

15{}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

◆ ~CaloCalibClusterDecoratorTool()

virtual CaloCalibClusterDecoratorTool::~CaloCalibClusterDecoratorTool ( )

inlinevirtual

Destructor.

Definition at line 65 of file CaloCalibClusterDecoratorTool.h.

65{};

Member Function Documentation

◆ calculateTruthEnergies()

StatusCode CaloCalibClusterDecoratorTool::calculateTruthEnergies	(	const xAOD::CaloCluster &	theCaloCluster,
		unsigned int	numTruthParticles,
		const std::map< Identifier, std::vector< const CaloCalibrationHit * > > &	identifierToCaloHitMap,
		std::vector< std::pair< unsigned int, double > > &	truthIDTrueCalHitEnergy ) const

private

Calculate truth energies for a given cluster.

◆ 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() [1/2]

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

finaloverridevirtual

Execute on an entire collection of clusters.

Parameters

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

Implements CaloClusterCollectionProcessor.

Definition at line 27 of file CaloCalibClusterDecoratorTool.cxx.

{
  SG::ReadHandle<std::map<Identifier,std::vector<const CaloCalibrationHit*> > > mapIdentifierToCalibHitsReadHandle(
      m_mapIdentifierToCalibHitsReadHandleKey, ctx);
  
  if (!mapIdentifierToCalibHitsReadHandle.isValid()) {
    ATH_MSG_WARNING("Could not retrieve map between Identifier and calibraiton hits from Storegae");
    return StatusCode::FAILURE;
  }  
 
  SG::WriteDecorHandle<xAOD::CaloClusterContainer, 
                       std::vector<std::pair<unsigned int, double> > > 
      caloClusterWriteDecorHandleNLeadingTruthParticles(
          m_caloClusterWriteDecorHandleKeyNLeadingTruthParticles, ctx);
 
  for (const xAOD::CaloCluster* thisCaloCluster : *theClusColl) {
 
    std::vector<std::pair<unsigned int, double> > newTruthIDTruthPairs;
    ATH_CHECK(
      m_truthAttributerTool->calculateTruthEnergies(
        *thisCaloCluster,
        m_numTruthParticles,
        *mapIdentifierToCalibHitsReadHandle,
        newTruthIDTruthPairs
      )
    );
 
    for (const auto& thisPair : newTruthIDTruthPairs) 
      ATH_MSG_DEBUG(
          "Cluster Final loop: Particle with truthID " << thisPair.first
          << " has truth energy of " << thisPair.second
          << " for cluster with e, eta " << thisCaloCluster->e()
          << " and " << thisCaloCluster->eta()
      );
 
    caloClusterWriteDecorHandleNLeadingTruthParticles(*thisCaloCluster) = std::move(newTruthIDTruthPairs);
  }
  
  return StatusCode::SUCCESS;
}

◆ execute() [2/2]

virtual StatusCode CaloClusterCollectionProcessor::execute ( xAOD::CaloClusterContainer * collection )

inlinefinalvirtual

Execute on an entire collection of clusters.

Parameters

collection The container of clusters. (deprecated)

Reimplemented from CaloClusterCollectionProcessor.

Definition at line 50 of file CaloClusterCollectionProcessor.h.

  {
    return execute (Gaudi::Hive::currentContext(), collection);
  }

◆ 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

◆ finalize()

StatusCode CaloCalibClusterDecoratorTool::finalize ( )

overridevirtual

Definition at line 70 of file CaloCalibClusterDecoratorTool.cxx.

                                                   {
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode CaloCalibClusterDecoratorTool::initialize ( )

overridevirtual

Definition at line 17 of file CaloCalibClusterDecoratorTool.cxx.

                                                     {
  ATH_MSG_INFO("Decor key container: " << m_caloClusterWriteDecorHandleKeyNLeadingTruthParticles.key());
  ATH_MSG_DEBUG("Recording truth map with key: " << m_mapIdentifierToCalibHitsReadHandleKey.key());
  ATH_CHECK(m_mapIdentifierToCalibHitsReadHandleKey.initialize());
  ATH_CHECK(m_truthAttributerTool.retrieve());
  ATH_CHECK(m_caloClusterWriteDecorHandleKeyNLeadingTruthParticles.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 >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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_caloClusterWriteDecorHandleKeyNLeadingTruthParticles

SG::WriteDecorHandleKey<xAOD::CaloClusterContainer> CaloCalibClusterDecoratorTool::m_caloClusterWriteDecorHandleKeyNLeadingTruthParticles

private

Initial value:

{
      this,
      "CaloClusterWriteDecorHandleKey_NLeadingTruthParticles",
      "CaloTopoClustersNew.calclus_NLeadingTruthParticleBarcodeEnergyPairs"}

Write handle key to decorate CaloCluster with threeN leading truth particle barcode and energy.

Definition at line 88 of file CaloCalibClusterDecoratorTool.h.

                                                          {
      this,
      "CaloClusterWriteDecorHandleKey_NLeadingTruthParticles",
      "CaloTopoClustersNew.calclus_NLeadingTruthParticleBarcodeEnergyPairs"};

◆ 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_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_mapIdentifierToCalibHitsReadHandleKey

SG::ReadHandleKey<std::map<Identifier,std::vector<const CaloCalibrationHit*> > > CaloCalibClusterDecoratorTool::m_mapIdentifierToCalibHitsReadHandleKey

private

Initial value:

{this,"IdentifierToCalibHitsMapName","IdentifierToCalibHitsMap",

"ReadHandleKey for the map between Identifiers and sets of calibration hits"}

ReadHandleKey for the map between Identifiers and sets of calibration hits.

Definition at line 81 of file CaloCalibClusterDecoratorTool.h.

81 {this,"IdentifierToCalibHitsMapName","IdentifierToCalibHitsMap",

82 "ReadHandleKey for the map between Identifiers and sets of calibration hits"};

◆ m_numTruthParticles

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

private

Initial value:

{
      this,"NumTruthParticles",100,
      "Set number of truth particles per CaloCluster/PFO for which we store calibration hit energy"}

Allow user to set the number of truth particles per clusterCaloCluster or PFO, in descending pt order, for which to store calibration hit enery.

Definition at line 97 of file CaloCalibClusterDecoratorTool.h.

                                                 {
      this,"NumTruthParticles",100,
      "Set number of truth particles per CaloCluster/PFO for which we store calibration hit energy"};

◆ m_storeFullTruthEnergy

Gaudi::Property<bool> CaloCalibClusterDecoratorTool::m_storeFullTruthEnergy

private

Initial value:

{
      this,"StoreFullTruthEnergy",false,
      "If true, include escaped + invisible energy in truth energy calculation"}

Toggle whether to store full truth energy (include invisible + escaped)

Definition at line 111 of file CaloCalibClusterDecoratorTool.h.

                                            {
      this,"StoreFullTruthEnergy",false,
      "If true, include escaped + invisible energy in truth energy calculation"};

◆ m_truthAttributerTool

ToolHandle<ICaloCalibClusterTruthAttributerTool> CaloCalibClusterDecoratorTool::m_truthAttributerTool

private

Initial value:

{
      this,"TruthAttributerTool","",
      "ToolHandle to a tool to create the calibration hit truth information that we need for the decoration"}

External tool that handles calculation logic of truth energies.

Definition at line 119 of file CaloCalibClusterDecoratorTool.h.

                         {
      this,"TruthAttributerTool","",
      "ToolHandle to a tool to create the calibration hit truth information that we need for the decoration"};

◆ m_useCellWeights

Gaudi::Property<bool> CaloCalibClusterDecoratorTool::m_useCellWeights

private

Initial value:

{
      this,"useCellWeights",true,
      "Toggle whether to use cell weights or not to calculate calibration hit contribution"}

Toggle whether to use cell weights or not to calculate calibration hit contribution.

Definition at line 104 of file CaloCalibClusterDecoratorTool.h.

                                      {
      this,"useCellWeights",true,
      "Toggle whether to use cell weights or not to calculate calibration hit contribution"};

◆ 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 Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CaloCalibClusterDecoratorTool()

◆ ~CaloCalibClusterDecoratorTool()

Member Function Documentation

◆ calculateTruthEnergies()

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute() [1/2]

◆ execute() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_caloClusterWriteDecorHandleKeyNLeadingTruthParticles

◆ m_detStore

◆ m_evtStore

◆ m_mapIdentifierToCalibHitsReadHandleKey

◆ m_numTruthParticles

◆ m_storeFullTruthEnergy

◆ m_truthAttributerTool

◆ m_useCellWeights

◆ m_varHandleArraysDeclared

◆ m_vhka