#include <JetFinder.h>

Inheritance diagram for JetFinder:

Collaboration diagram for JetFinder:

Public Types
typedef std::vector< std::string >	NameList
	Type for ghost labels. More...

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

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

virtual int	find (const PseudoJetContainer &cont, xAOD::JetContainer &finalJets, xAOD::JetInput::Type contype) const override
	Method to find jets from a vector of pseudojet inputs. More...

virtual int	findNoSave (const PseudoJetContainer &cont, xAOD::JetContainer &finalJets, xAOD::JetInput::Type contype, fastjet::ClusterSequence *&cs) const override

void	save (fastjet::ClusterSequence *pcs) const

bool	isVariableR () const

virtual void	print () const override
	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
int	_find (const PseudoJetContainer &cont, xAOD::JetContainer &finalJets, xAOD::JetInput::Type contype, bool doSave, fastjet::ClusterSequence *&) const

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

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

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

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

Private Attributes
SG::ReadHandleKey< xAOD::EventInfo >	m_eventinfokey {"EventInfo"}

SG::ReadHandleKey< fastjet::ClusterSequence >	m_cnameRKey

SG::WriteHandleKey< fastjet::ClusterSequence >	m_cnameWKey

std::string	m_jetalg

float	m_jetrad

float	m_minrad

float	m_massscale

float	m_ptmin

float	m_ghostarea

int	m_ranopt

ToolHandle< IJetFromPseudojet >	m_bld

fastjet::JetAlgorithm	m_fjalg

bool	m_isVariableR

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

Tool to find jets.

Parameters: JetAlgorithm - Algorithm: Kt, AntiKt, CamKt JetRadius - Size parameter (or maximum value for variable-R finding) VariableRMinRadius - Minimum radius for variable-R jet finding VariableRMassScale - Mass scale [MeV] for variable-R jet finding PtMin - PT [MeV] threshold for jet finding. GhostArea - Approximate (starting) area (dy x dphi) for ghost finding RandomOption - Option for area random seets (0=fastjet default, 1=run,event) JetBuilder - Tool used to build jets, interface IJetFromPseudojet (code now moved into this class). Jet active area is evaluated if GhostArea > 0. Variable-R jet finding is performed if VariableRMinRadius >= 0 and VariableRMassScale >= 0. Units are MeV assuming these are the input units

Definition at line 46 of file JetFinder.h.

Member Typedef Documentation

◆ NameList

typedef std::vector<std::string> IJetFinder::NameList

inherited

Type for ghost labels.

Definition at line 36 of file IJetFinder.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ JetFinder()

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

Definition at line 37 of file JetFinder.cxx.

 : AsgTool(name),
   m_bld("JetFromPseudojet",this),
   m_fjalg(fastjet::undefined_jet_algorithm),
   m_isVariableR(false) {
   declareProperty("JetAlgorithm", m_jetalg="AntiKt");
   declareProperty("JetRadius", m_jetrad =0.4);
   declareProperty("VariableRMinRadius", m_minrad =-1.0);
   declareProperty("VariableRMassScale", m_massscale =-1.0);
   declareProperty("PtMin", m_ptmin =0.0);
   declareProperty("GhostArea", m_ghostarea =0.0);
   declareProperty("RandomOption", m_ranopt =1);
   declareProperty("JetBuilder", m_bld);
 }

Member Function Documentation

◆ _find()

int JetFinder::_find	(	const PseudoJetContainer &	cont,
		xAOD::JetContainer &	finalJets,
		xAOD::JetInput::Type	contype,
		bool	doSave,
		fastjet::ClusterSequence *&	pcs
	)		const

private

