met::METNet Class Reference

METNet tool class used to create a missing transverse momentum estimate using a pre-trained neural network. More...

#include <METNet.h>

Inheritance diagram for met::METNet:

Collaboration diagram for met::METNet:

Public Member Functions
	METNet (const std::string &name)
virtual	~METNet ()=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual StatusCode	rebuildMET (const std::string &metKey, xAOD::Type::ObjectType metType, xAOD::MissingETContainer *metCont, const xAOD::IParticleContainer *collection, xAOD::MissingETAssociationHelper &helper, MissingETBase::UsageHandler::Policy objScale) const override
virtual StatusCode	rebuildJetMET (const std::string &metJetKey, const std::string &softTrkKey, xAOD::MissingETContainer *metCont, const xAOD::JetContainer *jets, const xAOD::MissingETContainer *metCoreCont, xAOD::MissingETAssociationHelper &helper, bool doJetJVT=false) const override
virtual StatusCode	evaluateNNMET (const std::string &totalName, xAOD::MissingETContainer *metCont) const override
virtual StatusCode	rebuildMET (xAOD::MissingET *met, const xAOD::IParticleContainer *collection, xAOD::MissingETAssociationHelper &helper, MissingETBase::UsageHandler::Policy objScale) const override
virtual StatusCode	rebuildMET (xAOD::MissingET *met, const xAOD::IParticleContainer *collection, xAOD::MissingETAssociationHelper &helper, MissingETBase::UsageHandler::Policy p, bool removeOverlap, MissingETBase::UsageHandler::Policy objScale) const override
virtual StatusCode	rebuildJetMET (const std::string &metJetKey, const std::string &softClusKey, const std::string &softTrkKey, xAOD::MissingETContainer *metCont, const xAOD::JetContainer *jets, const xAOD::MissingETContainer *metCoreCont, xAOD::MissingETAssociationHelper &helper, bool doJetJVT) const override
virtual StatusCode	rebuildJetMET (xAOD::MissingET *metJet, const xAOD::JetContainer *jets, xAOD::MissingETAssociationHelper &helper, xAOD::MissingET *metSoftClus, const xAOD::MissingET *coreSoftClus, xAOD::MissingET *metSoftTrk, const xAOD::MissingET *coreSoftTrk, bool doJetJVT, bool tracksForHardJets=false, std::vector< const xAOD::IParticle * > *softConst=0) const override
virtual StatusCode	rebuildTrackMET (const std::string &metJetKey, const std::string &softTrkKey, xAOD::MissingETContainer *metCont, const xAOD::JetContainer *jets, const xAOD::MissingETContainer *metCoreCont, xAOD::MissingETAssociationHelper &helper, bool doJetJVT) const override
virtual StatusCode	rebuildTrackMET (xAOD::MissingET *metJet, const xAOD::JetContainer *jets, xAOD::MissingETAssociationHelper &helper, xAOD::MissingET *metSoftTrk, const xAOD::MissingET *coreSoftTrk, bool doJetJVT) const override
virtual StatusCode	markInvisible (const xAOD::IParticleContainer *collection, xAOD::MissingETAssociationHelper &helper, xAOD::MissingETContainer *metCont) const override
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	addMETFinal (const std::string &WP_name, xAOD::MissingETContainer *met_container, std::vector< std::string > &name_vec, std::vector< float > &val_vec) const
StatusCode	addMETTerm (const std::string &WP_name, xAOD::MissingET *met, std::vector< std::string > &name_vec, std::vector< float > &val_vec) const
StatusCode	addInputValue (const std::string &var_name, float value, std::vector< std::string > &name_vec, std::vector< float > &val_vec) const
StatusCode	copyMETContainer (xAOD::MissingETContainer *new_container, const xAOD::MissingETContainer *old_container) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< std::string >	m_netLocation {this, "NetworkFile", "", "Location of NN file to use"}
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this, "EventInfoKey", "EventInfo", "Event info key"}
SG::ReadHandleKey< xAOD::VertexContainer >	m_pvContainerKey {this, "PVContainerKey", "PrimaryVertices", "Primary vertex container"}
SG::ReadHandleKey< xAOD::JetContainer >	m_jetContainerKey {this, "JetContainer", "", "Name of input jet container"}
std::unique_ptr< const METNetHandler >	m_metNetHandler
ToolHandle< IMETMaker >	m_metmaker_loose {this, "METMakerLoose", "", "METMaker for Loose WP. Do not configure manually except for expert usage." }
ToolHandle< IMETMaker >	m_metmaker_tight {this, "METMakerTight", "", "METMaker for Tight WP. Do not configure manually except for expert usage." }
ToolHandle< IMETMaker >	m_metmaker_tghtr {this, "METMakerTighter", "", "METMaker for Tighter WP. Do not configure manually except for expert usage." }
ToolHandle< IMETMaker >	m_metmaker_tenac {this, "METMakerTenacious", "", "METMaker for Tenacious WP. Do not configure manually except for expert usage." }
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

