#include <HIUEModulatorTool.h>

Inheritance diagram for HIUEModulatorTool:

Collaboration diagram for HIUEModulatorTool:

Public Member Functions
	HIUEModulatorTool (const std::string &myname)
virtual float	getModulation (float phi, const xAOD::HIEventShape *shape=nullptr) const override
virtual StatusCode	setEventShapeForModulation (const xAOD::HIEventShape *shape) override
virtual void	setHarmonics (const std::vector< unsigned int > &v) override
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual StatusCode	getShape (const xAOD::HIEventShape *&shape) const override
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Static Public Member Functions
static float	modulate (const std::vector< unsigned int > &nh_vector, const xAOD::HIEventShape *shape, float phi)

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	checkQVectorSize (const xAOD::HIEventShape *shape, unsigned int n) const
StatusCode	checkCompatibility () const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::HIEventShapeContainer >	m_shape_key { this, "EventShapeKey", "", "The input HI Event Shape"}
const xAOD::HIEventShape *	m_shape
std::vector< unsigned int >	m_nh_vector
Gaudi::Property< bool >	m_do_v2 { this, "DoV2", true, "Do V2 modulation" }
Gaudi::Property< bool >	m_do_v3 { this, "DoV3", true, "Do V3 modulation" }
Gaudi::Property< bool >	m_do_v4 { this, "DoV4", true, "Do V4 modulation" }
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 16 of file HIUEModulatorTool.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

◆ HIUEModulatorTool()

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

Definition at line 12 of file HIUEModulatorTool.cxx.

                                                       : asg::AsgTool(n),
                                 m_shape(nullptr)
{
#ifndef XAOD_STANDALONE
  //should not need this due to ASG_TOOL_CLASS macro since
  //athena only calls 3 arg constructor which explicitly declares athena interface?
  declareInterface<IHIUEModulatorTool>(this);
#endif
}

Member Function Documentation

◆ checkCompatibility()

StatusCode HIUEModulatorTool::checkCompatibility ( ) const

private

Definition at line 119 of file HIUEModulatorTool.cxx.

