#include <PMGSherpa22VJetsWeightTool.h>

Inheritance diagram for PMGTools::PMGSherpa22VJetsWeightTool:

Collaboration diagram for PMGTools::PMGSherpa22VJetsWeightTool:

Public Member Functions
	PMGSherpa22VJetsWeightTool (const std::string &name="PMGSherpa22VJetsWeightTool")
	Standard tool constructor, with name.
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
Interface inherited from asg::IAsgTool
virtual StatusCode	initialize () override final
	Initialize is required by AsgTool base class.
Interface inherited from IWeightTool
virtual double	getWeight () const override
	Sherpa 2.2 V+jets jet multiplicity reweight to fix issue from scale settings used in pTV sliced samples.
Functions used in calculating the event weight
double	getSherpa22VJets_NJetCorrection (size_t ntag) const
	Return correction for given jet multiplicity.
double	getSherpa22VJets_NJetCorrection (const std::string &jetcontainer) const
	Input is the truth collection string Antikt4TruthJets or Antikt4TruthWZJets.
size_t	getSherpa22VJets_NJet (const std::string &jetcontainer) const
	Function returns number of jets required for correction.
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.

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::array< double, NJET_CORRECTION_BINS >	m_corrFactors
	Correction factors used in the weight calculation.
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
Tool properties
std::string	m_truthJetContainer
	The truth jet container to use for the calculation.
std::string	m_truthParticleContainer
	The truth particle container to use for the calculation.

Static Private Attributes
static const size_t	NJET_CORRECTION_BINS = 9
	Number of jet multiplicities that we have a correction for.

Detailed Description

Definition at line 32 of file PMGSherpa22VJetsWeightTool.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

◆ PMGSherpa22VJetsWeightTool()

PMGTools::PMGSherpa22VJetsWeightTool::PMGSherpa22VJetsWeightTool ( const std::string & name = "PMGSherpa22VJetsWeightTool" )

Standard tool constructor, with name.

Definition at line 18 of file PMGSherpa22VJetsWeightTool.cxx.

    : asg::AsgTool( name ),
      m_corrFactors( { { 1.0007-1, 0.9904-1, 0.9884-1, 0.9128-1, 0.8114-1,
          0.7833-1, 0.6872-1, 0.6424-1, 0.6424-1 } } ) {
    
    // Declare the properties of the tool:
    declareProperty( "TruthJetContainer",
             m_truthJetContainer = "AntiKt4TruthWZJets" );
    declareProperty( "TruthParticleContainer",
             m_truthParticleContainer = "TruthParticles" );
  }

Member Function Documentation

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

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

◆ getSherpa22VJets_NJet()

size_t PMGTools::PMGSherpa22VJetsWeightTool::getSherpa22VJets_NJet ( const std::string & jetcontainer ) const

Function returns number of jets required for correction.

Definition at line 89 of file PMGSherpa22VJetsWeightTool.cxx.

                                                               {
    
    //
    // Count number of truthjets compatible with evaluation of correction
    //
    
    // Check whether to do overlap removal with truth leptons:
    const bool doRemoval = ( jetContainer == "AntiKt4TruthJets" );
    
    // Retrieve the truth jets
    const xAOD::JetContainer* truthJets( 0 );
    if( evtStore()->retrieve( truthJets, jetContainer ).isFailure() ) {
      ATH_MSG_ERROR( "Couldn't retrieve truth jet container: "
                     << jetContainer );
      return 0;
    }
    
    size_t nTruthJets = 0;  
    
    // Retrieve the truth particles to get the leptons
    const xAOD::TruthParticleContainer* truthParticles( 0 );
    if( doRemoval ) {
      if( evtStore()->retrieve( truthParticles,
                                m_truthParticleContainer ).isFailure() ) {
    ATH_MSG_ERROR( "Couldn't retrieve truth particle container: "
               << m_truthParticleContainer );
    return 0;
      }
    }
    
    // Loop over all truth jets passing basic cuts:
    for( const xAOD::Jet* truthJet : *truthJets ) {
      
      // Start with a simple kinematic cut:
      if( truthJet->pt() <= 20000. || std::abs( truthJet->eta() ) >= 4.5 ) {
    continue;
      }
      
      // Remove hadronic taus e.g. from Ztautau, Wtaunu decays
      static const SG::AuxElement::ConstAccessor< int >
    acc( "HadronConeExclTruthLabelID" );
      if( acc.isAvailable( *truthJet ) && ( acc( *truthJet ) == 15 ) ) {
    continue;
      }
      
      // If no overlap removal is to be made, we're done already:
      if( ! doRemoval ) {
    ++nTruthJets;
    continue;
      }
      
      // Loop over the truth particles, to veto some jets:
      bool vetoJet = false;
      for( const xAOD::TruthParticle* truthParticle : *truthParticles ) {
    
    // Only select final state electrons and muons:
    if( !MC::isStable(truthParticle) ||
        (  !MC::isElectron(truthParticle)  &&
           !MC::isMuon( truthParticle)  ) ) {
      continue;
    }
    // ...which also pass some basic kinematic cuts:
    if( ( truthParticle->pt() <= 20000.0 ) ||
        ( std::abs( truthParticle->eta() ) >= 4.5 ) ) {
      continue;
    }
    
    // Veto the jet if it's close to this lepton:
    static const double MIN_DISTANCE = 0.2 * 0.2;
    const double dR2 =
      xAOD::P4Helpers::deltaR2( truthJet, truthParticle, true );
    if( dR2 < MIN_DISTANCE ) {
      vetoJet = true;
      break;
    }
      }
      
      // If the jet was not vetoed:
      if( ! vetoJet ) {
    ++nTruthJets;
      }
    }
    
    // Return the calculated value:
    return nTruthJets;
  }