METNet tool class used to create a missing transverse momentum estimate using a pre-trained neural network.

The tool inherits from the same interface as METMaker and so it should be largely interchangable. However, it does not use every public method as METMaker, as it must ensure that the exact variables are constructed for the network's inputs. Uses an ONNX runtime environment for inference.

Definition at line 42 of file METNet.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

METNet()

met::METNet::METNet

(

const std::string &

name

)

Definition at line 42 of file METNet.cxx.

                                     :
    AsgTool(name){}

~METNet()

virtual met::METNet::~METNet ( )

virtualdefault

Member Function Documentation

addInputValue()

StatusCode met::METNet::addInputValue ( const std::string & var_name, float value, std::vector< std::string > & name_vec, std::vector< float > & val_vec ) const

private

Definition at line 298 of file METNet.cxx.

                                                                      {
    // This is the only place we push_back to either vector
    // Ensuring that they are always consistant with each other!!
    ATH_MSG_VERBOSE( "Adding variable: " << var_name << " = " << value << " to the network input vector" );
    name_vec.push_back( var_name );
    val_vec.push_back( value );
    return StatusCode::SUCCESS;
  }

addMETFinal()

StatusCode met::METNet::addMETFinal ( const std::string & WP_name, xAOD::MissingETContainer * met_container, std::vector< std::string > & name_vec, std::vector< float > & val_vec ) const

private

Definition at line 264 of file METNet.cxx.

                                                                    {
    // Add the jet, soft, and final terms to the vector
    ATH_CHECK( addMETTerm( WP_name, (*met_container)["RefJet"], name_vec, val_vec ) );
    ATH_CHECK( addMETTerm( WP_name, (*met_container)["PVSoftTrk"], name_vec, val_vec ) );
    ATH_CHECK( addMETTerm( WP_name, (*met_container)["FinalTrk"], name_vec, val_vec ) );
    ATH_CHECK( addMETTerm( WP_name, (*met_container)["SoftClus"], name_vec, val_vec ) );
    ATH_CHECK( addMETTerm( WP_name, (*met_container)["FinalClus"], name_vec, val_vec ) );
    return StatusCode::SUCCESS;
  }

addMETTerm()

StatusCode met::METNet::addMETTerm ( const std::string & WP_name, xAOD::MissingET * met, std::vector< std::string > & name_vec, std::vector< float > & val_vec ) const

private

Definition at line 277 of file METNet.cxx.

                                                                   {
 
    if(!met){
      ATH_MSG_ERROR("addMETTerm was called with a null pointer for the input MET value!");
      return StatusCode::FAILURE;
    }
 
    // Build the name of the term from the WP and the Object type from the container
    std::string tname = WP_name + "_" + met->name();
 
    // Add the MET components and SumET
    ATH_CHECK( addInputValue( tname+"_mpx",   met->mpx(),   name_vec, val_vec ) );
    ATH_CHECK( addInputValue( tname+"_mpy",   met->mpy(),   name_vec, val_vec ) );
    ATH_CHECK( addInputValue( tname+"_sumet", met->sumet(), name_vec, val_vec ) );
 
    return StatusCode::SUCCESS;
  }

