Algorithm that applies background subtraction to clusters. The subtraction needs to be handled separately from the making. The unsubtracted clusters are inputs into the jet finding which in turn defines the background (HIEventShapeContainer). More...

#include <HIClusterSubtraction.h>

Inheritance diagram for HIClusterSubtraction:

Collaboration diagram for HIClusterSubtraction:

Public Member Functions
	HIClusterSubtraction (const std::string &name)

virtual StatusCode	initialize ()
	Dummy implementation of the initialisation function. More...

virtual	~HIClusterSubtraction ()

virtual int	execute () const
	Method to be called for each event. More...

bool	doOriginCorrection (xAOD::CaloCluster cl, const xAOD::Vertex origin, xAOD::IParticle::FourMom_t &p4_cl) const

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

virtual int	inputContainerNames (std::vector< std::string > &connames)
	Method to return the list of input containers. More...

virtual int	outputContainerNames (std::vector< std::string > &connames)
	Method to return the list of output containers. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_inClusterKey { this, "ClusterKey", "ClusterKey", "Name of the input Cluster Container"}
	Name of input cluster container. More...

SG::WriteHandleKey< xAOD::CaloClusterContainer >	m_outClusterKey { this, "OutClusterKey", "OutClusterKey", "Name of the output Cluster Container (deep Copy)"}
	\|brief New writeHandleKey to store the shallow copy used for new CaloClusterTreatment More...

SG::ReadHandleKey< xAOD::HIEventShapeContainer >	m_eventShapeKey { this, "EventShapeKey", "EventShapeKey", "Name of HIEventShapeContainer defining background"}
	Name of HIEventShapeContainer defining background. More...

SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexContainer { this, "VertexContainer", "PrimaryVertices", "Vertex container for primary vertices"}
	\|brief Name of Vertex Container for origin correction More...

ToolHandle< IHISubtractorTool >	m_subtractorTool { this, "Subtractor", "HIJetSubtractorToolBase", "Handle to IHISubtractorTool which does calculates subtracted kinematics" }

ToolHandle< IHIUEModulatorTool >	m_modulatorTool { this, "Modulator" , "HIUEModulatorTool" , "Handle to IHIModulatorTool" }

ToolHandle< IHIEventShapeMapTool >	m_eventShapeMapTool { this, "EventShapeMapTool", "HIEventShapeMapTool", "Handle to Event Shape Map Tool"}

ToolHandleArray< CaloClusterCollectionProcessor >	m_clusterCorrectionTools { this, "ClusterCorrectionTools", {}, "" }

Gaudi::Property< bool >	m_setMoments { this, "SetMoments", true, "Set Moments boolean switch"}

Gaudi::Property< bool >	m_updateMode { this, "UpdateOnly", false, "Update Mode boolean switch"}

Gaudi::Property< bool >	m_originCorrection { this, "ApplyOriginCorrection", false, "Apply Origin Correction boolean switch"}

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Algorithm that applies background subtraction to clusters. The subtraction needs to be handled separately from the making. The unsubtracted clusters are inputs into the jet finding which in turn defines the background (HIEventShapeContainer).

Author: Aaron Angerami anger.nosp@m.ami@.nosp@m.cern..nosp@m.ch

Date: Jan, 2015

Definition at line 38 of file HIClusterSubtraction.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

◆ HIClusterSubtraction()

HIClusterSubtraction::HIClusterSubtraction ( const std::string & name )

Definition at line 22 of file HIClusterSubtraction.cxx.

                                                                 : asg::AsgTool(name)//,
 {
 }

◆ ~HIClusterSubtraction()

virtual HIClusterSubtraction::~HIClusterSubtraction ( )

inlinevirtual

Definition at line 45 of file HIClusterSubtraction.h.

45 {};

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

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

◆ doOriginCorrection()

bool HIClusterSubtraction::doOriginCorrection	(	xAOD::CaloCluster *	cl,
		const xAOD::Vertex *	origin,
		xAOD::IParticle::FourMom_t &	p4_cl
	)		const