◆ getSherpa22VJets_NJetCorrection() [1/2]

double PMGTools::PMGSherpa22VJetsWeightTool::getSherpa22VJets_NJetCorrection ( const std::string & jetcontainer ) const

Input is the truth collection string Antikt4TruthJets or Antikt4TruthWZJets.

Definition at line 80 of file PMGSherpa22VJetsWeightTool.cxx.

                                                                         {
    
    // Count truth jets in collection, return correction:
    const size_t nTruthJets = getSherpa22VJets_NJet( jetContainer );
    // Use this in the correction calculation:
    return getSherpa22VJets_NJetCorrection( nTruthJets );
  }

◆ getSherpa22VJets_NJetCorrection() [2/2]

double PMGTools::PMGSherpa22VJetsWeightTool::getSherpa22VJets_NJetCorrection ( size_t ntag ) const

Return correction for given jet multiplicity.

Definition at line 63 of file PMGSherpa22VJetsWeightTool.cxx.

                                                            {
    
    // See https://twiki.cern.ch/twiki/bin/viewauth/AtlasProtected/CentralMC15ProductionList#NEW_Sherpa_v2_2_V_jets_NJet_rewe
    // Function of njettruth which is the number of truth jets with
    // pt>20 and |eta|<4.5
    
    // Use the last bin if we have more jets than what we have correction
    // factors for.
    if( njettruth >= m_corrFactors.size() ) {
      njettruth = m_corrFactors.size() - 1;
    }
    
    // Return the right value:
    return 1.0 + m_corrFactors[ njettruth ];
  }

◆ getWeight()

double PMGTools::PMGSherpa22VJetsWeightTool::getWeight ( ) const

overridevirtual

Sherpa 2.2 V+jets jet multiplicity reweight to fix issue from scale settings used in pTV sliced samples.

Finds truth collections on the input file and returns weight (returns 0 if no collections found)

Returns: The weight to be used. Or 0 if no truth het container is found.

Implements IWeightTool.

Definition at line 50 of file PMGSherpa22VJetsWeightTool.cxx.

                                                     {
    
    // Check if the configured truth jet container is available:
    if( ! evtStore()->contains< xAOD::JetContainer >( m_truthJetContainer ) ) {
      ATH_MSG_WARNING( "No TruthJetContainer (\"" << m_truthJetContainer
                       << "\") found! Dummy null weight retrieved." );
      return 0.;
    }
    
    // Calculate the weight:
    return getSherpa22VJets_NJetCorrection( m_truthJetContainer );
  }

◆ initialize()

StatusCode PMGTools::PMGSherpa22VJetsWeightTool::initialize ( void )

finaloverridevirtual

Initialize is required by AsgTool base class.

Reimplemented from asg::AsgTool.

Definition at line 31 of file PMGSherpa22VJetsWeightTool.cxx.

                                                    {
    
    // Tell the user what's happening:
    ATH_MSG_INFO( "Initializing " << name() << "..." );
    ATH_MSG_DEBUG( "Will be using:" );
    ATH_MSG_DEBUG( "  TruthJetContainer      = " << m_truthJetContainer );
    ATH_MSG_DEBUG( "  TruthParticleContainer = " << m_truthParticleContainer );
    
    // Ensure that the overall normalisation agrees with the Strict
    // integration setting
    static const double NORM = 1.007;
    for( double& corr : m_corrFactors ) {
      corr *= NORM;
    }
    
    // Return gracefully:
    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()

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

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

std::array< double, NJET_CORRECTION_BINS > PMGTools::PMGSherpa22VJetsWeightTool::m_corrFactors

private

Correction factors used in the weight calculation.

Definition at line 84 of file PMGSherpa22VJetsWeightTool.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_truthJetContainer

std::string PMGTools::PMGSherpa22VJetsWeightTool::m_truthJetContainer

private

The truth jet container to use for the calculation.

Definition at line 90 of file PMGSherpa22VJetsWeightTool.h.

◆ m_truthParticleContainer

std::string PMGTools::PMGSherpa22VJetsWeightTool::m_truthParticleContainer

private

The truth particle container to use for the calculation.

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

◆ NJET_CORRECTION_BINS

const size_t PMGTools::PMGSherpa22VJetsWeightTool::NJET_CORRECTION_BINS = 9

staticprivate

Number of jet multiplicities that we have a correction for.

Definition at line 82 of file PMGSherpa22VJetsWeightTool.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

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ PMGSherpa22VJetsWeightTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ getSherpa22VJets_NJet()

◆ getSherpa22VJets_NJetCorrection() [1/2]

◆ getSherpa22VJets_NJetCorrection() [2/2]

◆ getWeight()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_corrFactors

◆ m_detStore

◆ m_evtStore

◆ m_truthJetContainer

◆ m_truthParticleContainer

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ NJET_CORRECTION_BINS