copyMETContainer()

StatusCode met::METNet::copyMETContainer ( xAOD::MissingETContainer * new_container, const xAOD::MissingETContainer * old_container ) const

private

Definition at line 310 of file METNet.cxx.

                                                                                          {
    xAOD::MissingET* blank_met;
 
    for ( const xAOD::MissingET* old_met : *old_container ) {
      blank_met = nullptr;
      const std::string& name = old_met->name();
 
      ATH_CHECK( fillMET( blank_met, new_container, name, old_met->source() ) ); // Initialize the blank met with the new name in the new container
      *(*new_container)[name] = *(*old_container)[name];                         // Copy over the contents of this "term" from old container to new
 
      // Also need to copy the original object links
      dec_constitObjLinks(*(*new_container)[name]) = acc_constitObjLinks(*(*old_container)[name]);
    }
 
    return StatusCode::SUCCESS;
  }

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.

{ return m_detStore; }

evaluateNNMET()

StatusCode met::METNet::evaluateNNMET ( const std::string & totalName, xAOD::MissingETContainer * metCont ) const

overridevirtual

Reimplemented from IMETMaker.

Definition at line 228 of file METNet.cxx.

                                                                           {
 
    // First we check that the container has the correct decorations
    ATH_MSG_VERBOSE( "Checking MET container for network inputs" );
    if ( (*metCont)["NetInputDummy"] == NULL ) {
      ATH_MSG_ERROR( "Could not find the NetInputDummy MET object in the container. Did you run rebuildJetMET?" );
      return StatusCode::FAILURE;
    }
 
    // Pull out the vector from the met containter
    std::vector<float> tmp_inputs = acc_inputvalues(*(*metCont)["NetInputDummy"]);
    ATH_MSG_VERBOSE( "Loaded " << tmp_inputs.size() << " network inputs" );
 
    // Check that the list of inputs matches the network size
    if ( tmp_inputs.size() != m_metNetHandler->getReqSize() ) {
      ATH_MSG_ERROR( "The MET container provided " << tmp_inputs.size()
                      << " elements, but the ONNX network needs exactly " << m_metNetHandler->getReqSize() << "!" );
      return StatusCode::FAILURE;
    }
 
    // Passing the inputs through the network
    std::vector<float> net_met;
    m_metNetHandler->predict(net_met, tmp_inputs);
 
    // Adding the network output to the Final Met container
    xAOD::MissingET* metFinal = nullptr;
    ATH_CHECK( fillMET( metFinal, metCont, totalName, MissingETBase::Source::total() ) );
    metFinal->setMpx( net_met[0] );
    metFinal->setMpy( net_met[1] );
 
    ATH_MSG_VERBOSE( "Writing the Final Network MET: (" << net_met[0] << ", " << net_met[1] << ")" );
 
    return StatusCode::SUCCESS;
  }

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.

