#include <JetIsolationTool.h>

Inheritance diagram for JetIsolationTool:

Collaboration diagram for JetIsolationTool:

Public Member Functions
	JetIsolationTool (const std::string &myname)
	Ctor. More...

virtual	~JetIsolationTool ()
	Dtor. More...

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

virtual StatusCode	finalize () override

virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate a jet collection without otherwise modifying it. 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

virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier. 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
Gaudi::Property< std::vector< std::string > >	m_isolationCodes {this, "IsolationCalculations", {}, "Isolation calculations to be performed"}

Gaudi::Property< std::string >	m_jetContainerName {this, "JetContainer", "", "SG key for the input jet container"}

SG::ReadHandleKey< xAOD::IParticleContainer >	m_inputConstitKey {this, "InputConstitContainer", "", "Constituent container to read (should be configured automatically from a JetDefinition)"}

SG::WriteDecorHandleKeyArray< xAOD::JetContainer >	m_decorKeys {this, "DecorationKeys", {}, "SG key for output momentum decoration (not to be configured manually!)"}

SG::ReadHandleKey< xAOD::EventShape >	m_rhoKey {this, "RhoKey", "", "EventDensity for this jet collection. Required only if PtPUsub calculation is done"}

std::vector< jet::JetIsolation::IsolationCalculator * >	m_isoCalculators
	the list of isolation calculation objects (they are actually used only as template objects from which the actual calculators are build More...

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

Friends
class	jet::JetIsolation::IsolationCalculator

Detailed Description

Calculate isolation variables for jets and set them as jet attributes.

Properties: IsolationCalculations: List of calculations to perform (see below) InputConstitContainer: name of the jet constituents container RhoKey: EventDensity key. Required in case the PtPUsub calculation is performed.

The isolation variables are calculated from a list of input constituents. which are close to the jet but not part of its constituents. There are multiple options to find this list and then to calculate the
variables. They are passed to the tools by giving a list of string identifiers through the IsolationCalculations property as in

IsolationCalculations = ["IsoKR:11:Perp","IsoKR:11:Par", "IsoFixedCone:10:SumPt",]

where the strings have the form "ISOCRITERIA:NN:VAR"

ISOCRITERIA : encode the method used to find isolation particles (IsoKR, IsoDelta, IsoFixedCone, IsoFixedArea, Iso6To8, signification detailed below)
NN : encode the value of the main parameter of ISOCRITERIA : the actual parameter used is NN/10. (same convetion as jet radius in JetContainer names)
VAR : encode the variable to be calculated (Per, Par, SumPt, P, significations detailed below)

The resulting attribute name is simply the identifier string with ':' removed. Example "IsoKR:11:Perp" -> "IsoKR11Perp"

The input particles container from which constituents come from must be specified in the ConstituentContainer property. This must correspond to an IParticleContainer in the event store. (longer term : make it possible to pass PseudoJetContainer)

Because of the multiplicity of possible isolation and calculation choices, the internal code is modularized. The code is potentially slow (~O(Nconstit x Njet x Nisovariable)) and could be improved if needed by using fast look-up map and/or preselecting constituents.

WARNING: The constituents must be the same in-memory objects as the jet constituents.

Isolation Criteria ("param" below is the main parameter) :

IsoKR : iso area == cone of size jetRadius*param
IsoDelta : iso area == cone of size jetRadius+param
IsoFixedCone : iso are == cone of size param
IsoFixedArea : iso are == cone of size sqrt(jetRadius*jetRadius+param/M_PI)
Iso6To8 : iso area == annulus between R=0.6 and R=0.8

Isolation Variables (iso4vec = sum of 4-vec in isolation area, not part of jet)

Pt : iso4vec.Pt/ jetPt
PtPUsub : (iso4vec.Pt-rho*isoArea)/ (jetPt - rho*jetArea)
Perp : iso4Vec.Perp( jetDirection )/ jetPt
Par : iso4Vec.Dot( jetDirection )/ jetPt
SumPt : sum Pt of 4-vec contibuting to iso4Vec / jetPt
P : iso4Vec.Vect().Mag()/ jetPt

Definition at line 92 of file JetIsolationTool.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

◆ JetIsolationTool()

JetIsolationTool::JetIsolationTool ( const std::string & myname )

Ctor.

Definition at line 257 of file JetIsolationTool.cxx.

   : asg::AsgTool(name) {
   declareInterface<IJetDecorator>(this);
 }

◆ ~JetIsolationTool()

JetIsolationTool::~JetIsolationTool ( )

virtualdefault

Dtor.

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

◆ decorate()

StatusCode JetIsolationTool::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 346 of file JetIsolationTool.cxx.

                                                                         {
  
   
   ATH_MSG_DEBUG("Modifying jets in container with size " << jets.size());
   if ( jets.empty() ) return StatusCode::SUCCESS;
  
   // Fetch the input pseudojets.
   auto inputConstits = SG::makeHandle(m_inputConstitKey);
   ATH_MSG_DEBUG("Retrieved input count is " << inputConstits->size());
  
   // adapt the calculators to these jets (radius, input type, etc...)
   // Since we're in a const method, we must create a copy of the calculators we own.
   // We use the 1st jet, assuming all others in the container are similar.
   std::vector<IsolationCalculator*> calculators; // the adapted calculators.
   for( const IsolationCalculator * calc : m_isoCalculators ){
     IsolationCalculator * cloned = calc->clone( jets[0] );
     cloned->setEventDensity(0);
     calculators.push_back( cloned );
   }
  
   // Retrieve and set EventDensity if needed
   if(!m_rhoKey.empty()){
     double rho=0;
     SG::ReadHandle<xAOD::EventShape> rhRhoKey(m_rhoKey);
     if (! rhRhoKey->getDensity( xAOD::EventShape::Density, rho ) ) {
       ATH_MSG_FATAL("Could not retrieve xAOD::EventShape::Density from xAOD::EventShape "<< m_rhoKey.key());
       return StatusCode::FAILURE;
     }
     ATH_MSG_DEBUG("Rho = "<< rho);
     for(  IsolationCalculator * calc : calculators ) calc->setEventDensity(rho);
   }
  
   // This will hold  all the constituents around a jet which are not constituents of the jet
   std::vector<const xAOD::IParticle*> nearbyC;
   nearbyC.reserve( inputConstits->size() ); 
   const static SG::AuxElement::ConstAccessor<char> PVMatchedAcc("matchedToPV");
   // Loop over jets in this collection.
   for (const xAOD::Jet* jet : jets ) {
  
     nearbyC.clear();
     size_t nRejected=0;
     const std::vector< ElementLink< xAOD::IParticleContainer > >& constitEL = jet->constituentLinks();
  
     // Fill nearbyC: for now we take ALL constituents  which not constituents of the jet.
     //  this is a lot and it may render subsequent iso calculation slower. If so it
     // could be useful to use a fast look-up map to preselect constituents close to the jet (ex: within 2*jetRadius)
     for(const xAOD::IParticle *part: (*inputConstits)){
       if((part->e()<=0) || ( PVMatchedAcc.isAvailable(*part) && !PVMatchedAcc(*part) )){
     nRejected++;
     continue;
       }
       bool found = std::any_of(constitEL.begin(), constitEL.end(), [&part](const auto& link) { return part == *link; });
       if(!found){
     nearbyC.push_back(part);    
       }      
     }
     if ( (nearbyC.size() + jet->numConstituents()+nRejected) != inputConstits->size() ) {
       ATH_MSG_WARNING("Inconsistent number of jet constituents found in jet.");
     }
  
     ATH_MSG_DEBUG(jet->index()<< "  # outside jet: " << nearbyC.size() << ", # rejected :"<< nRejected
           << ", in jet: "<< jet->numConstituents()
           << ", total: "<< inputConstits->size() );
               
     
     // loop over calculators, calculate isolation given the close-by particles not part of the jet.
     int c=0;
     for(auto * isoCalc:calculators){
       // perform all calculations with this isoCalc
       std::vector<float> results = isoCalc->calcIsolationVariables(jet, nearbyC);
       // decorate the jet with the calculated values
       for( float value: results ) {
     SG::WriteDecorHandle<xAOD::JetContainer, float> decorHandle(m_decorKeys[c++]);
     ATH_MSG_DEBUG(" decor "<< decorHandle.decorKey()  << "  " << value << "  "<<c);
     decorHandle(*jet) = value;
       }
     }    
   }
  
   // clear calculators :
   for ( IsolationCalculator* calc : calculators ) {
     delete calc;
   }
  
   ATH_MSG_DEBUG("done");
   return StatusCode::SUCCESS;
 }

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

◆ 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 JetIsolationTool::finalize ( )

overridevirtual

Definition at line 437 of file JetIsolationTool.cxx.

                                       {
   ATH_MSG_DEBUG ("Finalizing " << name() << "...");
   for( size_t i=0;i<m_isoCalculators.size(); i++){
     delete m_isoCalculators[i];
   }
   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.

◆ initialize()

StatusCode JetIsolationTool::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 268 of file JetIsolationTool.cxx.

                                         {
   ATH_MSG_DEBUG ("Initializing " << name() << "...");
  
   // a temporary map of isolation calculator
   std::map<string, IsolationCalculator*> calcMap;
  
   size_t nmom = m_isolationCodes.size();
   // decode each isolation calculations as entered by properties
   for ( size_t i=0; i<nmom; ++i ) {
     string isocriteria, param_s, kinematic;
     // decode the string passed as a property :
     jet::colonSplit(m_isolationCodes[i], isocriteria, param_s, kinematic);
     if( (param_s.empty())||(kinematic.empty())) {
       ATH_MSG_ERROR(" Can't extract parameter values or kinematic code from "<<m_isolationCodes[i]);
       return StatusCode::FAILURE;
     }
     string calcId = isocriteria + param_s;
     // isocriteria + param_s defines a calculator which can then calculate several kinematics.
     // check if this (isocriteria + param_s ) calculator has already been defined. If not do it now.
     IsolationCalculator*& isoC = calcMap[calcId];
     if ( isoC == nullptr ) {
       isoC = createCalulator( isocriteria, std::stod(param_s)*0.1 );
     }
     if( isoC == nullptr ) {
       ATH_MSG_ERROR(" Unkown isolation criteria "<< isocriteria << "  from "<< m_isolationCodes[i] );
       return StatusCode::FAILURE;
     }
     // add this kinematic for this calculator 
     bool ok = isoC->scheduleKinematicCalculation( kinematic);
     if(!ok) {
       ATH_MSG_ERROR(" Unkown isolation kinematic "<< kinematic << "  from "<< m_isolationCodes[i] );
       return StatusCode::FAILURE;
     }
   }
  
   if(m_jetContainerName.empty()) {
     ATH_MSG_ERROR("JetIsolationTool needs to have its input jet container configured!");
     return StatusCode::FAILURE;
   }
   
   // Fill the iso calculator vector from the map
   // Also fill DecorHandleKeyArrays at the same time
   int ncalc=0;
   for ( const auto& pair : calcMap ){ 
     m_isoCalculators.push_back(pair.second); 
     ATH_MSG_DEBUG("Will use iso calculation : "<< pair.second->baseName() << "  and variables :" );
  
     for(const auto& kname: pair.second->calculationNames()){
       ATH_MSG_DEBUG("      -->  : "<< kname );
       m_decorKeys.push_back(std::format("{}.{}", m_jetContainerName.value(), kname));
       ncalc++;
     }
   }
  
   
   ATH_MSG_INFO("Initialized JetIsolationTool " << name());
   if ( m_inputConstitKey.empty() ) {
     ATH_MSG_ERROR("  No input pseudojet collection supplied");
     return StatusCode::FAILURE;
   } else {
     ATH_MSG_INFO("  Input pseudojet collection: " << m_inputConstitKey.key());
     ATH_CHECK(m_inputConstitKey.initialize());
   }
   ATH_MSG_INFO("  Isolation calculations: " << m_isolationCodes);
   ATH_MSG_DEBUG("Total num calculations="<<ncalc<< "  ndecorations="<<m_decorKeys.size());
   
   ATH_CHECK(m_decorKeys.initialize());
  
   if(!m_rhoKey.empty()){
     ATH_CHECK(m_rhoKey.initialize());
     ATH_MSG_INFO(" Using EventDensity from: " << m_rhoKey.key());
   }
   
   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.

◆ modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer & jets ) const

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32 {return decorate(jets);};

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

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

Friends And Related Function Documentation

◆ jet::JetIsolation::IsolationCalculator

friend class jet::JetIsolation::IsolationCalculator

friend

Definition at line 98 of file JetIsolationTool.h.

Member Data Documentation

◆ m_decorKeys

SG::WriteDecorHandleKeyArray<xAOD::JetContainer> JetIsolationTool::m_decorKeys {this, "DecorationKeys", {}, "SG key for output momentum decoration (not to be configured manually!)"}

private

Definition at line 120 of file JetIsolationTool.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_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_inputConstitKey

SG::ReadHandleKey<xAOD::IParticleContainer> JetIsolationTool::m_inputConstitKey {this, "InputConstitContainer", "", "Constituent container to read (should be configured automatically from a JetDefinition)"}

private

Definition at line 117 of file JetIsolationTool.h.

◆ m_isoCalculators

std::vector<jet::JetIsolation::IsolationCalculator*> JetIsolationTool::m_isoCalculators

private

the list of isolation calculation objects (they are actually used only as template objects from which the actual calculators are build

Definition at line 127 of file JetIsolationTool.h.

◆ m_isolationCodes

Gaudi::Property<std::vector<std::string> > JetIsolationTool::m_isolationCodes {this, "IsolationCalculations", {}, "Isolation calculations to be performed"}

private

Definition at line 114 of file JetIsolationTool.h.

◆ m_jetContainerName

Gaudi::Property<std::string> JetIsolationTool::m_jetContainerName {this, "JetContainer", "", "SG key for the input jet container"}

private

Definition at line 115 of file JetIsolationTool.h.

◆ m_rhoKey

SG::ReadHandleKey<xAOD::EventShape> JetIsolationTool::m_rhoKey {this, "RhoKey", "", "EventDensity for this jet collection. Required only if PtPUsub calculation is done"}

private

Definition at line 122 of file JetIsolationTool.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

Friends

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetIsolationTool()

◆ ~JetIsolationTool()

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]

◆ decorate()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ modify()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Friends And Related Function Documentation

◆ jet::JetIsolation::IsolationCalculator

Member Data Documentation

◆ m_decorKeys

◆ m_detStore

◆ m_evtStore

◆ m_inputConstitKey

◆ m_isoCalculators

◆ m_isolationCodes

◆ m_jetContainerName

◆ m_rhoKey

◆ m_varHandleArraysDeclared

◆ m_vhka