InDetGNNHardScatterSelection::GNN Class Reference

#include <GNN.h>

Collaboration diagram for InDetGNNHardScatterSelection::GNN:

Classes
struct	Decorators

Public Member Functions
	GNN (const std::string &nnFile)
	GNN (GNN &&)
	GNN (const GNN &)
virtual	~GNN ()
virtual void	decorate (const xAOD::Vertex &verrtex) const

Public Attributes
std::shared_ptr< const FlavorTagDiscriminants::OnnxUtil >	m_onnxUtil

Private Types
using	TPC = xAOD::TrackParticleContainer
using	TrackLinks = std::vector< ElementLink< TPC > >
template<typename T >
using	Dec = SG::AuxElement::Decorator< T >
template<typename T >
using	Decs = std::vector< std::pair< std::string, Dec< T > >>

Private Member Functions
std::set< std::string >	createDecorators (const FlavorTagDiscriminants::OnnxUtil::OutputConfig &outConfig)

Private Attributes
std::string	m_input_node_name
std::vector< internal::VarFromVertex >	m_varsFromVertex
std::vector< std::shared_ptr< IConstituentsLoader > >	m_constituentsLoaders
Decorators	m_decorators
float	m_defaultValue {}

Detailed Description

Implementation of the GNN used by the InDetGNNHardScatterSelection::GNNTool

NOTE: The GNN relies on decorations added in InDetGNNHardScatterSelection::VertexDecoratorAlg and as such should only be called from within that algorithm

Author

Jackson Burzynski jacks.nosp@m.on.c.nosp@m.arl.b.nosp@m.urzy.nosp@m.nski@.nosp@m.cern.nosp@m..ch

Definition at line 42 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

Member Typedef Documentation

Dec

template<typename T >

using InDetGNNHardScatterSelection::GNN::Dec = SG::AuxElement::Decorator<T>

private

Definition at line 59 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

Decs

template<typename T >

using InDetGNNHardScatterSelection::GNN::Decs = std::vector<std::pair<std::string, Dec<T> >>

private

Definition at line 62 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

TPC

using InDetGNNHardScatterSelection::GNN::TPC = xAOD::TrackParticleContainer

private

Definition at line 55 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

TrackLinks

using InDetGNNHardScatterSelection::GNN::TrackLinks = std::vector<ElementLink<TPC> >

private

Definition at line 56 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

Constructor & Destructor Documentation

GNN() [1/3]

InDetGNNHardScatterSelection::GNN::GNN

(

const std::string &

nnFile

)

Definition at line 21 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/Root/GNN.cxx.

                                  :
    m_onnxUtil(nullptr)
  {
 
    // Load and initialize the neural network model from the given file path.
    std::string fullPathToOnnxFile = PathResolverFindCalibFile(nn_file);
    m_onnxUtil = std::make_shared<FlavorTagDiscriminants::OnnxUtil>(fullPathToOnnxFile);
 
    // Extract metadata from the ONNX file, primarily about the model's inputs.
    auto lwt_config = m_onnxUtil->getLwtConfig();
 
    // Create configuration objects for data preprocessing.
    auto [inputs, constituents_configs] = dataprep::createGetterConfig(lwt_config);
    
    for (auto config : constituents_configs){
      switch (config.type){
      case ConstituentsType::TRACK:
        m_constituentsLoaders.push_back(std::make_shared<TracksLoader>(config));
        break;
      case ConstituentsType::ELECTRON:
        m_constituentsLoaders.push_back(std::make_shared<ElectronsLoader>(config));
        break;
      case ConstituentsType::MUON:
        m_constituentsLoaders.push_back(std::make_shared<MuonsLoader>(config));
        break;
      case ConstituentsType::JET:
        m_constituentsLoaders.push_back(std::make_shared<JetsLoader>(config));
        break;
      case ConstituentsType::PHOTON:
        m_constituentsLoaders.push_back(std::make_shared<PhotonsLoader>(config));
        break;
      case ConstituentsType::IPARTICLE:
        m_constituentsLoaders.push_back(std::make_shared<IParticlesLoader>(config));
        break;
      }
    }
 
    m_varsFromVertex = dataprep::createVertexVarGetters(inputs);
 
    // Retrieve the configuration for the model outputs.
    FlavorTagDiscriminants::OnnxUtil::OutputConfig gnn_output_config = m_onnxUtil->getOutputConfig();
 
    for (const auto& outNode : gnn_output_config) {
      // the node's output name will be used to define the decoration name
      std::string dec_name = outNode.name;
      m_decorators.vertexFloat.emplace_back(outNode.name, Dec<float>(dec_name));
    }
  }