{ 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 met::METNet::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 45 of file METNet.cxx.

                                {
    ATH_MSG_INFO( "Initializing " << name() << "..." );
 
    ATH_CHECK(m_eventInfoKey.initialize());
    ATH_CHECK(m_pvContainerKey.initialize());
    ATH_CHECK(m_jetContainerKey.initialize());
 
    if( m_netLocation.empty()){
      ATH_MSG_ERROR("NetworkFile property was not specified!");
      return StatusCode::FAILURE;
    }
    std::string netFilePath = PathResolverFindCalibFile(m_netLocation);
    std::unique_ptr<METNetHandler> metNetHandler = std::make_unique<METNetHandler>( netFilePath );
    if( metNetHandler->initialize() != 0){
      ATH_MSG_ERROR("METNet model file not found!");
      return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("Resolved METNet ONNX file at " + netFilePath);
    m_metNetHandler = std::move(metNetHandler);
 
    if(m_metmaker_loose.empty()){
      asg::AsgToolConfig toolConfig("met::METMaker/metmaker_loose");
      ATH_CHECK( toolConfig.setProperty("JetContainer", m_jetContainerKey.key()) );
      ATH_CHECK( toolConfig.setProperty("DoPFlow", true) );
      ATH_CHECK( toolConfig.setProperty("JetSelection", "Loose") );
      ATH_CHECK( toolConfig.makePrivateTool(m_metmaker_loose) );
    }
    ATH_CHECK( m_metmaker_loose.retrieve() );
 
    if(m_metmaker_tight.empty()){
      asg::AsgToolConfig toolConfig("met::METMaker/metmaker_tight");
      ATH_CHECK( toolConfig.setProperty("JetContainer", m_jetContainerKey.key()) );
      ATH_CHECK( toolConfig.setProperty("DoPFlow", true) );
      ATH_CHECK( toolConfig.setProperty("JetSelection", "Tight") );
      ATH_CHECK( toolConfig.makePrivateTool(m_metmaker_tight) );
    }
    ATH_CHECK( m_metmaker_tight.retrieve() );
 
    if(m_metmaker_tghtr.empty()){
      asg::AsgToolConfig toolConfig("met::METMaker/metmaker_tghtr");
      ATH_CHECK( toolConfig.setProperty("JetContainer", m_jetContainerKey.key()) );
      ATH_CHECK( toolConfig.setProperty("DoPFlow", true) );
      ATH_CHECK( toolConfig.setProperty("JetSelection", "Tighter") );
      ATH_CHECK( toolConfig.makePrivateTool(m_metmaker_tghtr) );
    }
    ATH_CHECK( m_metmaker_tghtr.retrieve() );
 
    if(m_metmaker_tenac.empty()){
      asg::AsgToolConfig toolConfig("met::METMaker/metmaker_tenac");
      ATH_CHECK( toolConfig.setProperty("JetContainer", m_jetContainerKey.key()) );
      ATH_CHECK( toolConfig.setProperty("DoPFlow", true) );
      ATH_CHECK( toolConfig.setProperty("JetSelection", "Tenacious") );
      ATH_CHECK( toolConfig.makePrivateTool(m_metmaker_tenac) );
    }
    ATH_CHECK( m_metmaker_tenac.retrieve() );
 
    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.

markInvisible()

StatusCode met::METNet::markInvisible ( const xAOD::IParticleContainer * collection, xAOD::MissingETAssociationHelper & helper, xAOD::MissingETContainer * metCont ) const

overridevirtual

Implements IMETMaker.

Definition at line 421 of file METNet.cxx.

                                                                    {
    ATH_MSG_ERROR( "METNet does not support markInvisible!");
    return StatusCode::FAILURE;
  }

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

rebuildJetMET() [1/3]

StatusCode met::METNet::rebuildJetMET ( const std::string & metJetKey, const std::string & softClusKey, const std::string & softTrkKey, xAOD::MissingETContainer * metCont, const xAOD::JetContainer * jets, const xAOD::MissingETContainer * metCoreCont, xAOD::MissingETAssociationHelper & helper, bool doJetJVT ) const

overridevirtual

Implements IMETMaker.

Definition at line 113 of file METNet.cxx.

                                                 {
 
    // Retrieving the event information (Needed for METSig, so we do it early)
    SG::ReadHandle<xAOD::EventInfo> ei(m_eventInfoKey);
 
    float avgmu = ei->averageInteractionsPerCrossing();
    float actmu = ei->actualInteractionsPerCrossing();
 
    // Creating the new containers for all the WPs
    auto metCont_loose = std::make_shared<xAOD::MissingETContainer>();
    auto metCont_looseAux = std::make_shared<xAOD::MissingETAuxContainer>();
    metCont_loose->setStore( metCont_looseAux.get() );
 
    auto metCont_tight = std::make_shared<xAOD::MissingETContainer>();
    auto metCont_tightAux = std::make_shared<xAOD::MissingETAuxContainer>();
    metCont_tight->setStore( metCont_tightAux.get() );
 
    auto metCont_tghtr = std::make_shared<xAOD::MissingETContainer>();
    auto metCont_tghtrAux = std::make_shared<xAOD::MissingETAuxContainer>();
    metCont_tghtr->setStore( metCont_tghtrAux.get() );
 
    auto metCont_tenac = std::make_shared<xAOD::MissingETContainer>();
    auto metCont_tenacAux = std::make_shared<xAOD::MissingETAuxContainer>();
    metCont_tenac->setStore( metCont_tenacAux.get() );
 
    // Copying the contents of the original container into each WP container
    // Avoids redundant calculation of identical terms.
    ATH_MSG_VERBOSE( "Making copies of base MET container" );
    ATH_CHECK( copyMETContainer( metCont_loose.get(), metCont ) );
    ATH_CHECK( copyMETContainer( metCont_tight.get(), metCont ) );
    ATH_CHECK( copyMETContainer( metCont_tghtr.get(), metCont ) );
    ATH_CHECK( copyMETContainer( metCont_tenac.get(), metCont ) );
 
    // Selected objects may differ between WPs due to jets, muon-in-jet treatment, etc. Need unique helpers, so copy current state.
    xAOD::MissingETAssociationHelper helper_loose(helper);
    xAOD::MissingETAssociationHelper helper_tight(helper);
    xAOD::MissingETAssociationHelper helper_tghtr(helper);
    xAOD::MissingETAssociationHelper helper_tenac(helper);
 
    // Building the jet and soft terms for each WP
    ATH_MSG_VERBOSE( "Building jet and soft terms for each MET WP" );
    ATH_CHECK( m_metmaker_loose->rebuildJetMET(   "RefJet", softClusKey, softTrkKey, metCont_loose.get(), jets, metCoreCont, helper_loose, true ) );
    ATH_CHECK( m_metmaker_tight->rebuildJetMET(   "RefJet", softClusKey, softTrkKey, metCont_tight.get(), jets, metCoreCont, helper_tight, true ) );
    ATH_CHECK( m_metmaker_tghtr->rebuildJetMET(   "RefJet", softClusKey, softTrkKey, metCont_tghtr.get(), jets, metCoreCont, helper_tghtr, true ) );
    ATH_CHECK( m_metmaker_tenac->rebuildJetMET(   "RefJet", softClusKey, softTrkKey, metCont_tenac.get(), jets, metCoreCont, helper_tenac, true ) );
 
    // Building and adding the "Final" MET object to each WP container
    ATH_MSG_VERBOSE( "Building the Final MET object for each MET WP" );
    ATH_CHECK( met::buildMETSum( "FinalTrk",  metCont_loose.get(), static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Signal::Track)) );
    ATH_CHECK( met::buildMETSum( "FinalTrk",  metCont_tight.get(), static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Signal::Track)) );
    ATH_CHECK( met::buildMETSum( "FinalTrk",  metCont_tghtr.get(), static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Signal::Track)) );
    ATH_CHECK( met::buildMETSum( "FinalTrk",  metCont_tenac.get(), static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Signal::Track)) );
    // CST uses the LCTopo source bitmask even if the clusters are actually at EM scale
    ATH_CHECK( met::buildMETSum( "FinalClus", metCont_loose.get(), static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Signal::LCTopo)) );
    ATH_CHECK( met::buildMETSum( "FinalClus", metCont_tight.get(), static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Signal::LCTopo)) );
    ATH_CHECK( met::buildMETSum( "FinalClus", metCont_tghtr.get(), static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Signal::LCTopo)) );
    ATH_CHECK( met::buildMETSum( "FinalClus", metCont_tenac.get(), static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Signal::LCTopo)) );

 
    // Initialise two vectors: One for holding the network input values and another for the input names
    std::vector<std::string> input_names;
    std::vector<float> input_values;
 
    ATH_CHECK( addMETFinal( "Loose", metCont_loose.get(), input_names, input_values ) );
 
    // Tight gets all its hard terms included as well (same as all th others, only needed once)
    ATH_CHECK( addMETTerm( "Tight", *(metCont_tight->find(MissingETBase::Source::electron())), input_names, input_values ) );
    ATH_CHECK( addMETTerm( "Tight", *(metCont_tight->find(MissingETBase::Source::photon())),   input_names, input_values ) );
    ATH_CHECK( addMETTerm( "Tight", *(metCont_tight->find(MissingETBase::Source::tau())),      input_names, input_values ) );
    ATH_CHECK( addMETTerm( "Tight", *(metCont_tight->find(MissingETBase::Source::muon())),     input_names, input_values ) );
    ATH_CHECK( addMETFinal( "Tight", metCont_tight.get(), input_names, input_values ) );
 
    ATH_CHECK( addMETFinal( "Tighter", metCont_tghtr.get(), input_names, input_values ) );
    ATH_CHECK( addMETFinal( "Tenacious", metCont_tenac.get(), input_names, input_values ) );
 
    // Pileup information and tracking information (using the user provided primary vertex container name)
    SG::ReadHandle<xAOD::VertexContainer> pvtxs(m_pvContainerKey);
    if(!pvtxs.isValid()){
      ATH_MSG_ERROR("Could not retrieve primary vertex container!");
      return StatusCode::FAILURE;
    }
    int NVx_2Tracks = 0;
    int NVx_4Tracks = 0;
    int PV_NTracks = 0;
    int n_tracks = 0;
    for ( const xAOD::Vertex* vx : *pvtxs ) {
      n_tracks = vx->nTrackParticles();
      if ( n_tracks>=2 ) NVx_2Tracks++;
      if ( n_tracks>=4 ) NVx_4Tracks++;
      if ( vx->vertexType() == xAOD::VxType::PriVtx ) PV_NTracks = n_tracks;
    }
    ATH_CHECK( addInputValue( "ActualMu",    actmu,       input_names, input_values ) );
    ATH_CHECK( addInputValue( "AverageMu",   avgmu,       input_names, input_values ) );
    ATH_CHECK( addInputValue( "NPV_2Tracks", NVx_2Tracks, input_names, input_values ) );
    ATH_CHECK( addInputValue( "NPV_4Tracks", NVx_4Tracks, input_names, input_values ) );
    ATH_CHECK( addInputValue( "PV_NTracks",  PV_NTracks,  input_names, input_values ) );
 
    // Creating a dummy MET object on the output container to carry the NN features and decorate it with the two vectors
    ATH_MSG_VERBOSE( "Saving network inputs to base MET container" );
    xAOD::MissingET* net_inpts = nullptr;
    ATH_CHECK( fillMET( net_inpts, metCont, "NetInputDummy", static_cast<MissingETBase::Types::bitmask_t>(MissingETBase::Source::Type::UnknownType) ) );
    dec_inputnames( *(*metCont)["NetInputDummy"] ) = input_names;
    dec_inputvalues( *(*metCont)["NetInputDummy"] ) = input_values;
 
    return StatusCode::SUCCESS;
  }

