#include <PuppiWeightTool.h>

Inheritance diagram for PuppiWeightTool:

Collaboration diagram for PuppiWeightTool:

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

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

virtual StatusCode	finalize () override

virtual StatusCode	process_impl (xAOD::IParticleContainer *cont) const override final

StatusCode	applyPuppiWeights (xAOD::PFOContainer *cont) const

StatusCode	applyPuppiWeights (xAOD::FlowElementContainer *cont) const

StatusCode	process (xAOD::IParticleContainer *cont) const override final

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	setEtaPhi (xAOD::IParticle *obj, float eta, float phi) const

StatusCode	setEnergyPt (xAOD::IParticle obj, float e, float pt, const SG::AuxElement::Accessor< float > weightAcc=nullptr) const

StatusCode	setP4 (xAOD::IParticle obj, const xAOD::JetFourMom_t &p4, const SG::AuxElement::Accessor< float > weightAcc=nullptr) 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
unsigned int	m_inputType =xAOD::Type::Other

bool	m_applyToChargedPFO =true

bool	m_applyToNeutralPFO =true

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
double	m_R0

double	m_Rmin

double	m_beta

double	m_centralPTCutOffset

double	m_centralPTCutSlope

double	m_forwardPTCutOffset

double	m_forwardPTCutSlope

double	m_etaBoundary

bool	m_includeCentralNeutralsInAlpha

bool	m_applyWeight

SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexContainer_key {"PrimaryVertices"}

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 19 of file PuppiWeightTool.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

◆ PuppiWeightTool()

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

Definition at line 20 of file PuppiWeightTool.cxx.

                                                       :
   JetConstituentModifierBase(name) {
  
   declareProperty("R0", m_R0 = 0.3);
   declareProperty("Rmin", m_Rmin = 0.001);
   declareProperty("Beta", m_beta = 1);
   declareProperty("CentralPTCutOffset", m_centralPTCutOffset = 0);
   declareProperty("CentralPTCutSlope", m_centralPTCutSlope = 0);
   declareProperty("ForwardPTCutOffset", m_forwardPTCutOffset = 0);
   declareProperty("ForwardPTCutSlope", m_forwardPTCutSlope = 0);
   declareProperty("EtaBoundary",m_etaBoundary = 2.5);
  
   declareProperty("ApplyWeight",m_applyWeight=true);
   declareProperty("IncludeCentralNeutralsInAlpha",m_includeCentralNeutralsInAlpha=false);
 }

Member Function Documentation

◆ applyPuppiWeights() [1/2]

StatusCode PuppiWeightTool::applyPuppiWeights ( xAOD::FlowElementContainer * cont ) const

◆ applyPuppiWeights() [2/2]

StatusCode PuppiWeightTool::applyPuppiWeights ( xAOD::PFOContainer * cont ) const