{
  for(unsigned int i : m_nh_vector)
  {
    if(checkQVectorSize(m_shape,i).isFailure())
    {
      ATH_MSG_ERROR("HIEventShapeContainer " << m_shape_key << " does not have requested harmonic " << i );
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

◆ checkQVectorSize()

StatusCode HIUEModulatorTool::checkQVectorSize	(	const xAOD::HIEventShape *	shape,
		unsigned int	n ) const

private

Definition at line 114 of file HIUEModulatorTool.cxx.

{
  return ( shape->etCos().size() >= n ) ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

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

◆ getModulation()

float HIUEModulatorTool::getModulation	(	float	phi,
		const xAOD::HIEventShape *	shape = nullptr ) const

overridevirtual

Implements IHIUEModulatorTool.

Definition at line 53 of file HIUEModulatorTool.cxx.

{
  if (!shape)
    shape = m_shape;
  if (!shape)
    if (getShape (shape).isFailure() || !shape)
      return 1;
  return modulate(m_nh_vector,shape,phi);
}

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

◆ getShape()

StatusCode HIUEModulatorTool::getShape ( const xAOD::HIEventShape *& shape ) const

overridevirtual

Implements IHIUEModulatorTool.

Definition at line 64 of file HIUEModulatorTool.cxx.

{
  shape = 0;
  if( m_shape_key.key().empty() )
  { 
    ATH_MSG_DEBUG("ShapeKey empty, no modulation, returning shape =" << shape);
    return StatusCode::SUCCESS;
  }
 
    SG::ReadHandle<xAOD::HIEventShapeContainer>  read_handle_evtShape ( m_shape_key );
    if (!read_handle_evtShape.isValid()) {
             ATH_MSG_FATAL( "Could not find HI event shape!" );
             return(StatusCode::FAILURE);
    }
 
  const xAOD::HIEventShapeContainer* mod_shape = read_handle_evtShape.get();
 
  if(mod_shape->size()==0)
  {
    ATH_MSG_ERROR("Modulation container empty : " << m_shape_key);
    return StatusCode::FAILURE;
  }
  shape = mod_shape->at(0);
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode HIUEModulatorTool::initialize ( void )

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 22 of file HIUEModulatorTool.cxx.

{
  //First we initialize keys - after initialization they are frozen
 
  ATH_CHECK( m_shape_key.initialize( !m_shape_key.key().empty() ) );
 
  m_nh_vector.reserve(3);
  if(m_do_v2) m_nh_vector.push_back(2);
  if(m_do_v3) m_nh_vector.push_back(3);
  if(m_do_v4) m_nh_vector.push_back(4);
  if( m_nh_vector.size()!=0 && m_shape_key.key().empty() )
    ATH_MSG_WARNING("Requested modulation, but provided no name for HIEventShapeContainer, no modulation will be applied");
 
  ATH_MSG_DEBUG("Equipping " << m_do_v2 << "\t" << m_do_v3 << "\t" << m_do_v4);
 
  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.

◆ modulate()

float HIUEModulatorTool::modulate	(	const std::vector< unsigned int > &	nh_vector,
		const xAOD::HIEventShape *	shape,
		float	phi )

static

Definition at line 90 of file HIUEModulatorTool.cxx.

{
  float modulation=0;
  float et=shape->et();
  if(et > 0.)
  {
    for(unsigned int i : nh_vector)
    {
 
      unsigned int ih=i-1;
      float nphi=i;
 
      nphi*=phi;
      float qx=shape->etCos().at(ih);
      float qy=shape->etSin().at(ih);
      CxxUtils::sincos sc(nphi);
      modulation+=2.*sc.apply(qy,qx);
    }
    modulation/=et;
  }
 
  return modulation+1;
}

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ 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 AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

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

◆ setEventShapeForModulation()

StatusCode HIUEModulatorTool::setEventShapeForModulation ( const xAOD::HIEventShape * shape )

overridevirtual

Implements IHIUEModulatorTool.

Definition at line 41 of file HIUEModulatorTool.cxx.

{
  m_shape=shape;
  return checkCompatibility();
}

◆ setHarmonics()

void HIUEModulatorTool::setHarmonics ( const std::vector< unsigned int > & v )

overridevirtual

Implements IHIUEModulatorTool.

Definition at line 48 of file HIUEModulatorTool.cxx.

{
  m_nh_vector.assign(v.begin(),v.end());
}

◆ 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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_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_do_v2

Gaudi::Property< bool > HIUEModulatorTool::m_do_v2 { this, "DoV2", true, "Do V2 modulation" }

private

Definition at line 45 of file HIUEModulatorTool.h.

45{ this, "DoV2", true, "Do V2 modulation" };

◆ m_do_v3

Gaudi::Property< bool > HIUEModulatorTool::m_do_v3 { this, "DoV3", true, "Do V3 modulation" }

private

Definition at line 47 of file HIUEModulatorTool.h.

47{ this, "DoV3", true, "Do V3 modulation" };

◆ m_do_v4

Gaudi::Property< bool > HIUEModulatorTool::m_do_v4 { this, "DoV4", true, "Do V4 modulation" }

private

Definition at line 49 of file HIUEModulatorTool.h.

49{ this, "DoV4", true, "Do V4 modulation" };

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

std::vector<unsigned int> HIUEModulatorTool::m_nh_vector

private

Definition at line 42 of file HIUEModulatorTool.h.

◆ m_shape

const xAOD::HIEventShape* HIUEModulatorTool::m_shape

private

Definition at line 41 of file HIUEModulatorTool.h.

◆ m_shape_key

SG::ReadHandleKey< xAOD::HIEventShapeContainer > HIUEModulatorTool::m_shape_key { this, "EventShapeKey", "", "The input HI Event Shape"}

private

Definition at line 39 of file HIUEModulatorTool.h.

39{ this, "EventShapeKey", "", "The input HI Event Shape"};

◆ 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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ HIUEModulatorTool()

Member Function Documentation

◆ checkCompatibility()

◆ checkQVectorSize()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getModulation()

◆ getName()

◆ getProperty()

◆ getShape()

◆ initialize()

◆ inputHandles()

◆ modulate()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ setEventShapeForModulation()

◆ setHarmonics()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_do_v2

◆ m_do_v3

◆ m_do_v4

◆ m_evtStore

◆ m_nh_vector

◆ m_shape

◆ m_shape_key

◆ m_varHandleArraysDeclared

◆ m_vhka