rebuildJetMET() [2/3]

StatusCode met::METNet::rebuildJetMET ( const std::string & metJetKey, const std::string & softTrkKey, xAOD::MissingETContainer * metCont, const xAOD::JetContainer * jets, const xAOD::MissingETContainer * metCoreCont, xAOD::MissingETAssociationHelper & helper, bool doJetJVT = false ) const

overridevirtual

Implements IMETMaker.

Definition at line 364 of file METNet.cxx.

                                                        {
    return rebuildJetMET(metJetKey, "SoftClus", "PVSoftTrk", metCont, jets, metCoreCont, helper, doJetJVT);
  }

rebuildJetMET() [3/3]

StatusCode met::METNet::rebuildJetMET ( xAOD::MissingET * metJet, const xAOD::JetContainer * jets, xAOD::MissingETAssociationHelper & helper, xAOD::MissingET * metSoftClus, const xAOD::MissingET * coreSoftClus, xAOD::MissingET * metSoftTrk, const xAOD::MissingET * coreSoftTrk, bool doJetJVT, bool tracksForHardJets = false, std::vector< const xAOD::IParticle * > * softConst = 0 ) const

overridevirtual

Implements IMETMaker.

Definition at line 374 of file METNet.cxx.

                                                                             {
    ATH_MSG_ERROR( "METNet has not overloaded this version of rebuildJetMET from IMETMaker!\n"
                   "Please use the method with the following arguments:\n"
                   "StatusCode METNet::rebuildJetMET(\n"
                      "const std::string& metJetKey,\n"
                      "const std::string& softClusKey,\n"
                      "const std::string& softTrkKey,\n"
                      "xAOD::MissingETContainer* metCont,\n"
                      "const xAOD::JetContainer* jets,\n"
                      "const xAOD::MissingETContainer* metCoreCont,\n"
                      "xAOD::MissingETAssociationHelper& helper,\n"
                      "bool doJetJVT\n"
                    ")" );
    return StatusCode::FAILURE;
  }