Definition at line 77 of file PuppiWeightTool.cxx.

                                                                          {
  
   const static SG::AuxElement::Accessor<bool> PVMatchedAcc("matchedToPV");
   const static SG::AuxElement::Accessor<double> alphaAcc("PUPPI_alpha");
   const static SG::AuxElement::Accessor<double> weightAcc("PUPPI_weight");
  
   std::vector<fastjet::PseudoJet> chargedHSVector;
   std::vector<fastjet::PseudoJet> chargedPUVector;
   std::vector<fastjet::PseudoJet> neutralVector;
   std::vector<fastjet::PseudoJet> forwardVector;
  
   // Fill input particle vectors for puppi
   for ( xAOD::PFO* ppfo : *cont ) {
     if (!PVMatchedAcc.isAvailable(*ppfo)){
       ATH_MSG_ERROR("Not known if PFO is matched to primary vertex.  Run CorrectPFOTool before ChargedHadronSubtractionTool");
       return StatusCode::FAILURE;
     }
  
     if (ppfo->pt()<=FLT_MIN) continue;
  
     fastjet::PseudoJet pj(ppfo->p4());
     //pj.set_user_info(new PuppiUserInfo({someOtherChi2,yetAnotherChi2}));  //example of how additional information could be exploited - needs to be calculated somewhere above
  
     float charge = ppfo->charge();
     bool isCharged = (fabs(charge) > FLT_MIN);
  
     if(fabs(ppfo->eta()) > m_etaBoundary) forwardVector.push_back(pj);
     else{     
       if(isCharged){
         bool matchedToPrimaryVertex=PVMatchedAcc(*ppfo);
         if(matchedToPrimaryVertex) chargedHSVector.push_back(pj);
         else chargedPUVector.push_back(pj);
       }
       else neutralVector.push_back(pj);
     }
   }
  
   //Count the number of primary vertices
   const xAOD::VertexContainer* pvtxs = nullptr;
   auto handle = SG::makeHandle(m_vertexContainer_key);
   if (!handle.isValid()){
     ATH_MSG_WARNING(" This event has no primary vertices " );
     return StatusCode::FAILURE;
   }
     
   pvtxs = handle.cptr();
   if(pvtxs->empty()){
     ATH_MSG_WARNING(" This event has no primary vertices " );
     return StatusCode::FAILURE;
   }
  
   int nPV=0;
   for( const auto *vtx_itr : *pvtxs ){
     if((int)vtx_itr->nTrackParticles() < 2 ) continue;
     ++nPV;
   }
  
   Puppi puppi (m_R0, m_Rmin, m_beta, m_centralPTCutOffset, m_centralPTCutSlope, m_forwardPTCutOffset, m_forwardPTCutSlope, m_etaBoundary);
   puppi.setParticles(chargedHSVector, chargedPUVector, neutralVector, forwardVector, nPV);
  
   for ( xAOD::PFO* ppfo : *cont ) {
     float charge = ppfo->charge();
     bool isCharged = (fabs(charge) > FLT_MIN);
     bool isForward = (fabs(ppfo->eta()) > m_etaBoundary);
  
     fastjet::PseudoJet pj(ppfo->p4());
  
     double weight = puppi.getWeight(pj);
     double alpha = puppi.getAlpha(pj);
  
     if ((!isCharged || isForward) && m_applyWeight) ppfo->setP4(weight*ppfo->p4());
     alphaAcc(*ppfo) = alpha;
     weightAcc(*ppfo) = weight;
   }
  
   ATH_MSG_DEBUG("Median: "<<puppi.getMedian());
   ATH_MSG_DEBUG("RMS: "<<puppi.getRMS());
  
   return StatusCode::SUCCESS;
 }

◆ 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

◆ finalize()

StatusCode PuppiWeightTool::finalize ( )

overridevirtual

