#include <TopOtherCPTools.h>

Inheritance diagram for top::OtherCPTools:

Collaboration diagram for top::OtherCPTools:

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

virtual	~OtherCPTools ()

StatusCode	initialize ()
	Dummy implementation of the initialisation function. 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
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
StatusCode	setupGRL ()

StatusCode	setupPileupReweighting ()

StatusCode	setupPMGTools ()

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
std::shared_ptr< top::TopConfig >	m_config

ToolHandle< IGoodRunsListSelectionTool >	m_grlTool

ToolHandle< CP::IPileupReweightingTool >	m_pileupReweightingTool

ToolHandle< PMGTools::PMGSherpa22VJetsWeightTool >	m_pmg_sherpa22_vjets_tool

ToolHandle< PMGTools::IPMGTruthWeightTool >	m_pmg_weightTool

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 31 of file TopOtherCPTools.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

◆ OtherCPTools()

top::OtherCPTools::OtherCPTools ( const std::string & name )

explicit

Definition at line 28 of file TopOtherCPTools.cxx.

                                                   :
     asg::AsgTool(name) {
     declareProperty("config", m_config);
  
     declareProperty("GRLTool", m_grlTool);
   }

◆ ~OtherCPTools()

virtual top::OtherCPTools::~OtherCPTools ( )

inlinevirtual

Definition at line 34 of file TopOtherCPTools.h.

34 {}

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

◆ 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 top::OtherCPTools::initialize ( )

virtual

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 35 of file TopOtherCPTools.cxx.

                                       {
     ATH_MSG_INFO("top::OtherCPTools initialize...");
  
     if (!m_config->isMC() || m_config->PileupUseGRLTool()) top::check(setupGRL(), "Failed to setup GRL tool");
  
     if (m_config->doPileupReweighting()) top::check(setupPileupReweighting(), "Failed to setup pile-up reweighting");
  
     if (m_config->isMC()) top::check(setupPMGTools(), "Failed to setup PMG tools");
  
     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, top::TopObjectSelection, 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();
   }

◆ setupGRL()

StatusCode top::OtherCPTools::setupGRL ( )

private

Definition at line 47 of file TopOtherCPTools.cxx.

                                     {
     using IGRLTool = IGoodRunsListSelectionTool;
     const std::string grl_tool_name = "GoodRunsListSelectionTool";
     if (asg::ToolStore::contains<IGRLTool>(grl_tool_name)) {
       m_grlTool = asg::ToolStore::get<IGRLTool>(grl_tool_name);
     } else {
       if (!m_config->grlFile().size()) {
         // do not configure GRL tool
         ATH_MSG_WARNING("No GRL files provided -> Will NOT setup GoodRunsListSelectionTool.");
         return StatusCode::SUCCESS;
       }
  
       IGRLTool* grlTool = new GoodRunsListSelectionTool(grl_tool_name);
       std::vector<std::string> names = {};
       std::string grlDir = m_config->grlDir();
       if (grlDir.size()) grlDir += "/";
       for (const std::string& grl : m_config->grlFile()) {
         names.push_back(PathResolverFindCalibFile(grlDir + grl));
       }
  
       top::check(asg::setProperty(grlTool, "GoodRunsListVec", names),
                  "GRLSelector failed to set GRL");
       top::check(grlTool->initialize(),
                  "Failed to initialize GRLSelectionTool");
       m_grlTool = grlTool;
     }
     return StatusCode::SUCCESS;
   }

◆ setupPileupReweighting()

StatusCode top::OtherCPTools::setupPileupReweighting ( )

private