rebuildMET() [1/3]

StatusCode met::METNet::rebuildMET ( const std::string & metKey, xAOD::Type::ObjectType metType, xAOD::MissingETContainer * metCont, const xAOD::IParticleContainer * collection, xAOD::MissingETAssociationHelper & helper, MissingETBase::UsageHandler::Policy objScale ) const

overridevirtual

Implements IMETMaker.

Definition at line 104 of file METNet.cxx.

                                                                                  {
    return m_metmaker_tight->rebuildMET( metKey, metType, metCont, collection, helper, objScale );
  }

rebuildMET() [2/3]

StatusCode met::METNet::rebuildMET ( xAOD::MissingET * met, const xAOD::IParticleContainer * collection, xAOD::MissingETAssociationHelper & helper, MissingETBase::UsageHandler::Policy objScale ) const

overridevirtual

Implements IMETMaker.

Definition at line 328 of file METNet.cxx.

                                                                         {
    ATH_MSG_ERROR( "METNet has not overloaded this version of rebuildMET from IMETMaker!\n"
                   "Please only use this method:\n"
                   "StatusCode METMaker::rebuildMET("
                      "const std::string& metKey,\n"
                      "xAOD::Type::ObjectType metType,\n"
                      "xAOD::MissingETContainer* metCont,\n"
                      "const xAOD::IParticleContainer* collection,\n"
                      "xAOD::MissingETAssociationHelper& helper,\n"
                      "MissingETBase::UsageHandler::Policy objScale\n"
                    ")" );
    return StatusCode::FAILURE;
  }