GNN() [2/3]

InDetGNNHardScatterSelection::GNN::GNN ( GNN &&  )

default

GNN() [3/3]

InDetGNNHardScatterSelection::GNN::GNN ( const GNN &  )

default

~GNN()

InDetGNNHardScatterSelection::GNN::~GNN ( )

virtualdefault

Member Function Documentation

createDecorators()

std::set<std::string> InDetGNNHardScatterSelection::GNN::createDecorators ( const FlavorTagDiscriminants::OnnxUtil::OutputConfig &  outConfig )

private

decorate()

void InDetGNNHardScatterSelection::GNN::decorate ( const xAOD::Vertex &  verrtex ) const

virtual

Definition at line 74 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/Root/GNN.cxx.

                                                   {
    /* Main function for decorating a vertex with GNN outputs. */
    using namespace internal;
 
    // prepare input
    // -------------
    std::map<std::string, FlavorTagDiscriminants::Inputs> gnn_input;
 
    std::vector<float> vertex_feat;
    for (const auto& getter: m_varsFromVertex) {
      vertex_feat.push_back(getter(vertex).second);
    }
    std::vector<int64_t> vertexfeat_dim = {1, static_cast<int64_t>(vertex_feat.size())};
 
    FlavorTagDiscriminants::Inputs vertex_info (vertex_feat, vertexfeat_dim);
    gnn_input.insert({"vertex_features", vertex_info});
 
    for (auto loader : m_constituentsLoaders){
      auto [sequence_name, sequence_data, sequence_constituents] = loader->getData(vertex);
      gnn_input.insert({sequence_name, sequence_data});
    }
 
    // run inference
    // -------------
    auto [out_f, out_vc, out_vf] = m_onnxUtil->runInference(gnn_input);
 
    // decorate outputs
    // ----------------
    for (const auto& dec: m_decorators.vertexFloat) {
      dec.second(vertex) = out_f.at(dec.first);
    }
  } // end of decorate()

Member Data Documentation

m_constituentsLoaders

std::vector<std::shared_ptr<IConstituentsLoader> > InDetGNNHardScatterSelection::GNN::m_constituentsLoaders

private

Definition at line 73 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

m_decorators

Decorators InDetGNNHardScatterSelection::GNN::m_decorators

private

Definition at line 75 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

m_defaultValue

float InDetGNNHardScatterSelection::GNN::m_defaultValue {}

private

Definition at line 76 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

m_input_node_name

std::string InDetGNNHardScatterSelection::GNN::m_input_node_name

private

Definition at line 71 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

m_onnxUtil

std::shared_ptr<const FlavorTagDiscriminants::OnnxUtil> InDetGNNHardScatterSelection::GNN::m_onnxUtil

Definition at line 52 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

m_varsFromVertex

std::vector<internal::VarFromVertex> InDetGNNHardScatterSelection::GNN::m_varsFromVertex

private

Definition at line 72 of file InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h.

---

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

• InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/InDetGNNHardScatterSelection/GNN.h
• InnerDetector/InDetRecTools/InDetGNNHardScatterSelection/Root/GNN.cxx