#include <JetClusterer.h>

Inheritance diagram for JetClusterer:

Collaboration diagram for JetClusterer:

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

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

std::pair< std::unique_ptr< xAOD::JetContainer >, std::unique_ptr< SG::IAuxStore > >	getJets () const override
	Return the final jets with their aux store. 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

StatusCode	getAndRecordJets (SG::WriteHandle< xAOD::JetContainer > &jetHandle) const
	Method to allow the client to pass in a WriteHandle for the container and aux container to be recorded, while the client remains free to modify the output but does not need to know the type of the aux container. More...

virtual StatusCode	initWithOutput (const SG::WriteHandleKey< xAOD::JetContainer > &)
	Method to allow the client to pass in a WriteHandle during initialisation, in case this is needed for anything... More...

Protected Member Functions
fastjet::AreaDefinition	buildAreaDefinition (bool &seedsok) const
	Build the area definition when running with area calculation. The seedsok flag is set to false when error occurs when retrieving event/run number to initiate the seeds. More...

std::unique_ptr< fastjet::ClusterSequence >	buildClusterSequence (const PseudoJetVector *pseudoJetvector) const
	Used to create the cluster sequence. More...

void	processPseudoJet (const fastjet::PseudoJet &pj, const PseudoJetContainer &pjCont, xAOD::JetContainer jets, const xAOD::Vertex vertex) const
	translate to xAOD::Jet More...

bool	isVariableR () const

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

Protected Attributes
SG::ReadHandleKey< xAOD::EventInfo >	m_eventinfokey {"EventInfo"}
	Handle to EventInfo. This is used to get the evt&run number to set the Ghost area random seeds. More...

SG::ReadHandleKey< PseudoJetContainer >	m_inputPseudoJets {this, "InputPseudoJets", "inputpseudojet", "input constituents"}
	Handle Input PseudoJetContainer. More...

SG::WriteHandleKey< PseudoJetVector >	m_finalPseudoJets {this, "FinalPseudoJets_DONOTSET", "", "output pseudojets -- autoconfigured name"}
	used to build the key under which the final PJ will be stored in evtStore() More...

SG::WriteHandleKey< jet::ClusterSequence >	m_clusterSequence {this, "ClusterSequence_DONOTSET", "", "output pseudojets -- autoconfigured name"}

Gaudi::Property< std::string >	m_jetRank {this, "jetRankName", "jetRank", "name for accessor for jet rank"}

Gaudi::Property< std::string >	m_jetalg {this, "JetAlgorithm", "AntiKt", "alg type : AntiKt, Kt, CA..."}

Gaudi::Property< float >	m_jetrad {this, "JetRadius", 0.4 , "jet size parameter"}

Gaudi::Property< float >	m_ptmin {this, "PtMin", 0.0, "pT min in MeV"}

Gaudi::Property< float >	m_ghostarea {this, "GhostArea", 0.0, "Area for ghosts. 0==>no ghosts."}

Gaudi::Property< int >	m_ranopt {this, "RandomOption", 1, "Rand option: 0=fj default, 1=run/event"}

Gaudi::Property< int >	m_inputType {this, "JetInputType", 0, "input type as in xAOD::JetInput (see xAODJet/JetContainerInfo.h)"}

fastjet::JetAlgorithm	m_fjalg

bool	m_useArea

Gaudi::Property< float >	m_minrad {this, "VariableRMinRadius", -1.0, "Variable-R min radius" }

Gaudi::Property< float >	m_massscale {this, "VariableRMassScale", -1.0, "Variable-R mass scale" }

bool	m_isVariableR

SG::AuxElement::Accessor< int >	m_jetRankAccessor

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
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 43 of file JetClusterer.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

◆ JetClusterer()

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

inline

Definition at line 60 of file JetClusterer.h.

63 :

64

Member Function Documentation

◆ buildAreaDefinition()

fastjet::AreaDefinition JetClusterer::buildAreaDefinition ( bool & seedsok ) const