rebuildMET() [3/3]

StatusCode met::METNet::rebuildMET ( xAOD::MissingET * met, const xAOD::IParticleContainer * collection, xAOD::MissingETAssociationHelper & helper, MissingETBase::UsageHandler::Policy p, bool removeOverlap, MissingETBase::UsageHandler::Policy objScale ) const

overridevirtual

Implements IMETMaker.

Definition at line 345 of file METNet.cxx.

                                                                         {
    ATH_MSG_ERROR( "METNet has not overloaded this version of rebuildMET from IMETMaker!\n"
                   "Please only use this method:\n"
                   "StatusCode METMaker::rebuildMET("
                      "const std::string& metKey,\n"
                      "xAOD::Type::ObjectType metType,\n"
                      "xAOD::MissingETContainer* metCont,\n"
                      "const xAOD::IParticleContainer* collection,\n"
                      "xAOD::MissingETAssociationHelper& helper,\n"
                      "MissingETBase::UsageHandler::Policy objScale\n"
                    ")" );
    return StatusCode::FAILURE;
  }

rebuildTrackMET() [1/2]

StatusCode met::METNet::rebuildTrackMET ( const std::string & metJetKey, const std::string & softTrkKey, xAOD::MissingETContainer * metCont, const xAOD::JetContainer * jets, const xAOD::MissingETContainer * metCoreCont, xAOD::MissingETAssociationHelper & helper, bool doJetJVT ) const

