#include <EventDensityTool.h>

Inheritance diagram for EventDensityTool:

Collaboration diagram for EventDensityTool:

Public Member Functions
	EventDensityTool (const std::string &name)
	Constructor with parameters: More...

	~EventDensityTool ()
	Destructor: More...

StatusCode	initialize ()
	Initialization. More...

StatusCode	fillEventShape () const
	Action. More...

StatusCode	fillEventShape (xAOD::EventShape *es) const
	Fills the given EventShape object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MsgStream &	msg () const

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

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
StatusCode	fillEventShape (xAOD::EventShape *es, const PseudoJetVector &input) 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...

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
ToolHandle< IPseudoJetGetter >	m_trigPJGet {""}

SG::ReadHandleKey< PseudoJetContainer >	m_inPJKey {this, "InputContainer", "", "ReadHandleKey for input PseudoJetVector"}

SG::WriteHandleKey< xAOD::EventShape >	m_outEDKey {this, "OutputContainer", "GenericEventDensity", "WriteHandleKey for output EventDensity"}

std::string	m_jetalg

float	m_jetrad

float	m_rapmin

float	m_rapmax

std::string	m_areadef

float	m_vrfact

fastjet::JetDefinition	m_fjjetdef

fastjet::AreaDefinition	m_fjareadef

fastjet::Selector	m_fjselector

bool	m_useAreaFourMom

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

A dual-use tool to compute event density using FastJet.

Properties:

JetAlgorithm: Kt, AntiKt or CamKt
JetRadius: Jet size parameter, e.g. 0.4
JetInput: Psedudojet getter for the inputs
AbsRapidityMin: Minimum |y| for selecting jets.
AbsRapidityMax: Maximum |y| for selecting jets.
AreaDefinition: Voronoi, Active or ActiveFourVector
VoronoiRfact - Multiplicative factor for Voronoi radius
OutputContainer: Output container name
VariableName - Name for the variable used to store rho

Definition at line 48 of file EventDensityTool.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

◆ EventDensityTool()

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

Constructor with parameters:

Definition at line 26 of file EventDensityTool.cxx.

   : asg::AsgTool(name),
   m_useAreaFourMom(true)
 {
   declareProperty("JetAlgorithm",    m_jetalg  = "Kt");
   declareProperty("JetRadius",       m_jetrad  = 0.4);
   declareProperty("AbsRapidityMin",  m_rapmin  = 0.0);
   declareProperty("AbsRapidityMax",  m_rapmax  = 2.0);
   declareProperty("AreaDefinition",  m_areadef = "Voronoi");
   declareProperty("VoronoiRfact",    m_vrfact  = 1.0);
   declareProperty("UseFourMomArea",  m_useAreaFourMom);
   declareProperty("TrigPseudoJetGetter", m_trigPJGet);
 }

◆ ~EventDensityTool()

EventDensityTool::~EventDensityTool ( )

Destructor:

Definition at line 42 of file EventDensityTool.cxx.

42 {}

Member Function Documentation

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

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

inlineprivateinherited

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

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 245 of file AthCommonDataStore.h.

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