Definition at line 58 of file PuppiWeightTool.cxx.

                                      {
   ATH_MSG_INFO("Finializing tool " << name() << "...");
  
   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 PuppiWeightTool::initialize ( )

finaloverridevirtual

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 38 of file PuppiWeightTool.cxx.

                                        {
   ATH_MSG_INFO("Initializing tool " << name() << "...");
   
   ATH_CHECK(m_vertexContainer_key.initialize());
  
   if(m_inputType==xAOD::Type::ParticleFlow || m_inputType==xAOD::Type::FlowElement) {
     if(!m_applyToNeutralPFO) {
       ATH_MSG_ERROR("Incompatible configuration: ApplyToNeutralPFO=False -- what kind of pileup do you wish to suppress?");
       return StatusCode::FAILURE;
     }
   } else {
     ATH_MSG_ERROR("Incompatible configuration: PUPPI canot be used for inputs of type " << m_inputType);
     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;
    }

◆ process()

StatusCode JetConstituentModifierBase::process ( xAOD::IParticleContainer * cont ) const

finaloverridevirtualinherited

Implements IJetConstituentModifier.

Definition at line 23 of file JetConstituentModifierBase.cxx.

 {
   // Test that we are operating on the type of object that
   // we will be writing out.
   // By implication, any supporting containers should not
   // be the ones passed to this method...
   if(!cont->empty() && cont->front()->type() != m_inputType) {
     ATH_MSG_ERROR("Object type mismatch! This tool expects " << m_inputType
                << ", but received " << cont->front()->type());
     return StatusCode::FAILURE;
   }
  
   ATH_CHECK(process_impl(cont));
  
   return StatusCode::SUCCESS;
 }

◆ process_impl()

StatusCode PuppiWeightTool::process_impl ( xAOD::IParticleContainer * cont ) const

finaloverridevirtual

Reimplemented from JetConstituentModifierBase.

Definition at line 66 of file PuppiWeightTool.cxx.

                                                                            {
   if(m_inputType == xAOD::Type::FlowElement){
     xAOD::FlowElementContainer* feCont = static_cast<xAOD::FlowElementContainer*> (cont);
     return applyPuppiWeights(feCont);
   }
   xAOD::PFOContainer* pfoCont = static_cast<xAOD::PFOContainer*> (cont);
   return applyPuppiWeights(pfoCont);
 }

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

◆ setEnergyPt()

StatusCode JetConstituentModifierBase::setEnergyPt	(	xAOD::IParticle *	obj,
		float	e,
		float	pt,
		const SG::AuxElement::Accessor< float > *	weightAcc = `nullptr`
	)		const

protectedinherited

Definition at line 61 of file JetConstituentModifierBase.cxx.

 {
   switch(m_inputType) {
   case xAOD::Type::CaloCluster:
     {
       xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
       // Clusters get pt via the energy
       // This currently leaves the mass unaltered.
       if(weightAcc) (*weightAcc)(*clus) = clus->calE() > 0. ? e / clus->calE() : 0.;
       clus->setCalE(e);
     }
     break;
   case xAOD::Type::ParticleFlow:
     {
       xAOD::PFO* pfo = static_cast<xAOD::PFO*>(obj);
       if( (m_applyToChargedPFO && pfo->isCharged()) || 
           (m_applyToNeutralPFO && !pfo->isCharged()) ) {
         if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? pt / pfo->pt() : 0.;
         // KTJ: Temporary fix
         // Defeats the purpose, but we need to use this to reset the 4-vec cache
         pfo->setP4(pt, pfo->eta(), pfo->phi());
       }
     }
     break;
   case xAOD::Type::FlowElement:
     {
       xAOD::FlowElement* pfo = static_cast<xAOD::FlowElement*>(obj);
       if( (m_applyToChargedPFO && pfo->isCharged()) || 
           (m_applyToNeutralPFO && !pfo->isCharged()) ) {
         if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? pt / pfo->pt() : 0.;
         pfo->setP4(pt, pfo->eta(), pfo->phi(), 0.);
       }
     }
     break;
   case xAOD::Type::TrackCaloCluster:
     {
       xAOD::TrackCaloCluster* tcc = static_cast<xAOD::TrackCaloCluster*>(obj);
       if( tcc->taste() != 0) {
         if(weightAcc) (*weightAcc)(*tcc) = tcc->pt() > 0. ? pt / tcc->pt() : 0.;
         tcc->setParameters(pt, tcc->eta(), tcc->phi(), tcc->m(), xAOD::TrackCaloCluster::Taste(tcc->taste()), tcc->trackParticleLink(), tcc->caloClusterLinks());
       }
     }
     break;
   default:
     // Should not get here, because type-checking should happen in process()
     ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

◆ setEtaPhi()

StatusCode JetConstituentModifierBase::setEtaPhi	(	xAOD::IParticle *	obj,
		float	eta,
		float	phi
	)		const

protectedinherited

Definition at line 41 of file JetConstituentModifierBase.cxx.

 {
   switch(m_inputType) {
     // The main (only?) application is origin-correcting LC topoclusters
     // By convention we leave the raw p4 unmodified
   case xAOD::Type::CaloCluster:
     {
       xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
       clus->setCalEta(eta);
       clus->setCalPhi(phi);
     }
     break;
   default:
     // Should not get here, because type-checking should happen in process()
     ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

◆ setP4()

StatusCode JetConstituentModifierBase::setP4	(	xAOD::IParticle *	obj,
		const xAOD::JetFourMom_t &	p4,
		const SG::AuxElement::Accessor< float > *	weightAcc = `nullptr`
	)		const

protectedinherited

Definition at line 113 of file JetConstituentModifierBase.cxx.

                                                                                                  {
   switch(m_inputType) {
   case xAOD::Type::CaloCluster:
     {
       xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
       // This currently leaves the mass unaltered
       if(weightAcc) (*weightAcc)(*clus) = clus->calE() > 0. ? p4.e() / clus->calE() : 0.;
       clus->setCalE(p4.e());
       clus->setCalEta(p4.eta());
       clus->setCalPhi(p4.phi());
     }
     break;
   case xAOD::Type::ParticleFlow:
     {
       xAOD::PFO* pfo = static_cast<xAOD::PFO*>(obj);
       // The PFO setter defaults to m=0
       if( (m_applyToChargedPFO && pfo->isCharged()) || 
           (m_applyToNeutralPFO && !pfo->isCharged()) ) {
         if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? p4.pt() / pfo->pt() : 0.;
         pfo->setP4(p4.pt(),p4.eta(),p4.phi(),p4.mass());
       }
     }
     break;
   case xAOD::Type::FlowElement:
     {
       xAOD::FlowElement* pfo = static_cast<xAOD::FlowElement*>(obj);
       if( (m_applyToChargedPFO && pfo->isCharged()) || 
           (m_applyToNeutralPFO && !pfo->isCharged()) ) {
         if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? p4.pt() / pfo->pt() : 0.;
         pfo->setP4(p4.pt(),p4.eta(),p4.phi(),p4.mass());
       }
     }
     break;
   case xAOD::Type::TrackCaloCluster:
     {
       xAOD::TrackCaloCluster* tcc = static_cast<xAOD::TrackCaloCluster*>(obj);
       if( tcc->taste() != 0) {
               if(weightAcc) (*weightAcc)(*tcc) = tcc->pt() > 0. ? p4.pt() / tcc->pt() : 0.;
         tcc->setParameters(p4.pt(), p4.eta(), p4.phi(), p4.mass(), xAOD::TrackCaloCluster::Taste(tcc->taste()), tcc->trackParticleLink(), tcc->caloClusterLinks());
       }
       break;
     }
  
   default:
     // Should not get here, because type-checking should happen in process()
     ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

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

bool JetConstituentModifierBase::m_applyToChargedPFO =true

protectedinherited

Definition at line 62 of file JetConstituentModifierBase.h.

◆ m_applyToNeutralPFO

bool JetConstituentModifierBase::m_applyToNeutralPFO =true

protectedinherited

Definition at line 63 of file JetConstituentModifierBase.h.

◆ m_applyWeight

bool PuppiWeightTool::m_applyWeight

private

Definition at line 46 of file PuppiWeightTool.h.

◆ m_beta

double PuppiWeightTool::m_beta

private

Definition at line 38 of file PuppiWeightTool.h.

◆ m_centralPTCutOffset

double PuppiWeightTool::m_centralPTCutOffset

private

Definition at line 39 of file PuppiWeightTool.h.

◆ m_centralPTCutSlope

double PuppiWeightTool::m_centralPTCutSlope

private

Definition at line 40 of file PuppiWeightTool.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_etaBoundary

double PuppiWeightTool::m_etaBoundary

private

Definition at line 43 of file PuppiWeightTool.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_forwardPTCutOffset

double PuppiWeightTool::m_forwardPTCutOffset

private

Definition at line 41 of file PuppiWeightTool.h.

◆ m_forwardPTCutSlope

double PuppiWeightTool::m_forwardPTCutSlope

private

Definition at line 42 of file PuppiWeightTool.h.

◆ m_includeCentralNeutralsInAlpha

bool PuppiWeightTool::m_includeCentralNeutralsInAlpha

private

Definition at line 45 of file PuppiWeightTool.h.

◆ m_inputType

unsigned int JetConstituentModifierBase::m_inputType =xAOD::Type::Other

protectedinherited

Definition at line 60 of file JetConstituentModifierBase.h.

◆ m_R0

double PuppiWeightTool::m_R0

private

Definition at line 36 of file PuppiWeightTool.h.

◆ m_Rmin

double PuppiWeightTool::m_Rmin

private

Definition at line 37 of file PuppiWeightTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer_key

SG::ReadHandleKey<xAOD::VertexContainer> PuppiWeightTool::m_vertexContainer_key {"PrimaryVertices"}

private

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

◆ PuppiWeightTool()

Member Function Documentation

◆ applyPuppiWeights() [1/2]

◆ applyPuppiWeights() [2/2]

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

◆ finalize()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ process()

◆ process_impl()

◆ renounce()

◆ renounceArray()

◆ setEnergyPt()

◆ setEtaPhi()

◆ setP4()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_applyToChargedPFO

◆ m_applyToNeutralPFO

◆ m_applyWeight

◆ m_beta

◆ m_centralPTCutOffset

◆ m_centralPTCutSlope

◆ m_detStore

◆ m_etaBoundary

◆ m_evtStore

◆ m_forwardPTCutOffset

◆ m_forwardPTCutSlope

◆ m_includeCentralNeutralsInAlpha

◆ m_inputType

◆ m_R0

◆ m_Rmin

◆ m_varHandleArraysDeclared

◆ m_vertexContainer_key

◆ m_vhka