Definition at line 46 of file HIClusterSubtraction.cxx.

                                                                                                                                  {
     //made boolean to return what was "missingMoment" in HIJetConstituentSubtractionTool
     bool missingMoment = false;
     float mag = 0;
         static const SG::ConstAccessor<float> HIMagAcc("HIMag");
     if(HIMagAcc.isAvailable(*cl)) mag=HIMagAcc(*cl);
     else
     {
         double cm_mag=0;
         if(cl->retrieveMoment (xAOD::CaloCluster::CENTER_MAG, cm_mag)) mag=cm_mag;
     }
     if(mag!=0.)
     {
         float eta0=cl->eta0();
         float phi0=cl->phi0();
         float radius=mag/std::cosh(eta0);
         xAOD::IParticle::FourMom_t p4_pos;
         p4_pos.SetX(radius*std::cos(phi0)-origin->x());
         p4_pos.SetY(radius*std::sin(phi0)-origin->y());
         p4_pos.SetZ(radius*std::sinh(eta0)-origin->z());
  
         double deta=p4_pos.Eta()-eta0;
         double dphi=p4_pos.Phi()-phi0;
         //adjust in case eta/phi are flipped in case of neg E clusters
         //this method is agnostic wrt convention
         if(p4_cl.Eta()*eta0 <0.) deta*=-1;
  
         double eta_prime=p4_cl.Eta()+deta;
         double phi_prime=p4_cl.Phi()+dphi;
         double e_subtr=p4_cl.E();
         p4_cl.SetPtEtaPhiE(e_subtr/std::cosh(eta_prime),eta_prime,phi_prime,e_subtr);
     }
     else missingMoment=true;
  
     return missingMoment;
 }

◆ evtStore() [1/2]

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; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

int HIClusterSubtraction::execute ( ) const

virtual

Method to be called for each event.

Returns 0 for success.

Implements IJetExecuteTool.