Definition at line 76 of file TopOtherCPTools.cxx.

                                                   {
     const std::string prw_tool_name = "PileupReweightingTool";
  
     auto GetDefaultPRW = [this](bool isFS) {
       // example path: dev/PileupReweighting/share/DSID410xxx/pileup_mc20e_dsid410470_FS.root
       std::string path = "dev/PileupReweighting/share/DSID";
       const int dsid = this->m_config->getDSID();
       const std::string year = this->m_config->getYear();
       std::string campaign("mc20a");
       if (year == "2017") campaign = "mc20d";
       else if (year == "2018") campaign = "mc20e";
       path += std::to_string(dsid/1000) + "xxx/";
       path += "pileup_" + campaign + "_dsid" + std::to_string(dsid) + "_";
       path += isFS ? "FS" : "AFII";
       path += ".root";
  
       // if running on data, give any valid MC file
       if (!this->m_config->isMC()) path = "dev/PileupReweighting/share/DSID410xxx/pileup_mc20e_dsid410470_FS.root";
  
       ATH_MSG_INFO("Using the default PRW file: " + path);
  
       return path;
     };
  
     if (asg::ToolStore::contains<CP::IPileupReweightingTool>(prw_tool_name)) {
       m_pileupReweightingTool = asg::ToolStore::get<CP::IPileupReweightingTool>(prw_tool_name);
     } else {
       CP::IPileupReweightingTool* pileupReweightingTool
         = new CP::PileupReweightingTool(prw_tool_name);
  
       std::vector<std::string> pileup_config = m_config->PileupConfig();
       for (std::string& s : pileup_config)
         s = PathResolverFindCalibFile(s);
  
       std::vector<std::string> pileup_lumi_calc = m_config->PileupLumiCalc();
       for (std::string& s : pileup_lumi_calc)
         s = PathResolverFindCalibFile(s);
  
       std::vector<std::string> pileup_config_FS = m_config->PileupConfig_FS();
       if (pileup_config_FS.empty() && !m_config->isAFII()) {
         pileup_config_FS.emplace_back(PathResolverFindCalibFile(GetDefaultPRW(true)));
       } else {
         for (std::string& s : pileup_config_FS) {
           s = PathResolverFindCalibFile(s);
         }
       }
  
       std::vector<std::string> pileup_config_AF = m_config->PileupConfig_AF();
       if (pileup_config_AF.empty() && m_config->isAFII()) {
         pileup_config_AF.emplace_back(PathResolverFindCalibFile(GetDefaultPRW(false)));
       } else {
         for (std::string& s : pileup_config_AF)
           s = PathResolverFindCalibFile(s);
       }
  
       std::vector<std::string> actual_mu_FS = m_config->PileupActualMu_FS();
       for (std::string& s : actual_mu_FS)
         s = PathResolverFindCalibFile(s);
  
       std::vector<std::string> actual_mu_AF = m_config->PileupActualMu_AF();
       for (std::string& s : actual_mu_AF)
         s = PathResolverFindCalibFile(s);
  
       // New checks - If FS or AF size != 0, then the general option should be empty
       if ((pileup_config_AF.size() > 0 || pileup_config_FS.size() > 0) && (pileup_config.size() > 0)) {
         ATH_MSG_ERROR("You have used PRWConfigFiles as well as PRWConfigFiles_FS and/or PRWConfigFiles_AF");
         ATH_MSG_ERROR("We do not know how to configure with all these options");
         return StatusCode::FAILURE;
       }
  
       if (m_config->PileupUseGRLTool()) top::check(asg::setProperty(pileupReweightingTool, "GRLTool", m_grlTool),
                                                    "Failed to give GRLtool to pileup reweighting tool");
  
       // Config file is not needed on Data
       // see "Just random run numbers and lumi corrections"
       // case in twiki page below
       // However, the tool would spit out warnings for Data if we didn't supply ConfigFiles.
       if (pileup_config.size() > 0) {
         ATH_MSG_INFO("PRW tool is being configured without any FS/AF information");
         top::check(asg::setProperty(pileupReweightingTool, "ConfigFiles", pileup_config),
                    "Failed to set pileup reweighting config files");
       } else if (m_config->isAFII() && pileup_config_AF.size() > 0) {
         // concatenate the config and the actual mu files
         std::vector<std::string> final_config_AF = pileup_config_AF;
         final_config_AF.insert(final_config_AF.end(), actual_mu_AF.begin(), actual_mu_AF.end());
         ATH_MSG_INFO("This sample is fast sim");
         ATH_MSG_INFO("PRW tool is being configured only with fast simulation (AF) config files");
         top::check(asg::setProperty(pileupReweightingTool, "ConfigFiles", final_config_AF),
                    "Failed to set pileup reweighting config files");
       } else if (!m_config->isAFII() && pileup_config_FS.size() > 0) {
         // concatenate the config and the actual mu files
         std::vector<std::string> final_config_FS = pileup_config_FS;
         final_config_FS.insert(final_config_FS.end(), actual_mu_FS.begin(), actual_mu_FS.end());
         ATH_MSG_INFO("This sample is full sim");
         ATH_MSG_INFO("PRW tool is being configured only with full simulation (FS) config files");
         top::check(asg::setProperty(pileupReweightingTool, "ConfigFiles", final_config_FS),
                    "Failed to set pileup reweighting config files");
       } else {
         ATH_MSG_ERROR("There are not any PRW config files provided with any allowed options");
         return StatusCode::FAILURE;
       }
       // data scale-factors, initialised to recommended values
       // can also be customised, thanks to PRWCustomScaleFactor option
       double SF_nominal = 1.0 / 1.03;
       double SF_up = 1.0 / 0.99;
       double SF_down = 1.0 / 1.07;
  
       // if custom data SFs
       if (m_config->PileUpCustomScaleFactors().size() != 0) {
         SF_nominal = m_config->PileUpCustomScaleFactors()[0];
         SF_up = m_config->PileUpCustomScaleFactors()[1];
         SF_down = m_config->PileUpCustomScaleFactors()[2];
         ATH_MSG_INFO("Using custom Data Scale-Factors for pile-up reweighting");
         std::ostringstream oss;
         oss << "Nominal:" << SF_nominal << " up:" << SF_up << " down:" << SF_down << std::endl;
         ATH_MSG_INFO(oss.str());
       }
  
       top::check(asg::setProperty(pileupReweightingTool, "LumiCalcFiles", pileup_lumi_calc),
                  "Failed to set pileup reweighting lumicalc files");
       // see [http://cern.ch/go/hx7d]
       top::check(asg::setProperty(pileupReweightingTool, "DataScaleFactor", static_cast<Float_t>(SF_nominal)),
                  "Failed to set pileup reweighting data scale factor");
       top::check(asg::setProperty(pileupReweightingTool, "DataScaleFactorUP", SF_up),
                  "Failed to set pileup reweighting data scale factor up");
       top::check(asg::setProperty(pileupReweightingTool, "DataScaleFactorDOWN", SF_down),
                  "Failed to set pileup reweighting data scale factor down");
       // Set the unrepresented data tolerence (default is 5% same as the PRW tool)
       top::check(asg::setProperty(pileupReweightingTool, "UnrepresentedDataThreshold", m_config->PileupDataTolerance()),
                  "Failed to set pileup reweighting data tolerance");
       if (m_config->PileupPeriodAssignments().size() > 0) {
         // Set the period assignments associated with different running periods
         top::check(asg::setProperty(pileupReweightingTool, "PeriodAssignments", m_config->PileupPeriodAssignments()),
                    "Failed to set pileup reweighting period assignments");
       }
       top::check(pileupReweightingTool->initialize(),
                  "Failed to initialize pileup reweighting tool");
  
       m_pileupReweightingTool = pileupReweightingTool;
     }
     return StatusCode::SUCCESS;
   }