Definition at line 119 of file JetFinder.cxx.

                                                          {
   if ( m_fjalg == fastjet::undefined_jet_algorithm ) {
     ATH_MSG_ERROR("Jet finder is not properly initiialized.");
     return 1;
   }
  
   const PseudoJetVector* inps = pjContainer.casVectorPseudoJet();
  
   ATH_MSG_DEBUG("Jet finding input count: " << inps->size());
   fastjet::JetDefinition jetdef(m_fjalg, m_jetrad);
 #ifndef NO_JET_VARIABLER
   const VariableRPlugin* pvrp = nullptr;
   if ( isVariableR() ) {
     VariableRPlugin::ClusterType vct = VariableRPlugin::AKTLIKE;
     switch(m_fjalg) {
     case fastjet::kt_algorithm:        vct = VariableRPlugin::KTLIKE;  break;
     case fastjet::antikt_algorithm:    vct = VariableRPlugin::AKTLIKE; break;
     case fastjet::cambridge_algorithm: vct = VariableRPlugin::CALIKE;  break;
     default:
       ATH_MSG_ERROR("Invalid algorithm type for variable-R finding.");
     }
     pvrp = new VariableRPlugin(m_massscale, m_minrad, m_jetrad, vct, false);
     jetdef = fastjet::JetDefinition(pvrp);
     jetdef.delete_plugin_when_unused ();
   }
 #else
   if ( isVariableR() ) {
     ATH_MSG_ERROR("Variable-R jet findng is not supported in theis build.");
   }
 #endif
   if ( m_ghostarea <= 0 ) {
     ATH_MSG_DEBUG("Creating input cluster sequence");
     pcs = new fastjet::ClusterSequence(*inps, jetdef);
   } else {
     fastjet::GhostedAreaSpec gspec(5.0, 1, m_ghostarea);
     std::vector<int> inseeds;
     if ( m_ranopt == 1 ) {
       // Use run/event number as random number seeds.
  
       auto handle = SG::makeHandle(m_eventinfokey);
       if (!handle.isValid()){
         ATH_MSG_ERROR("Unable to retrieve event info");
         return 1;
       }
       const xAOD::EventInfo* pevinfo = handle.cptr();
  
  
       if ( pevinfo != nullptr ) {
         auto ievt = pevinfo->eventNumber();
         auto irun = pevinfo->runNumber();
         if ( pevinfo->eventType(xAOD::EventInfo::IS_SIMULATION)) {
           // For MC, use the channel and MC event number
           ievt = pevinfo->mcEventNumber();
           irun = pevinfo->mcChannelNumber();
         }
         inseeds.push_back(ievt);
         inseeds.push_back(irun);
       } else {
         ATH_MSG_ERROR("Unable to retrieve event info");
       }
     } // if (m_ranopt==1)
     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 ( inseeds.size() == 2 ) {
       ATH_MSG_DEBUG("          Random seeds: " << inseeds[0] << ", "
                     << inseeds[1]);
     } else {
       ATH_MSG_WARNING("Random generator size is not 2: " << inseeds.size());
       ATH_MSG_DEBUG("          Random seeds: ");
       for ( auto seed : inseeds ) ATH_MSG_DEBUG("                 " << seed);
     }
     fastjet::AreaDefinition adef(fastjet::active_area_explicit_ghosts, gspec);
     //fastjet::AreaDefinition adef(fastjet::active_area, gspec);
     ATH_MSG_DEBUG("Creating input area cluster sequence");
     pcs = new fastjet::ClusterSequenceArea(*inps, jetdef,
                                            adef.with_fixed_seed(inseeds));
   }
  
   ATH_MSG_DEBUG("Calling fastjet");
   PseudoJetVector outs = sorted_by_pt(pcs->inclusive_jets(m_ptmin));
   ATH_MSG_DEBUG("Found jet count: " << outs.size());
   // for ( PseudoJetVector::const_iterator ijet=outs.begin(); ijet!=outs.end(); ++ijet ) {
   for (const auto &  pj: outs ) {
     xAOD::Jet* pjet = m_bld->add(pj, pjContainer, jets, inputtype);
  
     // transfer the  contituents of pseudojet (which are pseudojets)
     // to constiuents of jet (which are IParticles)
     // pjContainer.extractConstituents(*pjet, pj);
  
     xAOD::JetAlgorithmType::ID ialg = xAOD::JetAlgorithmType::algId(m_fjalg);
     pjet->setAlgorithmType(ialg);
     pjet->setSizeParameter(m_jetrad);
     if ( isVariableR() ) {
       pjet->setAttribute("VariableRMinRadius", m_minrad);
       pjet->setAttribute("VariableRMassScale", m_massscale);
     }
     pjet->setAttribute("JetGhostArea", m_ghostarea);
   }
   ATH_MSG_DEBUG("Reconstructed jet count: " << jets.size() <<  "  clusterseq="<<pcs);
  
   for(const xAOD::Jet* j : jets){
     ATH_MSG_DEBUG("jets reconstructed no of constituents "
                   << j->numConstituents());
   }
   // offline stores pcs storegate, trigger: passes it back to caller
   if(doSave){save(pcs);}
  
   return 0;
 }