protected

Build the area definition when running with area calculation. The seedsok flag is set to false when error occurs when retrieving event/run number to initiate the seeds.

Definition at line 271 of file JetClusterer.cxx.

 {
  
   fastjet::GhostedAreaSpec gspec(5.0, 1, m_ghostarea);
   seedsok = true;
   std::vector<int> seeds;
  
   if (m_ranopt == 1)
   {
     // Use run/event number as random number seeds.
     auto evtInfoHandle = SG::makeHandle(m_eventinfokey);
     if (!evtInfoHandle.isValid())
     {
       ATH_MSG_ERROR("Unable to retrieve event info");
       seedsok = false;
       return {};
     }
  
     JetClustererHelper::seedsFromEventInfo(evtInfoHandle.cptr(), seeds);
   }
  
   ATH_MSG_DEBUG("Active area specs:");
   ATH_MSG_DEBUG("  Requested ghost area: " << m_ghostarea);
   ATH_MSG_DEBUG("     Actual ghost area: " << gspec.actual_ghost_area());
   ATH_MSG_DEBUG("               Max eta: " << gspec.ghost_etamax());
   ATH_MSG_DEBUG("              # ghosts: " << gspec.n_ghosts());
   ATH_MSG_DEBUG("       # rapidity bins: " << gspec.nrap());
   ATH_MSG_DEBUG("            # phi bins: " << gspec.nphi());
  
   if (seeds.size() == 2)
   {
     ATH_MSG_DEBUG("          Random seeds: " << seeds[0] << ", " << seeds[1]);
   }
   else
   {
     ATH_MSG_WARNING("Random generator size is not 2: " << seeds.size());
     ATH_MSG_DEBUG("          Random seeds: ");
     for (auto seed : seeds)
       ATH_MSG_DEBUG("                 " << seed);
   }
  
   // We use with_fixed_seed() as recommended for thread safety in
   // fastjet 3.4.0.
   return fastjet::AreaDefinition(fastjet::active_area,
                                  gspec)
       .with_fixed_seed(seeds);
 }

◆ buildClusterSequence()

std::unique_ptr< fastjet::ClusterSequence > JetClusterer::buildClusterSequence ( const PseudoJetVector * pseudoJetvector ) const

protected

Used to create the cluster sequence.

Definition at line 91 of file JetClusterer.cxx.

 {
  
   fastjet::JetDefinition jetdef(m_fjalg, m_jetrad);
   using fastjet::contrib::VariableRPlugin;
   std::unique_ptr<VariableRPlugin> VRJetPlugin(nullptr);
  
   if (m_isVariableR)
   {
     /* clustering algorithm
      * They correspond to p parameter of Sequential recombination algs
      * AKTLIKE = -1, CALIKE = 0, KTLIKE = 1
      */
     VariableRPlugin::ClusterType VRClusterType = VariableRPlugin::AKTLIKE;
     switch (m_fjalg)
     {
     case fastjet::kt_algorithm:
       VRClusterType = VariableRPlugin::KTLIKE;
       break;
     case fastjet::antikt_algorithm:
       VRClusterType = VariableRPlugin::AKTLIKE;
       break;
     case fastjet::cambridge_algorithm:
       VRClusterType = VariableRPlugin::CALIKE;
       break;
     default:
       ATH_MSG_ERROR("Unsupported clustering algorithm for Variable-R jet finding.");
       return nullptr;
     }
     VRJetPlugin = std::make_unique<VariableRPlugin>(m_massscale, m_minrad, m_jetrad, VRClusterType, false);
     jetdef = fastjet::JetDefinition(VRJetPlugin.get());
   }
  
   std::unique_ptr<fastjet::ClusterSequence> clSequence(nullptr);
  
   if (m_useArea)
   {
     // Prepare ghost area specifications -------------
     ATH_MSG_DEBUG("Creating input area cluster sequence");
     bool seedsok = true;
     fastjet::AreaDefinition adef = buildAreaDefinition(seedsok);
  
     if (seedsok)
     {
       clSequence = std::make_unique<fastjet::ClusterSequenceArea>(*pseudoJetVector, jetdef, adef);
     }
     else
     {
       return nullptr;
     }
   }
   else
   {
     ATH_MSG_DEBUG("Creating input cluster sequence");
     clSequence = std::make_unique<fastjet::ClusterSequence>(*pseudoJetVector, jetdef);
   }
  
   return clSequence;
 }

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

