#include <HIEventShapeJetIteration.h>

Inheritance diagram for HIEventShapeJetIteration:

Collaboration diagram for HIEventShapeJetIteration:

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

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

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

StatusCode	makeClusterList (std::vector< const xAOD::CaloCluster * > &particleList, const xAOD::JetContainer *theJets, std::set< unsigned int > &used_indices, std::set< unsigned int > &used_eta_bins) const

StatusCode	makeClusterList (std::vector< const xAOD::CaloCluster * > &particleList, const xAOD::JetContainer *theJets) const

StatusCode	makeClusterList (std::vector< const xAOD::CaloCluster * > &particleList, const std::vector< const xAOD::JetContainer * > &theJets_vector) const

void	updateShape (xAOD::HIEventShapeContainer output_shape, const std::vector< const xAOD::CaloCluster > &assoc_clusters, const HIEventShapeIndex *es_index=nullptr) const

StatusCode	fillModulatorShape (xAOD::HIEventShape ms, const xAOD::HIEventShapeContainer output_shape, const std::set< unsigned int > &used_indices, unsigned int scheme) const

StatusCode	remodulate (xAOD::HIEventShapeContainer output_shape, const xAOD::HIEventShape ms, const std::set< unsigned int > &used_indices) const

StatusCode	getShapes (const xAOD::HIEventShapeContainer &input_shape, xAOD::HIEventShapeContainer &output_shape, bool record_aux=false) 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...

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

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

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
	ASG_TOOL_CLASS (HIEventShapeJetIteration, IJetExecuteTool)

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
ToolHandle< IHISubtractorTool >	m_subtractorTool { this, "Subtractor", "HIJetClusterSubtractorTool", "Handle to HIJetClusterSubtractorTool" }

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

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

SG::ReadHandleKey< xAOD::HIEventShapeContainer >	m_inputEventShapeKey { this, "InputEventShapeKey", "HIEventShape", "HIEventShape"}
	Name of input HIEventShapeContainer. More...

SG::WriteHandleKey< xAOD::HIEventShapeContainer >	m_outputEventShapeKey { this, "OutputEventShapeKey", "HIEventShape_iter", "HIEventShape_iter"}
	Name of output HIEventShapeContainer. More...

SG::ReadHandleKey< xAOD::JetContainer >	m_caloJetSeedKey { this, "CaloJetSeedContainerKey", "", "Names of seed collections"}
	List of names of JetCollections, all jets in these collections are seeds. More...

SG::ReadHandleKey< xAOD::JetContainer >	m_trackJetSeedKey { this, "TrackJetSeedContainerKey", "", "Names of seed collections"}

Gaudi::Property< std::string >	m_associationKey { this, "AssociationKey", "", "Name of jet attribute providing link between jets and clusters" }
	Name of jet attribute providing link between jets and clusters. More...

Gaudi::Property< float >	m_excludeDR { this, "ExclusionRadius", 0.4, "Exclude all calo regions w/in this DR to jet" }
	All clusters w/in this DR of jet are excluded from shape calc. More...

Gaudi::Property< bool >	m_excludeConstituents { this, "ExcludeConstituents", false, "Only exclude constituents of jets" }
	If selected, the jet constituents define the associated clusters. More...

Gaudi::Property< bool >	m_doRemodulation { this, "RemodulateUE", false, "Correct UE for incomplete cancellation of flow harmonics when iterating" }

Gaudi::Property< unsigned int >	m_modulationScheme { this, "ModulationScheme", 0, "Scheme to build separate ES object for flow modulation" }

SG::WriteHandleKey< xAOD::HIEventShapeContainer >	m_modulationKey { this, "ModulationEventShapeKey", "HIEventShape_itr_mod", "Modulation Event Shape Key"}

Gaudi::Property< bool >	m_shallowCopy { this, "ShallowCopy", true, "Use shallow copy for iterated event shape" }

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

Definition at line 23 of file HIEventShapeJetIteration.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

◆ HIEventShapeJetIteration()

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

Definition at line 33 of file HIEventShapeJetIteration.cxx.

                                                                         : AsgTool(name)
 {
 }

Member Function Documentation

◆ ASG_TOOL_CLASS()