Definition at line 83 of file HIClusterSubtraction.cxx.

 {
   //const jet::cellset_t & badcells = badCellMap.cells() ;
   //retrieve UE
     const xAOD::HIEventShapeContainer* shape = 0;
     SG::ReadHandle<xAOD::HIEventShapeContainer>  readHandleEvtShape ( m_eventShapeKey );
   shape = readHandleEvtShape.cptr();
   const HIEventShapeIndex* es_index = m_eventShapeMapTool->getIndexFromShape( shape );
     if(es_index == nullptr) ATH_MSG_FATAL("The HIEventShapeMapTool returned a null pointer. Binning scheme not coherent");
   const xAOD::HIEventShape* eshape = nullptr;
   CHECK(m_modulatorTool->getShape(eshape), 1);
  
   //New implementation: make a deep copy of original HIClusters and apply subtraction to clusters in the new container
     SG::ReadHandle<xAOD::CaloClusterContainer>  readHandleClusters ( m_inClusterKey );
   // Now a handle to write the deep Copy
   SG::WriteHandle<xAOD::CaloClusterContainer> writeHandleDeepCopyClusters ( m_outClusterKey );
   // Preparing keys and container to perfrom the origin correction
     const xAOD::Vertex* primVertex=nullptr;
     const xAOD::VertexContainer* vertices=nullptr;
   // Boolean to flag that at least a vertex is present in the vertex container
     bool isOriginPossible = true;
     // Finding the primary vertex in case origin correction has to be performed
     if(m_originCorrection)
   {
         // ReadHandle to retrieve the vertex container
         SG::ReadHandle<xAOD::VertexContainer>  readHandleVertexContainer ( m_vertexContainer );
     vertices = readHandleVertexContainer.get();
     for (const auto *vertice : *vertices)
     {
       if(vertice->vertexType() == xAOD::VxType::PriVtx)
       {
             primVertex=vertice;
             break;
       }
     }
     if(!primVertex && vertices->size() > 0)
     {
       ATH_MSG_WARNING("No primary vertices found, using first in container");
       primVertex=vertices->at(0);
     }
         if(!primVertex && vertices->size() == 0)
     {
       ATH_MSG_WARNING("No primary vertices found, and vertex container empty. Abortin Origin correction for this event.");
       isOriginPossible = false;
         }
   }
     bool missingMoment=false;
  
     const auto *originalCluster = readHandleClusters.cptr();
     // Create the new container and its auxiliary store.
     xAOD::CaloClusterContainer* copyClusters = new xAOD::CaloClusterContainer();
   xAOD::CaloClusterAuxContainer* copyClustersAux = new xAOD::CaloClusterAuxContainer();
   copyClusters->setStore(copyClustersAux);
   copyClusters->reserve (originalCluster->size());
  
     for (const xAOD::CaloCluster* oldCluster : *originalCluster) {
          xAOD::CaloCluster* newClu=new xAOD::CaloCluster();
          copyClusters->push_back (newClu);
          *newClu=*oldCluster;
     }
  
   for(xAOD::CaloClusterContainer::iterator itr=copyClusters->begin(); itr!=copyClusters->end(); ++itr)
   {
     xAOD::CaloCluster* cl= *itr;
         xAOD::IParticle::FourMom_t p4;
         //Unsubtracted state record done by the subtractor tool functions.
     if(m_setMoments)
         {
             //This flag is set to false for HIJetClustersSubtractorTool and true for HIJetCellSubtractorTool,
             // but for the second we don't do origin correction. In principle the code is structured to do the same as the
             //else for m_setMoments=true and HIJetClustersSubtractorTool, therefore we add the code for origin correction also here
             m_subtractorTool->subtractWithMoments(cl, shape, es_index, m_modulatorTool, eshape);
             if(isOriginPossible && m_originCorrection)
             {
                 missingMoment = HIClusterSubtraction::doOriginCorrection( cl, primVertex, p4 );
                 HIJetRec::setClusterP4(p4,cl,HIJetRec::subtractedOriginCorrectedClusterState());
             }
         }
     else
     {
             m_subtractorTool->subtract(p4,cl,shape,es_index,m_modulatorTool,eshape);
             HIJetRec::setClusterP4(p4,cl,HIJetRec::subtractedClusterState());
  
             if(isOriginPossible && m_originCorrection)
             {
                 ATH_MSG_DEBUG("Applying origin correction"
                             << std::setw(12) << "Before:"
                             << std::setw(10) << std::setprecision(3) << p4.Pt()*1e-3
                             << std::setw(10) << std::setprecision(3) << p4.Eta()
                             << std::setw(10) << std::setprecision(3) << p4.Phi()
                             << std::setw(10) << std::setprecision(3) << p4.E()*1e-3
                             << std::setw(10) << std::setprecision(3) << p4.M()*1e-3);
  
                 missingMoment = HIClusterSubtraction::doOriginCorrection( cl, primVertex, p4 );
                 HIJetRec::setClusterP4(p4,cl,HIJetRec::subtractedOriginCorrectedClusterState());
  
                 ATH_MSG_DEBUG("Applying origin correction"
                             << std::setw(12) << "After:"
                             << std::setw(10) << std::setprecision(3) << p4.Pt()*1e-3
                             << std::setw(10) << std::setprecision(3) << p4.Eta()
                             << std::setw(10) << std::setprecision(3) << p4.Phi()
                             << std::setw(10) << std::setprecision(3) << p4.E()*1e-3
                             << std::setw(10) << std::setprecision(3) << p4.M()*1e-3);
             }
         }
   }//End of iterator over CaloClusterContainer
  
     for(const auto & clusterCorrectionTool : m_clusterCorrectionTools)
     {
       ATH_MSG_DEBUG(" Applying correction = " << clusterCorrectionTool->name() );
             CHECK(clusterCorrectionTool->execute(Gaudi::Hive::currentContext(), copyClusters), 1);
     }//End loop over correction tools
  
         if(missingMoment) ATH_MSG_WARNING("No origin correction applied, CENTERMAG missing");
  
   // Make sure that memory is managed safely
   std::unique_ptr<xAOD::CaloClusterContainer> outClusters(copyClusters);
   std::unique_ptr<xAOD::CaloClusterAuxContainer> deepAux(copyClustersAux);
  
     if(writeHandleDeepCopyClusters.record ( std::move(outClusters), std::move(deepAux)).isFailure() ){
             ATH_MSG_ERROR("Unable to write DeepCopy Copy containers for subtracted clusters with key: " << m_outClusterKey.key());
             return 1;
     }
   return 0;
 }

◆ 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

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode HIClusterSubtraction::initialize ( )

virtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 28 of file HIClusterSubtraction.cxx.

 {
     //Keys initialization
     ATH_CHECK( m_eventShapeKey.initialize() );
     ATH_CHECK( m_inClusterKey.initialize() );
     ATH_CHECK( m_outClusterKey.initialize() );
     //Vertex container needs to be initialized only if origin correction will take place
     ATH_CHECK( m_vertexContainer.initialize( m_originCorrection ) );
  
   for (const auto& tool :  m_clusterCorrectionTools)
   {
     StatusCode sc = tool.retrieve();
     if (sc.isFailure()) ATH_MSG_ERROR("Failed to retrieve correction tool " << tool);
     else ATH_MSG_DEBUG("Successfully retrieved correction tool " << tool);
   }
   return StatusCode::SUCCESS;
 }