◆ 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

◆ getAndRecordJets()

StatusCode JetProvider< xAOD::JetAuxContainer >::getAndRecordJets ( SG::WriteHandle< xAOD::JetContainer > & jetHandle ) const

inlinevirtualinherited

Method to allow the client to pass in a WriteHandle for the container and aux container to be recorded, while the client remains free to modify the output but does not need to know the type of the aux container.

Every class derived from IJetProvider needs to implement the record, providing the explicit type – we should give StoreGate maximal information rather than recording AuxContainerBase

The recommended solution is for the concrete tool to inherit from the templated JetProvider class provided below.

Implements IJetProvider.

Definition at line 81 of file IJetProvider.h.

                                                                                 {
     std::unique_ptr<xAOD::JetContainer> jets(nullptr);
     std::unique_ptr<SG::IAuxStore> auxCont(nullptr);
     std::tie(jets, auxCont) = getJets();
     if(jets.get()==nullptr || auxCont.get()==nullptr) {return StatusCode::FAILURE;}
  
     // Convert the aux container pointer to the known base class
     std::unique_ptr<CONCRETEAUX> auxCont_derived(static_cast<CONCRETEAUX*>(auxCont.release()));
  
     // Write out JetContainer and JetAuxContainer
     return jetHandle.record(std::move(jets), std::move(auxCont_derived));
   }

◆ getJets()

std::pair< std::unique_ptr< xAOD::JetContainer >, std::unique_ptr< SG::IAuxStore > > JetClusterer::getJets ( ) const

overridevirtual

Return the final jets with their aux store.

Can return a pair of null pointers if an error occurs.

Implements IJetProvider.

Reimplemented in JetClustererByVertex.