◆ declareProperty() [2/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 221 of file AthCommonDataStore.h.

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

◆ declareProperty() [3/6]

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

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

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

◆ declareProperty() [4/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 333 of file AthCommonDataStore.h.

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

◆ declareProperty() [5/6]

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

inlineinherited

Declare a new Gaudi property.

Parameters

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

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

Definition at line 352 of file AthCommonDataStore.h.

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

◆ declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

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

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ 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

◆ fillEventShape() [1/3]

StatusCode EventDensityTool::fillEventShape ( ) const

virtual

Action.

Implements IEventShapeTool.

Definition at line 126 of file EventDensityTool.cxx.

                                                   {
   
   ATH_MSG_DEBUG("Begin fillEventShape()");
  
   std::unique_ptr<xAOD::EventShape> eventShape(std::make_unique<xAOD::EventShape>());
   std::unique_ptr<xAOD::EventShapeAuxInfo> eventShapeaux(std::make_unique<xAOD::EventShapeAuxInfo>());
   eventShape->setStore( eventShapeaux.get() );
  
   // Change the order: first fill the object and then record
   ATH_CHECK(fillEventShape(eventShape.get()));  
  
   auto h_out = makeHandle(m_outEDKey);
   if ( ! h_out.record(std::move(eventShape), std::move(eventShapeaux) )) {
     ATH_MSG_WARNING("Unable to write new EventShape and aux store to event store: " << m_outEDKey.key());
   } else {
     ATH_MSG_DEBUG("Created new EventShape container: " << m_outEDKey.key());
   }
  
   return StatusCode::SUCCESS;
 }

◆ fillEventShape() [2/3]

StatusCode EventDensityTool::fillEventShape ( xAOD::EventShape * ) const

virtual

Fills the given EventShape object.

Implements IEventShapeTool.

Definition at line 148 of file EventDensityTool.cxx.

                                                                             {
  
   if(!m_inPJKey.key().empty() && m_trigPJGet.empty()) {
     auto h_in = makeHandle(m_inPJKey);
     if( ! h_in.isValid() ) {
       ATH_MSG_ERROR("No input PseudoJetContainer "<< m_inPJKey.key() );
       return StatusCode::FAILURE;
     }
     if ( h_in->size() == 0 ) {
       ATH_MSG_DEBUG( "Input PseudoJetContainer size()=0 for pseudojets from "<< m_inPJKey.key() );
     } else {
       ATH_MSG_DEBUG("Retrieved input pseudojets " << m_inPJKey.key() << " , count: " <<  h_in->size());
     }
     return fillEventShape(eventShape, *(h_in->casVectorPseudoJet()));
   }
   // { FIXME: To be removed when trigger moves to DataHandles fully
   else if(m_inPJKey.key().empty() && !m_trigPJGet.empty()) {
     const PseudoJetVector& ppjv = *(m_trigPJGet->get());
     // !!! FIXME !!! Downgraded ERROR to WARNING and no FAILURE
     if ( ppjv.size() == 0 ) {
       ATH_MSG_WARNING( "Input PseudoJetVector size()=0 for pseudojets from "<< m_trigPJGet.name() );
       //return StatusCode::FAILURE;
     } else {
       ATH_MSG_DEBUG("Retrieved input pseudojets " << m_trigPJGet.name() << " , count: " <<  ppjv.size());
     }
     return fillEventShape(eventShape, ppjv);
   }
   // } FIXME
   
   return StatusCode::FAILURE;
 }

◆ fillEventShape() [3/3]

StatusCode EventDensityTool::fillEventShape	(	xAOD::EventShape *	es,
		const PseudoJetVector &	input
	)		const

protected

Definition at line 182 of file EventDensityTool.cxx.

                                                                               { 
   ATH_MSG_DEBUG("Input pseudojet count: " << pjv.size());
   ATH_MSG_DEBUG("Event shape container address: " << eventShape);
  
   for(const auto & pj : pjv) {
     ATH_MSG_DEBUG(" pj input e="<<pj.e() << " pz="<<pj.pz() << " px="<<pj.px() );
   }
   // Find jets.
   std::unique_ptr<ClusterSequenceArea> pcsa=std::make_unique<ClusterSequenceArea>(pjv, m_fjjetdef, m_fjareadef);
   ATH_MSG_DEBUG("Found jet count: " << pcsa->inclusive_jets().size());
  
   // Extract rho.
   double rho, sigma, area;
   pcsa->get_median_rho_and_sigma(m_fjselector, m_useAreaFourMom, rho, sigma, area);
   ATH_MSG_DEBUG(" calculated rho="<< rho);
  
   // Record rho.
  
   // Fill the EventShape object
   const static SG::AuxElement::Accessor<float> rhoDec("Density");
   const static SG::AuxElement::Accessor<float> sigmaDec("DensitySigma");
   const static SG::AuxElement::Accessor<float> areaDec("DensityArea");
   rhoDec(*eventShape) = rho;
   sigmaDec(*eventShape) = sigma;
   areaDec(*eventShape) = area;
  
   ATH_MSG_DEBUG("Recorded event density:  = " << 0.001*rho << " GeV");
  
   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 EventDensityTool::initialize ( )

virtual

Initialization.

Reimplemented from asg::AsgTool.

Definition at line 46 of file EventDensityTool.cxx.

                                         {
   ATH_MSG_INFO ("Initializing " << name() << "...");
  
   // Initialise output handle
   ATH_CHECK( m_outEDKey.initialize() );
  
   // Fetch the fastjet algorithm enum
   JetAlgorithm fjalg;
   if      ( m_jetalg == "Kt"     ) fjalg = fastjet::kt_algorithm;
   else if ( m_jetalg == "AntiKt" ) fjalg = fastjet::antikt_algorithm;
   else if ( m_jetalg == "CamKt"  ) fjalg = fastjet::cambridge_algorithm;
   else {
     ATH_MSG_ERROR("Invalid jet algorithm name: " << m_jetalg);
     ATH_MSG_ERROR("Allowed values are Kt, CamKt, AntiKt, etc.");
     return StatusCode::FAILURE;
   }
  
   // Build jet definition.
   m_fjjetdef = JetDefinition(fjalg, m_jetrad);
  
   // Build area definition.
   if ( m_areadef == "Voronoi" ) {
     m_fjareadef = AreaDefinition(fastjet::voronoi_area, VoronoiAreaSpec(m_vrfact));
   } else if ( m_areadef == "Active" || m_useAreaFourMom ) {
     // Default is fine here for now.
     // Later might want to switch to seeds and binning used in jet reco.
     // See JetRec/JetFinder for that.
   } else {
     ATH_MSG_WARNING("Unsupported area option: " << m_areadef);
     return StatusCode::FAILURE;
   }
  
   // Build the jet selector.
   if ( m_rapmin >= 0.0  &&  m_rapmax > m_rapmin ) {
     m_fjselector = fastjet::SelectorAbsRapRange(m_rapmin, m_rapmax);
   } else {
     ATH_MSG_WARNING("Invalid absolute rapidity range: ("
                     << m_rapmin << ", " << m_rapmax << ")");
     return StatusCode::FAILURE;
   }
   ATH_MSG_INFO("Configured properties:");
   ATH_MSG_INFO("     JetAlgorithm: " << m_jetalg);
   ATH_MSG_INFO("        JetRadius: " << m_jetrad);
   if(!m_inPJKey.key().empty()) {
     ATH_MSG_INFO("   InputContainer: " << m_inPJKey.key());
   } else {
     ATH_MSG_INFO("     TrigPJGetter: " << m_trigPJGet.name());
   }
   ATH_MSG_INFO("   AbsRapidityMin: " << m_rapmin);
   ATH_MSG_INFO("   AbsRapidityMax: " << m_rapmax);
   ATH_MSG_INFO("   AreaDefinition: " << m_areadef);
   ATH_MSG_INFO("     VoronoiRfact: " << m_vrfact);
   ATH_MSG_INFO("  OutputContainer: " << m_outEDKey.key());
   ATH_MSG_INFO("Derived properties:");
   ATH_MSG_INFO("        Fastjet jet defn: " << m_fjjetdef.description());
   ATH_MSG_INFO("       Fastjet area defn: " << m_fjareadef.description());
   ATH_MSG_INFO("    Fastjet jet selector: " << m_fjselector.description());
   ATH_MSG_INFO("  Use area four-momentum: " << m_useAreaFourMom);
  
   // Input sources
   if(!m_inPJKey.key().empty() && m_trigPJGet.empty()) {
     ATH_CHECK( m_inPJKey.initialize() );
   }
   // { FIXME: To be removed when trigger moves to DataHandles fully
   else if(m_inPJKey.key().empty() && !m_trigPJGet.empty()) {
     ATH_CHECK( m_trigPJGet.retrieve() );
   }
   // } FIXME
   else {
     ATH_MSG_ERROR( "Inconsistent/ambiguous input setup."
            << " InPJKey: " << m_inPJKey.key() 
            << " TrigPJGetter: " << m_trigPJGet.name() );
     return StatusCode::FAILURE;
   }
  
   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.

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

Member Data Documentation

◆ m_areadef

std::string EventDensityTool::m_areadef

private

Definition at line 85 of file EventDensityTool.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_fjareadef

fastjet::AreaDefinition EventDensityTool::m_fjareadef

private

Definition at line 90 of file EventDensityTool.h.

◆ m_fjjetdef

fastjet::JetDefinition EventDensityTool::m_fjjetdef

private

Definition at line 89 of file EventDensityTool.h.

◆ m_fjselector

fastjet::Selector EventDensityTool::m_fjselector

private

Definition at line 91 of file EventDensityTool.h.

◆ m_inPJKey

SG::ReadHandleKey<PseudoJetContainer> EventDensityTool::m_inPJKey {this, "InputContainer", "", "ReadHandleKey for input PseudoJetVector"}

private

Definition at line 77 of file EventDensityTool.h.

◆ m_jetalg

std::string EventDensityTool::m_jetalg

private

Definition at line 81 of file EventDensityTool.h.

◆ m_jetrad

float EventDensityTool::m_jetrad

private

Definition at line 82 of file EventDensityTool.h.

◆ m_outEDKey

SG::WriteHandleKey<xAOD::EventShape> EventDensityTool::m_outEDKey {this, "OutputContainer", "GenericEventDensity", "WriteHandleKey for output EventDensity"}

private

Definition at line 78 of file EventDensityTool.h.

◆ m_rapmax

float EventDensityTool::m_rapmax

private

Definition at line 84 of file EventDensityTool.h.

◆ m_rapmin

float EventDensityTool::m_rapmin

private

Definition at line 83 of file EventDensityTool.h.

◆ m_trigPJGet

ToolHandle<IPseudoJetGetter> EventDensityTool::m_trigPJGet {""}

private

Definition at line 74 of file EventDensityTool.h.

◆ m_useAreaFourMom

bool EventDensityTool::m_useAreaFourMom

private

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

◆ m_vrfact

float EventDensityTool::m_vrfact

private

Definition at line 86 of file EventDensityTool.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ EventDensityTool()

◆ ~EventDensityTool()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ fillEventShape() [1/3]

◆ fillEventShape() [2/3]

◆ fillEventShape() [3/3]

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_areadef

◆ m_detStore

◆ m_evtStore

◆ m_fjareadef

◆ m_fjjetdef

◆ m_fjselector

◆ m_inPJKey

◆ m_jetalg

◆ m_jetrad

◆ m_outEDKey

◆ m_rapmax

◆ m_rapmin

◆ m_trigPJGet

◆ m_useAreaFourMom

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_vrfact