◆ 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

◆ find()

int JetFinder::find	(	const PseudoJetContainer &	cont,
		xAOD::JetContainer &	finalJets,
		xAOD::JetInput::Type	contype
	)		const

overridevirtual

Method to find jets from a vector of pseudojet inputs.

The last arguments are the input type for the found jets and the list of ghost constituent labels. Returns 0 for success.

Implements IJetFinder.

Definition at line 98 of file JetFinder.cxx.

                                                        {
  
   constexpr bool doSave = true;
   fastjet::ClusterSequence* pcs{nullptr};
   return _find(pjContainer, finalJets, inputtype, doSave, pcs);
 }

◆ findNoSave()

int JetFinder::findNoSave	(	const PseudoJetContainer &	cont,
		xAOD::JetContainer &	finalJets,
		xAOD::JetInput::Type	contype,
		fastjet::ClusterSequence *&	cs
	)		const

overridevirtual

Implements IJetFinder.

Definition at line 109 of file JetFinder.cxx.

                                                               {
  
   constexpr bool doSave = false;
   return _find(pjContainer, finalJets, inputtype, doSave, pcs);
 }

◆ 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 JetFinder::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 54 of file JetFinder.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;
   }
  
   fastjet::JetDefinition jetdef(m_fjalg, m_jetrad);
   PseudoJetVector empty;
   fastjet::ClusterSequence cs(empty, jetdef);
   cs.inclusive_jets(m_ptmin);
   m_isVariableR = m_minrad>=0.0 && m_massscale>=0.0;
 #ifdef NO_JET_VARIABLER
   if ( isVariableR() ) {
     ATH_MSG_ERROR("Variable-R jet findng is not supported in theis build.");
   }
 #endif
  
   // Input DataHandles
   ATH_CHECK( m_eventinfokey.initialize() );
  
   std::string sdrop = "ToolSvc.";
   std::string myname = name();
   std::string::size_type ipos = myname.find(sdrop);
   if ( ipos != std::string::npos ) myname.replace(ipos, sdrop.size(), "");
   std::string cname = "ClusterSequence_JetFinder_" + myname;
  
   m_cnameRKey = cname;
   m_cnameWKey = cname;
   ATH_CHECK( m_cnameRKey.initialize() );
   ATH_CHECK( m_cnameWKey.initialize() );
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isVariableR()

bool JetFinder::isVariableR ( ) const

Definition at line 264 of file JetFinder.cxx.

                                   {
   return m_isVariableR;
 }

◆ 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 JetFinder::print ( ) const

overridevirtual

Print the state of the tool.

Reimplemented from asg::AsgTool.