Definition at line 192 of file JetClusterer.cxx.

 {
   // Return this in case of any problems
   auto nullreturn = std::make_pair(std::unique_ptr<xAOD::JetContainer>(nullptr), std::unique_ptr<SG::IAuxStore>(nullptr));
  
   // -----------------------
   // retrieve input
   SG::ReadHandle<PseudoJetContainer> pjContHandle(m_inputPseudoJets);
   if (!pjContHandle.isValid())
   {
     ATH_MSG_ERROR("No valid PseudoJetContainer with key " << m_inputPseudoJets.key());
     return nullreturn;
   }
  
   // Build the container to be returned
   // Avoid memory leaks with unique_ptr
   auto jets = std::make_unique<xAOD::JetContainer>();
   auto auxCont = std::make_unique<xAOD::JetAuxContainer>();
   jets->setStore(auxCont.get());
  
   const PseudoJetVector *pseudoJetVector = pjContHandle->casVectorPseudoJet();
   ATH_MSG_DEBUG("Pseudojet input container has size " << pseudoJetVector->size());
  
   std::unique_ptr<fastjet::ClusterSequence> clSequence = buildClusterSequence(pseudoJetVector);
  
   if (!clSequence)
     return nullreturn;
  
   // -----------------------
   // Build a new pointer to a PseudoJetVector containing the final PseudoJet
   // This allows us to own the vector of PseudoJet which we will put in the evt store.
   // Thus the contained PseudoJet will be kept frozen there and we can safely use pointer to them from the xAOD::Jet objects
   auto pjVector = std::make_unique<PseudoJetVector>(fastjet::sorted_by_pt(clSequence->inclusive_jets(m_ptmin)));
   ATH_MSG_DEBUG("Found jet count: " << pjVector->size());
   if (msgLvl(MSG::VERBOSE))
   {
     for (const auto &pj : *pjVector)
     {
       msg() << "  Pseudojet with pt " << std::setprecision(4) << pj.Et() * 1e-3 << " has " << pj.constituents().size() << " constituents" << endmsg;
     }
   }
  
   // No PseudoJets, so there's nothing else to do
   // Delete the cluster sequence before we go
   if (!pjVector->empty())
   {
  
     for (const fastjet::PseudoJet &pj : *pjVector)
     {
       processPseudoJet(pj, *pjContHandle, jets.get(), nullptr);
       // we want the rank to start with zero, but this is after the
       // jet has been added, thus the "size() - 1" here.
       m_jetRankAccessor(*jets.get()->back()) = jets->size() - 1;
     }
  
     // -------------------------------------
     // record final PseudoJetVector
     SG::WriteHandle<PseudoJetVector> pjVectorHandle(m_finalPseudoJets);
     if (!pjVectorHandle.record(std::move(pjVector)))
     {
       ATH_MSG_ERROR("Can't record PseudoJetVector under key " << m_finalPseudoJets);
       return nullreturn;
     }
     // -------------------------------------
     // record ClusterSequence
     SG::WriteHandle<jet::ClusterSequence> clusterSeqHandle(m_clusterSequence);
     if (!clusterSeqHandle.record(std::move(clSequence)))
     {
       ATH_MSG_ERROR("Can't record ClusterSequence under key " << m_clusterSequence);
       return nullreturn;
     }
   }
  
   ATH_MSG_DEBUG("Reconstructed jet count: " << jets->size() << "  clusterseq=" << clSequence.get());
   // Return the jet container and aux, use move to transfer
   // ownership of pointers to caller
   return std::make_pair(std::move(jets), std::move(auxCont));
 }

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

Reimplemented in JetClustererByVertex.

Definition at line 44 of file JetClusterer.cxx.

 {
  
   ATH_MSG_DEBUG("Initializing...");
   xAOD::JetAlgorithmType::ID ialg = xAOD::JetAlgorithmType::algId(m_jetalg);
   m_fjalg = xAOD::JetAlgorithmType::fastJetDef(ialg);
   if (m_fjalg == fastjet::undefined_jet_algorithm)
   {
     ATH_MSG_ERROR("Invalid jet algorithm name: " << m_jetalg);
     ATH_MSG_ERROR("Allowed values are Kt, CamKt, AntiKt, etc.");
     return StatusCode::FAILURE;
   }
   if (m_jetrad <= 0)
   {
     ATH_MSG_ERROR("Invalid jet size parameter: " << m_jetrad);
     return StatusCode::FAILURE;
   }
  
   // buld an empty ClusterSequence, just for the fastjet splash screen to appear during initialization (?)
   fastjet::JetDefinition jetdef(m_fjalg, m_jetrad);
   m_useArea = m_ghostarea > 0;
  
   PseudoJetVector empty;
   fastjet::ClusterSequence cs(empty, jetdef);
   cs.inclusive_jets(m_ptmin);
   m_isVariableR = m_minrad >= 0.0 && m_massscale >= 0.0;
  
   // Input DataHandles
   if (!m_finalPseudoJets.empty())
   {
     ATH_MSG_WARNING("A non-empty value was found for the FinalPseudoJets WriteHandleKey -- this will be ignored!");
   }
  
   ATH_CHECK(m_eventinfokey.initialize());
   ATH_CHECK(m_inputPseudoJets.initialize());
   m_finalPseudoJets = name() + "FinalPJ";
   ATH_CHECK(m_finalPseudoJets.initialize());
   m_clusterSequence = name() + "ClusterSequence";
   ATH_CHECK(m_clusterSequence.initialize());
  
   m_jetRankAccessor = SG::AuxElement::Accessor<int>(m_jetRank);
  
   return StatusCode::SUCCESS;
 }