◆ setupPMGTools()

StatusCode top::OtherCPTools::setupPMGTools ( )

private

Definition at line 219 of file TopOtherCPTools.cxx.

                                          {
     // Setup any PMG tools
  
     // Sherpa 2.2 V+jets samples based on the number of truth jets
     const std::string name = "PMGSherpa22VJetsWeightTool";
  
     PMGTools::PMGSherpa22VJetsWeightTool* tool = nullptr;
     if (asg::ToolStore::contains<PMGTools::PMGSherpa22VJetsWeightTool>(name)) {
       tool = asg::ToolStore::get<PMGTools::PMGSherpa22VJetsWeightTool>(name);
     } else {
       tool = new PMGTools::PMGSherpa22VJetsWeightTool(name);
       top::check(asg::setProperty(tool, "TruthJetContainer",
                                   m_config->sgKeyTruthJets()),
                  "Failed to set TruthJetContainer to " + name);
       top::check(tool->initialize(), "Failed to initialize " + name);
     }
     m_pmg_sherpa22_vjets_tool = tool;
  
     // Tool for access truth weights via names
     const std::string truthWeightToolName = "PMGTruthWeightTool";
     PMGTools::PMGTruthWeightTool* truthweightTool = new PMGTools::PMGTruthWeightTool(truthWeightToolName);
     if (truthweightTool->initialize()) {
       m_pmg_weightTool = truthweightTool;
     } else {
       // delete the tool instance, it is half-initialized at best = broken
       // elsewere we won't be able to retrieve a ToolHandle, which indicates to us
       // that we cannot rely on it for this MC sample
       delete truthweightTool;
       ATH_MSG_WARNING("Failed to initialize " << truthWeightToolName << ". Any features depending on PMGTruthWeightTool will not work!");
     }
  
     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_config

std::shared_ptr<top::TopConfig> top::OtherCPTools::m_config

private

Definition at line 38 of file TopOtherCPTools.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_grlTool

ToolHandle<IGoodRunsListSelectionTool> top::OtherCPTools::m_grlTool

private

Definition at line 40 of file TopOtherCPTools.h.

◆ m_pileupReweightingTool

ToolHandle<CP::IPileupReweightingTool> top::OtherCPTools::m_pileupReweightingTool

private

Definition at line 41 of file TopOtherCPTools.h.

◆ m_pmg_sherpa22_vjets_tool

ToolHandle<PMGTools::PMGSherpa22VJetsWeightTool> top::OtherCPTools::m_pmg_sherpa22_vjets_tool

private

Definition at line 42 of file TopOtherCPTools.h.

◆ m_pmg_weightTool

ToolHandle<PMGTools::IPMGTruthWeightTool> top::OtherCPTools::m_pmg_weightTool

private

Definition at line 43 of file TopOtherCPTools.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ OtherCPTools()

◆ ~OtherCPTools()

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

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ setupGRL()

◆ setupPileupReweighting()

◆ setupPMGTools()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_config

◆ m_detStore

◆ m_evtStore

◆ m_grlTool

◆ m_pileupReweightingTool

◆ m_pmg_sherpa22_vjets_tool

◆ m_pmg_weightTool

◆ m_varHandleArraysDeclared

◆ m_vhka