overridevirtual

Implements IMETMaker.

Definition at line 399 of file METNet.cxx.

                                                   {
    ATH_MSG_ERROR( "Please don't use the method METNet::rebuildTrackMET!\n"
                   "It has no use in METNet and is a holdover from its inheritance from IMETMaker." );
    return StatusCode::FAILURE;
  }

rebuildTrackMET() [2/2]

StatusCode met::METNet::rebuildTrackMET ( xAOD::MissingET * metJet, const xAOD::JetContainer * jets, xAOD::MissingETAssociationHelper & helper, xAOD::MissingET * metSoftTrk, const xAOD::MissingET * coreSoftTrk, bool doJetJVT ) const

overridevirtual

Implements IMETMaker.

Definition at line 411 of file METNet.cxx.

                                                   {
    ATH_MSG_ERROR( "METNet does not support Track MET!" );
    return StatusCode::FAILURE;
  }

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_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_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> met::METNet::m_eventInfoKey {this, "EventInfoKey", "EventInfo", "Event info key"}

private

Definition at line 138 of file METNet.h.

{this, "EventInfoKey", "EventInfo", "Event info key"};

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_jetContainerKey

SG::ReadHandleKey<xAOD::JetContainer> met::METNet::m_jetContainerKey {this, "JetContainer", "", "Name of input jet container"}

private

Definition at line 140 of file METNet.h.

{this, "JetContainer", "", "Name of input jet container"};

m_metmaker_loose

ToolHandle<IMETMaker> met::METNet::m_metmaker_loose {this, "METMakerLoose", "", "METMaker for Loose WP. Do not configure manually except for expert usage." }

private

Definition at line 144 of file METNet.h.

{this, "METMakerLoose",     "", "METMaker for Loose WP. Do not configure manually except for expert usage." };

m_metmaker_tenac

ToolHandle<IMETMaker> met::METNet::m_metmaker_tenac {this, "METMakerTenacious", "", "METMaker for Tenacious WP. Do not configure manually except for expert usage." }

private

Definition at line 147 of file METNet.h.

{this, "METMakerTenacious", "", "METMaker for Tenacious WP. Do not configure manually except for expert usage." };

m_metmaker_tghtr

ToolHandle<IMETMaker> met::METNet::m_metmaker_tghtr {this, "METMakerTighter", "", "METMaker for Tighter WP. Do not configure manually except for expert usage." }

private

Definition at line 146 of file METNet.h.

{this, "METMakerTighter",   "", "METMaker for Tighter WP. Do not configure manually except for expert usage." };

m_metmaker_tight

ToolHandle<IMETMaker> met::METNet::m_metmaker_tight {this, "METMakerTight", "", "METMaker for Tight WP. Do not configure manually except for expert usage." }

private

Definition at line 145 of file METNet.h.

{this, "METMakerTight",     "", "METMaker for Tight WP. Do not configure manually except for expert usage." };

m_metNetHandler

std::unique_ptr<const METNetHandler> met::METNet::m_metNetHandler

private

Definition at line 142 of file METNet.h.

m_netLocation

Gaudi::Property<std::string> met::METNet::m_netLocation {this, "NetworkFile", "", "Location of NN file to use"}

private

Definition at line 136 of file METNet.h.

{this, "NetworkFile", "", "Location of NN file to use"};

m_pvContainerKey

SG::ReadHandleKey<xAOD::VertexContainer> met::METNet::m_pvContainerKey {this, "PVContainerKey", "PrimaryVertices", "Primary vertex container"}

private

Definition at line 139 of file METNet.h.

{this, "PVContainerKey", "PrimaryVertices", "Primary vertex container"};

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:

• METNet.h
• METNet.cxx