◆ initWithOutput()

virtual StatusCode IJetProvider::initWithOutput ( const SG::WriteHandleKey< xAOD::JetContainer > & )

inlinevirtualinherited

Method to allow the client to pass in a WriteHandle during initialisation, in case this is needed for anything...

The main (only?) use case is for copying jets, and propagating any decorations already on the original to the copy in StoreGate

Quietly return success in the general case – the JetRecAlg will always call this, so as to remain agnostic as to the concrete type.

Reimplemented in JetCopier.

Definition at line 65 of file IJetProvider.h.

65 {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.

◆ isVariableR()

bool JetClusterer::isVariableR ( ) const

inlineprotected

Definition at line 111 of file JetClusterer.h.

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

◆ processPseudoJet()

void JetClusterer::processPseudoJet	(	const fastjet::PseudoJet &	pj,
		const PseudoJetContainer &	pjCont,
		xAOD::JetContainer *	jets,
		const xAOD::Vertex *	vertex
	)		const

protected

translate to xAOD::Jet

Definition at line 151 of file JetClusterer.cxx.

 {
  
   // -------------------------------------
   // translate to xAOD::Jet
   ATH_MSG_DEBUG("Converting pseudojets to xAOD::Jet");
   static const SG::AuxElement::Accessor<const fastjet::PseudoJet *> pjAccessor("PseudoJet");
   PseudoJetTranslator pjTranslator(m_useArea, m_useArea);
  
   // create the xAOD::Jet from the PseudoJet, doing the signal &  constituents extraction
   xAOD::Jet &jet = pjTranslator.translate(pj, pjCont, *jets, originVertex);
  
   // Add the PseudoJet onto the xAOD jet. Maybe we should do it in the above JetFromPseudojet call ??
   pjAccessor(jet) = &pj;
  
   jet.setInputType(xAOD::JetInput::Type(m_inputType.value()));
   xAOD::JetAlgorithmType::ID ialg = xAOD::JetAlgorithmType::algId(m_fjalg);
   jet.setAlgorithmType(ialg);
   jet.setSizeParameter(m_jetrad.value());
   if (m_isVariableR)
   {
     jet.setAttribute(xAOD::JetAttribute::VariableRMinRadius, m_minrad.value());
     jet.setAttribute(xAOD::JetAttribute::VariableRMassScale, m_massscale.value());
   }
   if (m_useArea)
     jet.setAttribute(xAOD::JetAttribute::JetGhostArea, m_ghostarea.value());
  
   ATH_MSG_VERBOSE("  xAOD::Jet with pt " << std::setprecision(4) << jet.pt() * 1e-3 << " has " << jet.getConstituents().size() << " constituents");
   ATH_MSG_VERBOSE("  Leading constituent is of type " << jet.getConstituents()[0].rawConstituent()->type());
  
   // Perhaps better to make configurable
   if (originVertex)
   {
     jet.setAssociatedObject("OriginVertex", originVertex);
   }
   else
   {
     ATH_MSG_VERBOSE("Could not set OriginVertex for jet!");
   }
 }

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

SG::WriteHandleKey<jet::ClusterSequence> JetClusterer::m_clusterSequence {this, "ClusterSequence_DONOTSET", "", "output pseudojets -- autoconfigured name"}

protected

Definition at line 91 of file JetClusterer.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_eventinfokey

SG::ReadHandleKey<xAOD::EventInfo> JetClusterer::m_eventinfokey {"EventInfo"}

protected

Handle to EventInfo. This is used to get the evt&run number to set the Ghost area random seeds.

Definition at line 84 of file JetClusterer.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_finalPseudoJets

SG::WriteHandleKey<PseudoJetVector> JetClusterer::m_finalPseudoJets {this, "FinalPseudoJets_DONOTSET", "", "output pseudojets -- autoconfigured name"}

protected

used to build the key under which the final PJ will be stored in evtStore()

Definition at line 90 of file JetClusterer.h.

◆ m_fjalg

fastjet::JetAlgorithm JetClusterer::m_fjalg

protected

Definition at line 105 of file JetClusterer.h.

◆ m_ghostarea

Gaudi::Property<float> JetClusterer::m_ghostarea {this, "GhostArea", 0.0, "Area for ghosts. 0==>no ghosts."}

protected

Definition at line 98 of file JetClusterer.h.

◆ m_inputPseudoJets

SG::ReadHandleKey<PseudoJetContainer> JetClusterer::m_inputPseudoJets {this, "InputPseudoJets", "inputpseudojet", "input constituents"}

protected

Handle Input PseudoJetContainer.

Definition at line 87 of file JetClusterer.h.

◆ m_inputType

Gaudi::Property<int> JetClusterer::m_inputType {this, "JetInputType", 0, "input type as in xAOD::JetInput (see xAODJet/JetContainerInfo.h)"}

protected

Definition at line 101 of file JetClusterer.h.

◆ m_isVariableR

bool JetClusterer::m_isVariableR

protected

Definition at line 110 of file JetClusterer.h.

◆ m_jetalg

Gaudi::Property<std::string> JetClusterer::m_jetalg {this, "JetAlgorithm", "AntiKt", "alg type : AntiKt, Kt, CA..."}

protected

Definition at line 95 of file JetClusterer.h.

◆ m_jetrad

Gaudi::Property<float> JetClusterer::m_jetrad {this, "JetRadius", 0.4 , "jet size parameter"}

protected

Definition at line 96 of file JetClusterer.h.

◆ m_jetRank

Gaudi::Property<std::string> JetClusterer::m_jetRank {this, "jetRankName", "jetRank", "name for accessor for jet rank"}

protected

Definition at line 92 of file JetClusterer.h.

◆ m_jetRankAccessor

SG::AuxElement::Accessor<int> JetClusterer::m_jetRankAccessor

protected

Definition at line 113 of file JetClusterer.h.

◆ m_massscale

Gaudi::Property<float> JetClusterer::m_massscale {this, "VariableRMassScale", -1.0, "Variable-R mass scale" }

protected

Definition at line 109 of file JetClusterer.h.

◆ m_minrad

Gaudi::Property<float> JetClusterer::m_minrad {this, "VariableRMinRadius", -1.0, "Variable-R min radius" }

protected

Definition at line 108 of file JetClusterer.h.

◆ m_ptmin

Gaudi::Property<float> JetClusterer::m_ptmin {this, "PtMin", 0.0, "pT min in MeV"}

protected

Definition at line 97 of file JetClusterer.h.

◆ m_ranopt

Gaudi::Property<int> JetClusterer::m_ranopt {this, "RandomOption", 1, "Rand option: 0=fj default, 1=run/event"}

protected

Definition at line 99 of file JetClusterer.h.

◆ m_useArea

bool JetClusterer::m_useArea

protected

Definition at line 106 of file JetClusterer.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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetClusterer()

Member Function Documentation

◆ buildAreaDefinition()

◆ buildClusterSequence()

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

◆ extraDeps_update_handler()

◆ getAndRecordJets()

◆ getJets()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ initWithOutput()

◆ inputHandles()

◆ isVariableR()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ processPseudoJet()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_clusterSequence

◆ m_detStore

◆ m_eventinfokey

◆ m_evtStore

◆ m_finalPseudoJets

◆ m_fjalg

◆ m_ghostarea

◆ m_inputPseudoJets

◆ m_inputType

◆ m_isVariableR

◆ m_jetalg

◆ m_jetrad

◆ m_jetRank

◆ m_jetRankAccessor

◆ m_massscale

◆ m_minrad

◆ m_ptmin

◆ m_ranopt

◆ m_useArea

◆ m_varHandleArraysDeclared

◆ m_vhka