Definition at line 270 of file JetFinder.cxx.

                             {
   ATH_MSG_INFO("      Jet algorithm: " << m_jetalg);
   if ( isVariableR() ) {
     ATH_MSG_INFO("         Variable-R: true");
     ATH_MSG_INFO("         min radius: " << m_minrad);
     ATH_MSG_INFO("         max radius: " << m_jetrad);
     ATH_MSG_INFO("         mass scale: " << m_massscale);
   } else {
     ATH_MSG_INFO(" Jet size parameter: " << m_jetrad);
   }
   ATH_MSG_INFO("   Jet min pT [MeV]: " << m_ptmin);
   ATH_MSG_INFO("         Ghost area: " << m_ghostarea);
   ATH_MSG_INFO("       Output level: " << MSG::name(msg().level()));
 }

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

◆ save()

void JetFinder::save ( fastjet::ClusterSequence * pcs ) const

Definition at line 242 of file JetFinder.cxx.

                                                       {
  
   auto handle_out = SG::makeHandle(m_cnameWKey);
   if ( ! handle_out.record( std::unique_ptr<fastjet::ClusterSequence>(pcs)) ) {
     ATH_MSG_WARNING("Unable to record " << m_cnameWKey.key());
   } else {
     ATH_MSG_DEBUG("Recorded " << m_cnameWKey.key() << "   " << pcs );
   }
   auto handle_in = SG::makeHandle(m_cnameRKey);
   bool present = false;
   if ( handle_in.isValid()) {
     present = true;
   }
   ATH_MSG_DEBUG("Check presence: " << present);
   ATH_MSG_DEBUG("Will delete self: " << pcs->will_delete_self_when_unused());
   const fastjet::SharedPtr<fastjet::PseudoJetStructureBase>& shrptr = pcs->structure_shared_ptr();
   ATH_MSG_DEBUG("  Pointer: " << shrptr.get());
   ATH_MSG_DEBUG("  Use count: " << shrptr.use_count());
 }

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

ToolHandle<IJetFromPseudojet> JetFinder::m_bld

private

Definition at line 92 of file JetFinder.h.

◆ m_cnameRKey

SG::ReadHandleKey<fastjet::ClusterSequence> JetFinder::m_cnameRKey

private

Definition at line 80 of file JetFinder.h.

◆ m_cnameWKey

SG::WriteHandleKey<fastjet::ClusterSequence> JetFinder::m_cnameWKey

private

Definition at line 81 of file JetFinder.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> JetFinder::m_eventinfokey {"EventInfo"}

private

Definition at line 79 of file JetFinder.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_fjalg

fastjet::JetAlgorithm JetFinder::m_fjalg

private

Definition at line 95 of file JetFinder.h.

◆ m_ghostarea

float JetFinder::m_ghostarea

private

Definition at line 89 of file JetFinder.h.

◆ m_isVariableR

bool JetFinder::m_isVariableR

private

Definition at line 96 of file JetFinder.h.

◆ m_jetalg

std::string JetFinder::m_jetalg

private

Definition at line 84 of file JetFinder.h.

◆ m_jetrad

float JetFinder::m_jetrad

private

Definition at line 85 of file JetFinder.h.

◆ m_massscale

float JetFinder::m_massscale

private

Definition at line 87 of file JetFinder.h.

◆ m_minrad

float JetFinder::m_minrad

private

Definition at line 86 of file JetFinder.h.

◆ m_ptmin

float JetFinder::m_ptmin

private

Definition at line 88 of file JetFinder.h.

◆ m_ranopt

int JetFinder::m_ranopt

private

Definition at line 90 of file JetFinder.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 Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ NameList

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetFinder()

Member Function Documentation

◆ _find()

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

◆ find()

◆ findNoSave()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ isVariableR()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ save()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_bld

◆ m_cnameRKey

◆ m_cnameWKey

◆ m_detStore

◆ m_eventinfokey

◆ m_evtStore

◆ m_fjalg

◆ m_ghostarea

◆ m_isVariableR

◆ m_jetalg

◆ m_jetrad

◆ m_massscale

◆ m_minrad

◆ m_ptmin

◆ m_ranopt

◆ m_varHandleArraysDeclared

◆ m_vhka