HIEventShapeJetIteration::ASG_TOOL_CLASS	(	HIEventShapeJetIteration	,
		IJetExecuteTool
	)

private

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

◆ 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 HIEventShapeJetIteration::execute ( ) const

overridevirtual

Method to be called for each event.

Returns 0 for success.

Implements IJetExecuteTool.

Definition at line 49 of file HIEventShapeJetIteration.cxx.

 {
   ATH_MSG_DEBUG( "Starting HIEventShapeJetIteration execution" );
   const xAOD::HIEventShapeContainer* input_shape=nullptr;
   xAOD::HIEventShapeContainer* output_shape=nullptr;
   getShapes(input_shape,output_shape,true).ignore();
  
   const HIEventShapeIndex* es_index = m_eventShapeMapTool->getIndexFromShape(input_shape);
   //New implementation after moving away from mutable
   ATH_MSG_DEBUG("HIEventShapeJetIteration: found index for  " << m_inputEventShapeKey.key());
   if(es_index==nullptr)
   {
     ATH_MSG_FATAL("No HIEventShapeIndex w/ name " << m_inputEventShapeKey.key() << ". Shape not TOWER nor COMPACT");
   }
  
   const HIEventShapeIndex* other_index = m_eventShapeMapTool->getIndexFromShape(output_shape);
   if(!other_index) {
    ATH_MSG_FATAL("No HIEventShapeIndex w/ name " << m_outputEventShapeKey.key() << ". Shape not TOWER nor COMPACT");
   }
   //End of new implementation
  
   const xAOD::JetContainer* theCaloJets=0;
   const xAOD::JetContainer* theTrackJets=0;
  
   if(!m_caloJetSeedKey.empty()){
     SG::ReadHandle<xAOD::JetContainer>  readHandleCaloJets  ( m_caloJetSeedKey );
     theCaloJets = readHandleCaloJets.cptr();
   }
   if(!m_trackJetSeedKey.empty()){
     SG::ReadHandle<xAOD::JetContainer>  readHandleTrackJets ( m_trackJetSeedKey );
     theTrackJets = readHandleTrackJets.cptr();
   }
  
   if(theTrackJets && m_excludeConstituents)
   {
     ATH_MSG_ERROR("Incompatible options. Cannot track jets and constituents together.");
     return 1;
   }
  
   std::set<unsigned int> used_indices;
   std::set<unsigned int> used_eta_bins;
  
   std::vector<const xAOD::CaloCluster*> assoc_clusters;
   assoc_clusters.reserve(6400);
   if(theCaloJets) ATH_CHECK(makeClusterList(assoc_clusters,theCaloJets,used_indices,used_eta_bins), 1);
   if(theTrackJets) ATH_CHECK(makeClusterList(assoc_clusters,theTrackJets,used_indices,used_eta_bins), 1);
   updateShape(output_shape,assoc_clusters,es_index);
  
   ATH_MSG_DEBUG( "Checking Modulation Scheme" );
  
   //compute ES for modulation
   if(m_modulationScheme)
   {
     SG::WriteHandle<xAOD::HIEventShapeContainer> write_handle_modShape ( m_modulationKey );
     ATH_MSG_DEBUG( "Key HIEventShapeJetIteration: " << m_modulationKey.key() );
  
     auto modShape = std::make_unique<xAOD::HIEventShapeContainer> ();
     auto modShapeAux = std::make_unique<xAOD::HIEventShapeAuxContainer> ();
     modShape->setStore( modShapeAux.get() );
  
     xAOD::HIEventShape* ms=new xAOD::HIEventShape();
     modShape->push_back(ms);
     ATH_CHECK( fillModulatorShape(ms, output_shape, used_eta_bins, m_modulationScheme), 1 );
     if(m_doRemodulation) ATH_CHECK( remodulate(output_shape, ms, used_indices), 1 );
  
     if(write_handle_modShape.record ( std::move(modShape), std::move(modShapeAux)).isFailure() ){
       ATH_MSG_ERROR("Unable to write newHIEventShapeContainer for modulated shape with key: " << m_modulationKey.key());
       return 0;
     }
   }
  
   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

◆ fillModulatorShape()

StatusCode HIEventShapeJetIteration::fillModulatorShape	(	xAOD::HIEventShape *	ms,
		const xAOD::HIEventShapeContainer *	output_shape,
		const std::set< unsigned int > &	used_indices,
		unsigned int	scheme
	)		const

Definition at line 213 of file HIEventShapeJetIteration.cxx.

 {
   if(scheme==1 || scheme==2)
   {
     SelectByList selector;
     selector.used_set=&used_eta_bins;
     HI::fillSummary(output_shape,ms,selector);
   }
  
   if(scheme > 1)
   {
     const xAOD::HIEventShapeContainer* summary_container=0;
  
     SG::ReadHandle<xAOD::HIEventShapeContainer>  read_handle_cont ( "CaloSums" );
     if (!read_handle_cont.isValid()) {
        ATH_MSG_FATAL( "Could not find HI event shape! CaloSums" );
        return(StatusCode::FAILURE);
     }
     summary_container = read_handle_cont.cptr();
  
     const xAOD::HIEventShape* s_fcal=0;
     for(const auto *sh : *summary_container)
     {
       std::string summary;
       static const SG::ConstAccessor<std::string> SummaryAcc("Summary");
       if(SummaryAcc.isAvailable(*sh)) summary=SummaryAcc(*sh);
       if(summary.compare("FCal")==0)
       {
     s_fcal=sh;
     break;
       }
     }
     if (!s_fcal) std::abort();
     if(scheme==3) (*ms)=(*s_fcal);
     else
     {
       float et_fcal=s_fcal->et();
       float et_fcal_recip=0;
       if(et_fcal > 0.) et_fcal_recip=1.0/et_fcal;
       for(unsigned int ih=0; ih < ms->etCos().size(); ih++)
       {
     float qx=ms->etCos().at(ih);
     float qy=ms->etSin().at(ih);
  
     float qx_fcal=s_fcal->etCos().at(ih);
     float qy_fcal=s_fcal->etSin().at(ih);
  
     ms->etCos()[ih]=(qx*qx_fcal+qy*qy_fcal)*et_fcal_recip;
     ms->etSin()[ih]=(qy*qx_fcal-qx*qy_fcal)*et_fcal_recip;
       } //end loop on harmonics
     } //end scheme==2
   } // end modulation > 1 case
   return StatusCode::SUCCESS;
 }

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

◆ getShapes()

StatusCode HIEventShapeJetIteration::getShapes	(	const xAOD::HIEventShapeContainer *&	input_shape,
		xAOD::HIEventShapeContainer *&	output_shape,
		bool	record_aux = `false`
	)		const

Definition at line 304 of file HIEventShapeJetIteration.cxx.

 {
   SG::ReadHandle<xAOD::HIEventShapeContainer>  readHandleEvtShape ( m_inputEventShapeKey );
   SG::WriteHandle<xAOD::HIEventShapeContainer> writeHandleEvtShape ( m_outputEventShapeKey );
  
   input_shape = readHandleEvtShape.ptr();
  
   if(m_shallowCopy)
   {
     auto shape_copy=xAOD::shallowCopyContainer(*input_shape);
     auto unique_first_copy = xAOD::prepareElementForShallowCopy(shape_copy.first);
     auto unique_second_copy = xAOD::prepareElementForShallowCopy(shape_copy.second);
     output_shape=shape_copy.first;
     if(record)
     {
       ATH_MSG_DEBUG( "Write Handle current key is : " <<  m_outputEventShapeKey.key() );
       if(writeHandleEvtShape.record ( std::move(unique_first_copy), std::move(unique_second_copy)).isFailure() ){
         ATH_MSG_ERROR("Unable to write Shallow Copy containers for event shape with key: " << m_outputEventShapeKey.key());
         return(StatusCode::FAILURE);
       }
     }
  
   }
   else
   {
     auto output_shapex=std::make_unique<xAOD::HIEventShapeContainer> ();
     auto output_Aux=std::make_unique<xAOD::HIEventShapeAuxContainer> ();
     output_shapex->setStore( output_Aux.get() );
     output_shapex->reserve( input_shape->size() );
  
     for(const auto *s : *input_shape)
     {
       xAOD::HIEventShape* s_copy=new xAOD::HIEventShape();
       output_shapex->push_back(s_copy);
       *s_copy=*s;
     }
     if(record)
     {
         if(writeHandleEvtShape.record ( std::move(output_shapex), std::move(output_Aux)).isFailure() ){
         ATH_MSG_ERROR("Unable to write Output Shape containers for event shape with key: " << m_outputEventShapeKey.key());
         return(StatusCode::FAILURE);
       }
       output_shape = writeHandleEvtShape.ptr();
     }
  
   }
  
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode HIEventShapeJetIteration::initialize ( )

overridevirtual

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 37 of file HIEventShapeJetIteration.cxx.

 {
    ATH_MSG_VERBOSE("HIEventShapeJetIteration initialize");
    ATH_CHECK( m_inputEventShapeKey.initialize( !m_inputEventShapeKey.key().empty()) );
    ATH_CHECK( m_outputEventShapeKey.initialize( !m_outputEventShapeKey.key().empty()) );
    ATH_CHECK( m_caloJetSeedKey.initialize( SG::AllowEmpty ) );
    ATH_CHECK( m_trackJetSeedKey.initialize( SG::AllowEmpty ) );
    ATH_CHECK( m_modulationKey.initialize( m_modulationScheme ));
  
    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.

◆ makeClusterList() [1/3]

StatusCode HIEventShapeJetIteration::makeClusterList	(	std::vector< const xAOD::CaloCluster * > &	particleList,
		const std::vector< const xAOD::JetContainer * > &	theJets_vector
	)		const

Definition at line 172 of file HIEventShapeJetIteration.cxx.

 {
   std::set<unsigned int> used_indices;
   std::set<unsigned int> used_eta_bins;
   for(const auto *theJets : theJets_vector)
   {
     ATH_CHECK(makeClusterList(particleList,theJets,used_indices,used_eta_bins));
   }
   return StatusCode::SUCCESS;
 }

◆ makeClusterList() [2/3]

StatusCode HIEventShapeJetIteration::makeClusterList	(	std::vector< const xAOD::CaloCluster * > &	particleList,
		const xAOD::JetContainer *	theJets
	)		const

Definition at line 166 of file HIEventShapeJetIteration.cxx.

 {
   std::set<unsigned int> used_indices;
   std::set<unsigned int> used_eta_bins;
   return makeClusterList(particleList,theJets,used_indices,used_eta_bins);
 }

◆ makeClusterList() [3/3]

StatusCode HIEventShapeJetIteration::makeClusterList	(	std::vector< const xAOD::CaloCluster * > &	particleList,
		const xAOD::JetContainer *	theJets,
		std::set< unsigned int > &	used_indices,
		std::set< unsigned int > &	used_eta_bins
	)		const

Definition at line 124 of file HIEventShapeJetIteration.cxx.

 {
   for(const auto *theJet : *theJets)
   {
     xAOD::IParticle::FourMom_t jet4mom=theJet->p4();
     std::vector<const xAOD::IParticle*> assoc_clusters;
     //only use jet constituents
     if(m_excludeConstituents) assoc_clusters=theJet->getConstituents().asIParticleVector();
     else
     {
       if(! (theJet->getAssociatedObjects<xAOD::IParticle>(m_associationKey, assoc_clusters)) )
       {
         //this should only happen if SOME of the jets in the collection are missing the association
         //technically possible, but should NOT happen
         ATH_MSG_ERROR("Individual jet missing association " << m_associationKey);
         return StatusCode::FAILURE;
       }
     }
     ATH_MSG_DEBUG( "Jet " << std::setw(10) << jet4mom.Pt()*1e-3
            << std::setw(10) << jet4mom.Eta()
            << std::setw(10) << jet4mom.Phi()
            << std::setw(10) << jet4mom.E()*1e-3
            << std::setw(25) << " has " << assoc_clusters.size() << " assoc. clusters");
  
     for(auto & assoc_cluster : assoc_clusters)
     {
       if( jet4mom.DeltaR( assoc_cluster->p4() ) >  m_excludeDR ) continue;
       const xAOD::CaloCluster* cl_ptr=static_cast<const xAOD::CaloCluster*>(assoc_cluster);
       unsigned int tower_index=HI::TowerBins::findEtaPhiBin(cl_ptr->eta0(),cl_ptr->phi0());
  
       if(used_indices.insert(tower_index).second)
       {
         particleList.push_back(cl_ptr);
         used_eta_bins.insert(HI::TowerBins::findBinEta(cl_ptr->eta0()));
       }
     }
   }
   return StatusCode::SUCCESS;
  
 }

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

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, top::TopObjectSelection, 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;
    }

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

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

◆ remodulate()

StatusCode HIEventShapeJetIteration::remodulate	(	xAOD::HIEventShapeContainer *	output_shape,
		const xAOD::HIEventShape *	ms,
		const std::set< unsigned int > &	used_indices
	)		const

Definition at line 269 of file HIEventShapeJetIteration.cxx.

 {
   std::vector<float> mod_factors(HI::TowerBins::numEtaBins(),0);
   std::vector<float> mod_counts(HI::TowerBins::numEtaBins(),0);
  
   for(unsigned int used_indice : used_indices)
   {
     unsigned int phi_bin=used_indice % HI::TowerBins::numPhiBins();
     unsigned int eta_bin=used_indice / HI::TowerBins::numPhiBins();
     mod_counts[eta_bin]++;
     mod_factors[eta_bin]+=(m_modulatorTool->getModulation(HI::TowerBins::getBinCenterPhi(phi_bin),ms)-1.);
   }
   double nphibins=HI::TowerBins::numPhiBins();
   //now loop on shape and correct;
   for(auto && i : *output_shape)
   {
     xAOD::HIEventShape* s=i;
     float eta0=0.5*(s->etaMin()+s->etaMax());
     unsigned int eb=HI::TowerBins::findBinEta(eta0);
     double neff=nphibins-mod_counts[eb];
     double cf=1;
     if (neff-mod_factors[eb] != 0) {//PEF fix
       cf=neff/(neff-mod_factors[eb]);
     }
     //check on value of cf;
     if(cf < 0.) cf =1;
     if(cf > 2.) cf=2;
  
     s->setEt(s->et()*cf);
     s->setRho(s->rho()*cf);
   }
  
   return StatusCode::SUCCESS;
 }

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

◆ updateShape()

void HIEventShapeJetIteration::updateShape	(	xAOD::HIEventShapeContainer *	output_shape,
		const std::vector< const xAOD::CaloCluster * > &	assoc_clusters,
		const HIEventShapeIndex *	es_index = `nullptr`
	)		const

Definition at line 183 of file HIEventShapeJetIteration.cxx.

 {
   if(es_index==nullptr)
   {
     ATH_MSG_INFO("Problem, null pointer");
  
     es_index=m_eventShapeMapTool->getIndexFromShape(output_shape);
     if(es_index==nullptr)
     {
       ATH_MSG_FATAL("Can't find correspondent index for map " << m_inputEventShapeKey.key() << " in the HIEventShapeMapTool");
     }
   }
  
   for(const auto *assoc_cluster : assoc_clusters)
   {
      m_subtractorTool->updateUsingCluster(output_shape,es_index,assoc_cluster);
   }
  
   if(!m_subtractorTool->usesCells())
   {
     for(auto s : *output_shape)
     {
       float sum_et=s->et();
       float sum_nc=0.;
       if(sum_et!=0.) sum_nc=s->rho()*s->area()/sum_et;
       s->setNCells(sum_nc);
     }
   }
 }

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

Gaudi::Property< std::string > HIEventShapeJetIteration::m_associationKey { this, "AssociationKey", "", "Name of jet attribute providing link between jets and clusters" }

private

Name of jet attribute providing link between jets and clusters.

Definition at line 64 of file HIEventShapeJetIteration.h.

◆ m_caloJetSeedKey

SG::ReadHandleKey<xAOD::JetContainer> HIEventShapeJetIteration::m_caloJetSeedKey { this, "CaloJetSeedContainerKey", "", "Names of seed collections"}

private

List of names of JetCollections, all jets in these collections are seeds.

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

Gaudi::Property< bool > HIEventShapeJetIteration::m_doRemodulation { this, "RemodulateUE", false, "Correct UE for incomplete cancellation of flow harmonics when iterating" }

private

Definition at line 70 of file HIEventShapeJetIteration.h.

◆ m_eventShapeMapTool

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

private

Definition at line 52 of file HIEventShapeJetIteration.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_excludeConstituents

Gaudi::Property< bool > HIEventShapeJetIteration::m_excludeConstituents { this, "ExcludeConstituents", false, "Only exclude constituents of jets" }

private

If selected, the jet constituents define the associated clusters.

Definition at line 68 of file HIEventShapeJetIteration.h.

◆ m_excludeDR

Gaudi::Property< float > HIEventShapeJetIteration::m_excludeDR { this, "ExclusionRadius", 0.4, "Exclude all calo regions w/in this DR to jet" }

private

All clusters w/in this DR of jet are excluded from shape calc.

Definition at line 66 of file HIEventShapeJetIteration.h.

◆ m_inputEventShapeKey

SG::ReadHandleKey<xAOD::HIEventShapeContainer> HIEventShapeJetIteration::m_inputEventShapeKey { this, "InputEventShapeKey", "HIEventShape", "HIEventShape"}

private

Name of input HIEventShapeContainer.

Definition at line 55 of file HIEventShapeJetIteration.h.

◆ m_modulationKey

SG::WriteHandleKey<xAOD::HIEventShapeContainer> HIEventShapeJetIteration::m_modulationKey { this, "ModulationEventShapeKey", "HIEventShape_itr_mod", "Modulation Event Shape Key"}

private

Definition at line 74 of file HIEventShapeJetIteration.h.

◆ m_modulationScheme

Gaudi::Property< unsigned int > HIEventShapeJetIteration::m_modulationScheme { this, "ModulationScheme", 0, "Scheme to build separate ES object for flow modulation" }

private

Definition at line 72 of file HIEventShapeJetIteration.h.

◆ m_modulatorTool

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

private

Definition at line 51 of file HIEventShapeJetIteration.h.

◆ m_outputEventShapeKey

SG::WriteHandleKey<xAOD::HIEventShapeContainer> HIEventShapeJetIteration::m_outputEventShapeKey { this, "OutputEventShapeKey", "HIEventShape_iter", "HIEventShape_iter"}

private

Name of output HIEventShapeContainer.

Definition at line 57 of file HIEventShapeJetIteration.h.

◆ m_shallowCopy

Gaudi::Property< bool > HIEventShapeJetIteration::m_shallowCopy { this, "ShallowCopy", true, "Use shallow copy for iterated event shape" }

private

Definition at line 76 of file HIEventShapeJetIteration.h.

◆ m_subtractorTool

ToolHandle<IHISubtractorTool> HIEventShapeJetIteration::m_subtractorTool { this, "Subtractor", "HIJetClusterSubtractorTool", "Handle to HIJetClusterSubtractorTool" }

private

Definition at line 50 of file HIEventShapeJetIteration.h.

◆ m_trackJetSeedKey

SG::ReadHandleKey<xAOD::JetContainer> HIEventShapeJetIteration::m_trackJetSeedKey { this, "TrackJetSeedContainerKey", "", "Names of seed collections"}

private

Definition at line 61 of file HIEventShapeJetIteration.h.

◆ 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

◆ HIEventShapeJetIteration()

Member Function Documentation

◆ ASG_TOOL_CLASS()

◆ 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()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ fillModulatorShape()

◆ getKey()

◆ getName()

◆ getProperty()

◆ getShapes()

◆ initialize()

◆ inputContainerNames()

◆ inputHandles()

◆ makeClusterList() [1/3]

◆ makeClusterList() [2/3]

◆ makeClusterList() [3/3]

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputContainerNames()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ remodulate()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateShape()

◆ updateVHKA()

Member Data Documentation

◆ m_associationKey

◆ m_caloJetSeedKey

◆ m_detStore

◆ m_doRemodulation

◆ m_eventShapeMapTool

◆ m_evtStore

◆ m_excludeConstituents

◆ m_excludeDR

◆ m_inputEventShapeKey

◆ m_modulationKey

◆ m_modulationScheme

◆ m_modulatorTool

◆ m_outputEventShapeKey

◆ m_shallowCopy

◆ m_subtractorTool

◆ m_trackJetSeedKey

◆ m_varHandleArraysDeclared

◆ m_vhka