◆ inputContainerNames()

int IJetExecuteTool::inputContainerNames ( std::vector< std::string > & connames )

virtualinherited

Method to return the list of input containers.

The names of required input containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 11 of file IJetExecuteTool.cxx.

                                                               {
   return 0;
 }

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

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputContainerNames()

int IJetExecuteTool::outputContainerNames ( std::vector< std::string > & connames )

virtualinherited

Method to return the list of output containers.

The names of produced output containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 17 of file IJetExecuteTool.cxx.

                                                                {
   return 0;
 }

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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

ToolHandleArray<CaloClusterCollectionProcessor> HIClusterSubtraction::m_clusterCorrectionTools { this, "ClusterCorrectionTools", {}, "" }

private

Definition at line 66 of file HIClusterSubtraction.h.

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

SG::ReadHandleKey< xAOD::HIEventShapeContainer > HIClusterSubtraction::m_eventShapeKey { this, "EventShapeKey", "EventShapeKey", "Name of HIEventShapeContainer defining background"}

private

Name of HIEventShapeContainer defining background.

Definition at line 58 of file HIClusterSubtraction.h.

◆ m_eventShapeMapTool

ToolHandle<IHIEventShapeMapTool> HIClusterSubtraction::m_eventShapeMapTool { this, "EventShapeMapTool", "HIEventShapeMapTool", "Handle to Event Shape Map Tool"}

private

Definition at line 65 of file HIClusterSubtraction.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_inClusterKey

SG::ReadHandleKey< xAOD::CaloClusterContainer > HIClusterSubtraction::m_inClusterKey { this, "ClusterKey", "ClusterKey", "Name of the input Cluster Container"}

private

Name of input cluster container.

Definition at line 54 of file HIClusterSubtraction.h.

◆ m_modulatorTool

ToolHandle<IHIUEModulatorTool> HIClusterSubtraction::m_modulatorTool { this, "Modulator" , "HIUEModulatorTool" , "Handle to IHIModulatorTool" }

private

Definition at line 64 of file HIClusterSubtraction.h.

◆ m_originCorrection

Gaudi::Property< bool > HIClusterSubtraction::m_originCorrection { this, "ApplyOriginCorrection", false, "Apply Origin Correction boolean switch"}

private

Definition at line 72 of file HIClusterSubtraction.h.

◆ m_outClusterKey

SG::WriteHandleKey< xAOD::CaloClusterContainer > HIClusterSubtraction::m_outClusterKey { this, "OutClusterKey", "OutClusterKey", "Name of the output Cluster Container (deep Copy)"}

private

|brief New writeHandleKey to store the shallow copy used for new CaloClusterTreatment

Definition at line 56 of file HIClusterSubtraction.h.

◆ m_setMoments

Gaudi::Property< bool > HIClusterSubtraction::m_setMoments { this, "SetMoments", true, "Set Moments boolean switch"}

private

Definition at line 69 of file HIClusterSubtraction.h.

◆ m_subtractorTool

ToolHandle<IHISubtractorTool> HIClusterSubtraction::m_subtractorTool { this, "Subtractor", "HIJetSubtractorToolBase", "Handle to IHISubtractorTool which does calculates subtracted kinematics" }

private

Definition at line 63 of file HIClusterSubtraction.h.

◆ m_updateMode

Gaudi::Property< bool > HIClusterSubtraction::m_updateMode { this, "UpdateOnly", false, "Update Mode boolean switch"}

private

Definition at line 70 of file HIClusterSubtraction.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer

SG::ReadHandleKey< xAOD::VertexContainer > HIClusterSubtraction::m_vertexContainer { this, "VertexContainer", "PrimaryVertices", "Vertex container for primary vertices"}

private

|brief Name of Vertex Container for origin correction

Definition at line 60 of file HIClusterSubtraction.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

◆ HIClusterSubtraction()

◆ ~HIClusterSubtraction()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ doOriginCorrection()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputContainerNames()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputContainerNames()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_clusterCorrectionTools

◆ m_detStore

◆ m_eventShapeKey

◆ m_eventShapeMapTool

◆ m_evtStore

◆ m_inClusterKey

◆ m_modulatorTool

◆ m_originCorrection

◆ m_outClusterKey

◆ m_setMoments

◆ m_subtractorTool

◆ m_updateMode

◆ m_varHandleArraysDeclared

◆ m_vertexContainer

◆ m_vhka