#include <CaloMuonScoreTool.h>

Inheritance diagram for CaloMuonScoreTool:

Collaboration diagram for CaloMuonScoreTool:

Public Member Functions
	CaloMuonScoreTool (const std::string &type, const std::string &name, const IInterface *parent)

virtual	~CaloMuonScoreTool ()=default

virtual StatusCode	initialize () override

float	getMuonScore (const xAOD::TrackParticle trk, const CaloCellContainer cells=nullptr, const CaloExtensionCollection *extensionCache=nullptr) const override

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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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
float	runOnnxInference (std::vector< float > &tensor) const

std::vector< float >	unwrapPhiAngles (const std::vector< float > &v) const

void	fillInputVectors (std::unique_ptr< const Rec::ParticleCellAssociation > &association, std::vector< float > &eta, std::vector< float > &phi, std::vector< float > &energy, std::vector< int > &samplingId) const

float	getMedian (std::vector< float > v) const
	--> Copy is neccessary as the elements are reorded for the moment which would then break association to the actual cell deposit More...

int	getBin (const float low_edge, const float up_edge, const int n_bins, float val) const

int	channelForSamplingId (int &samplingId) const

std::vector< float >	getInputTensor (std::vector< float > &eta, std::vector< float > &phi, std::vector< float > &energy, std::vector< int > &sampling) const

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
Gaudi::Property< float >	m_CaloCellAssociationConeSize

Gaudi::Property< int >	m_etaBins {this, "etaBins", 30, "Number of bins in eta"}

Gaudi::Property< int >	m_phiBins {this, "phiBins", 30, "Number of bins in phi"}

Gaudi::Property< float >	m_etaCut

Gaudi::Property< float >	m_phiCut

Gaudi::Property< int >	m_nChannels {this, "nChannels", 7, "Number of colour channels in the convolutional neural network"}

ToolHandle< Rec::IParticleCaloCellAssociationTool >	m_caloCellAssociationTool {this, "ParticleCaloCellAssociationTool", ""}

ServiceHandle< AthOnnx::IOnnxRuntimeSvc >	m_svc {this, "ONNXRuntimeSvc", "AthOnnx::OnnxRuntimeSvc", "CaloMuonScoreTool ONNXRuntimeSvc"}
	Handle to `AthOnnx::IOnnxRuntimeSvc`. More...

std::unique_ptr< Ort::Session >	m_session

std::vector< const char * >	m_input_node_names

std::vector< const char * >	m_output_node_names

std::vector< int64_t >	m_input_node_dims

Gaudi::Property< std::string >	m_modelFileName {this, "ModelFileName", "CaloTrkMuIdTools/nnBased_201022/CaloMuonCNN_1.onnx"}

Gaudi::Property< double >	m_CaloMuonEtaCut

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

Fetch the calorimeter cells around a track particle and compute the muon score.

The muon score is computed by doing inference on a 7-colour-channel convolutional neural network. The inputs to the convolutional neural network are the energy deposits in 30 eta and 30 phi bins around the track particle. Seven colour channels are considered, corresponding to the seven calorimeter layers (CaloSamplingIDs) in the low-eta region (eta < 0.1).

The convolutional neural network was trained using tensorflow. Inference on this model is done using ONNX (the tensorflow model having been converted to ONNX format).

Author: Ricardo Woelker ricar.nosp@m.do.w.nosp@m.oelke.nosp@m.r@ce.nosp@m.rn.ch

Definition at line 37 of file CaloMuonScoreTool.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

◆ CaloMuonScoreTool()

CaloMuonScoreTool::CaloMuonScoreTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 24 of file CaloMuonScoreTool.cxx.

                                                                                                            :
     AthAlgTool(type, name, parent) {
     declareInterface<ICaloMuonScoreTool>(this);
 }

◆ ~CaloMuonScoreTool()

virtual CaloMuonScoreTool::~CaloMuonScoreTool ( )

virtualdefault

Member Function Documentation

◆ channelForSamplingId()

int CaloMuonScoreTool::channelForSamplingId ( int & samplingId ) const

private

Definition at line 238 of file CaloMuonScoreTool.cxx.

                                                                  {
     // List of 7 central calo sampling IDs: [0,1,2,3,12,13,14]
     switch (samplingId) {
         case 0: return 0;
         case 1: return 1;
         case 2: return 2;
         case 3: return 3;
         case 12: return 4;
         case 13: return 5;
         case 14: return 6;
         default: return -1;
     }
 }

◆ 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

◆ fillInputVectors()

void CaloMuonScoreTool::fillInputVectors	(	std::unique_ptr< const Rec::ParticleCellAssociation > &	association,
		std::vector< float > &	eta,
		std::vector< float > &	phi,
		std::vector< float > &	energy,
		std::vector< int > &	samplingId
	)		const

private

Definition at line 134 of file CaloMuonScoreTool.cxx.

                                                                                                                             {
     int cell_count = 0;
  
     for (auto cluster : association->data()) {
         eta.push_back(cluster->eta());
         phi.push_back(cluster->phi());
         samplingId.push_back(cluster->caloDDE()->getSampling());
         energy.push_back(cluster->energy());
  
         cell_count++;
     }
  
     ATH_MSG_DEBUG("Iterated over " << cell_count << " calo cells");
  
     return;
 }

◆ getBin()

int CaloMuonScoreTool::getBin	(	const float	low_edge,
		const float	up_edge,
		const int	n_bins,
		float	val
	)		const

private

Definition at line 269 of file CaloMuonScoreTool.cxx.

                                                                                                           {
     if (val < low_edge || val >= up_edge)
         return -1;
     const float bin_width = (up_edge - low_edge) / (n_bins - 1);
     float interval = val - low_edge;
     return std::ceil(interval / bin_width);
  
  
 }

◆ getInputTensor()

std::vector< float > CaloMuonScoreTool::getInputTensor	(	std::vector< float > &	eta,
		std::vector< float > &	phi,
		std::vector< float > &	energy,
		std::vector< int > &	sampling
	)		const

private

Definition at line 282 of file CaloMuonScoreTool.cxx.

                                                                                      {
     int n_cells = eta.size();
  
     // make sure the vector of phi values does not contain discontinuities around the
     // boundary between pi and -pi
     std::vector<float> unwrappedPhi = unwrapPhiAngles(phi);
  
     float median_eta = getMedian(eta);
     float median_phi = getMedian(unwrappedPhi);
  
     // initialise output matrix of zeros
     std::vector<float> tensor(m_etaBins * m_phiBins * m_nChannels, 0.);
  
     int skipped_cells = 0;
  
     for (int i = 0; i < n_cells; i++) {
         // take eta and phi values, and shift them by their repsective median
         float shifted_eta = eta[i] - median_eta;
         float shifted_phi = unwrappedPhi[i] - median_phi;
  
         int eta_bin = getBin(-m_etaCut, m_etaCut, m_etaBins, shifted_eta);
         int phi_bin = getBin(-m_phiCut, m_phiCut, m_phiBins, shifted_phi);
         // the cell lies outside the acceptable range
         if (eta_bin == -1 || phi_bin == -1) {
             skipped_cells++;
             ATH_MSG_DEBUG("Skipping cell because eta or phi bin lies outside of range. Eta bin: " << eta_bin << " phi bin: " << phi_bin);
             continue;
         }
  
         int channel = channelForSamplingId(sampling[i]);
  
         // this really should not happen, but let's skip this cell if it does
         if (channel == -1) {
             skipped_cells++;
             ATH_MSG_DEBUG("Skipping cell because sampling ID does not correspond to low-eta layers. Sampling ID: " << sampling[i]);
             continue;
         }
  
         // 3D array flattening in row-major style: https://en.wikipedia.org/wiki/Row-_and_column-major_order#Explanation_and_example
         int tensor_idx = eta_bin * m_phiBins * m_nChannels + phi_bin * m_nChannels + channel;
  
         tensor[tensor_idx] += energy[i];
     }
  
     ATH_MSG_DEBUG("Skipped " << skipped_cells << " out of " << n_cells << " cells");
  
     return tensor;
 }

◆ getMedian()

float CaloMuonScoreTool::getMedian ( std::vector< float > v ) const

private

--> Copy is neccessary as the elements are reorded for the moment which would then break association to the actual cell deposit

Definition at line 255 of file CaloMuonScoreTool.cxx.

                                                            {
     if (v.empty()) return 0.0;
  
     int n = v.size() / 2;
     std::nth_element(v.begin(), v.begin() + n, v.end());
     float med = v[n];
  
     if (v.size() % 2 == 1) return med;
  
     auto max_it = std::max_element(v.begin(), v.begin() + n);
  
     return (*max_it + med) / 2.0;
 }

◆ getMuonScore()

float CaloMuonScoreTool::getMuonScore	(	const xAOD::TrackParticle *	trk,
		const CaloCellContainer *	cells = `nullptr`,
		const CaloExtensionCollection *	extensionCache = `nullptr`
	)		const

overridevirtual

Implements ICaloMuonScoreTool.

Definition at line 155 of file CaloMuonScoreTool.cxx.

                                                                                            {
     ATH_MSG_DEBUG("in CaloMuonScoreTool::getMuonScore()");
  
     double track_eta = trk->eta();
  
     // calculate muon score at all eta values
     if (std::abs(track_eta) > m_CaloMuonEtaCut) {
         ATH_MSG_DEBUG("Skip calculation of muon score for track particle due to failed eta cut of " << m_CaloMuonEtaCut
                                                                                                     << " (eta=" << track_eta << ")");
         return -1;
     }
  
     ATH_MSG_DEBUG("Calculating muon score for track particle with eta=" << track_eta);
  
     ATH_MSG_DEBUG("Finding calo cell association for track particle within cone of delta R=" << m_CaloCellAssociationConeSize);
  
     // - associate calocells to trackparticle
     std::unique_ptr<const Rec::ParticleCellAssociation> association =
         m_caloCellAssociationTool->particleCellAssociation(*trk, m_CaloCellAssociationConeSize, cells, extensionCache);
     if (!association) {
         ATH_MSG_VERBOSE("Could not get particleCellAssociation");
         return -1.;
     }
     ATH_MSG_VERBOSE(" particleCellAssociation done  " << association.get());
  
     // create input vectors from calo cell association
     std::vector<float> eta, phi, energy;
     std::vector<int> sampling;
  
     fillInputVectors(association, eta, phi, energy, sampling);
  
     // if any of the vectors are empty, return.
     // They are filled in the same loop in `fillInputVectors`, so it is enough to check one
     if (eta.empty()) {
         ATH_MSG_VERBOSE("Input vectors for CaloMuonScore are empty");
         return -1.;
     }
  
     // create tensor from vectors
     std::vector<float> inputTensor = getInputTensor(eta, phi, energy, sampling);
  
     // run inference on input tensor
     float outputScore = runOnnxInference(inputTensor);
     ATH_MSG_DEBUG("Computed CaloMuonScore: " << outputScore);
  
     return outputScore;
 }

◆ initialize()

StatusCode CaloMuonScoreTool::initialize ( )

overridevirtual

Definition at line 32 of file CaloMuonScoreTool.cxx.

                                          {
     ATH_MSG_INFO("Initializing " << name());
  
     ATH_CHECK(m_svc.retrieve());
     ATH_CHECK(m_caloCellAssociationTool.retrieve());
  
     std::string model_file_name = PathResolverFindCalibFile(m_modelFileName);
  
     if (m_modelFileName.empty() || model_file_name.empty()) {
         ATH_MSG_FATAL("Could not find the requested ONNX model file: " << m_modelFileName);
         ATH_MSG_FATAL(
             "Please make sure it exists in the ATLAS calibration area (https://atlas-groupdata.web.cern.ch/atlas-groupdata/), and provide "
             "a model file name relative to the root of the calibration area.");
  
         return StatusCode::FAILURE;
     }
  
     // initialise session
     Ort::SessionOptions session_options;
     Ort::AllocatorWithDefaultOptions allocator;
     session_options.SetIntraOpNumThreads(1);
     session_options.SetGraphOptimizationLevel(ORT_ENABLE_BASIC);
  
     m_session = std::make_unique<Ort::Session>(m_svc->env(), model_file_name.c_str(), session_options);
  
     ATH_MSG_INFO("Created ONNX runtime session with model " << model_file_name);
  
     size_t num_input_nodes = m_session->GetInputCount();
     m_input_node_names.resize(num_input_nodes);
  
     for (std::size_t i = 0; i < num_input_nodes; i++) {
         // print input node names
         char* input_name = m_session->GetInputNameAllocated(i, allocator).release();
         ATH_MSG_INFO("Input " << i << " : "
                               << " name= " << input_name);
         m_input_node_names[i] = input_name;
         // print input node types
         Ort::TypeInfo type_info = m_session->GetInputTypeInfo(i);
         auto tensor_info = type_info.GetTensorTypeAndShapeInfo();
         ONNXTensorElementDataType type = tensor_info.GetElementType();
         ATH_MSG_INFO("Input " << i << " : "
                               << " type= " << type);
  
         // print input shapes/dims
         m_input_node_dims = tensor_info.GetShape();
         ATH_MSG_INFO("Input " << i << " : num_dims= " << m_input_node_dims.size());
         for (std::size_t j = 0; j < m_input_node_dims.size(); j++) {
             if (m_input_node_dims[j] < 0) m_input_node_dims[j] = 1;
             ATH_MSG_INFO("Input " << i << " : dim " << j << "= " << m_input_node_dims[j]);
         }
     }
  
     // output nodes
     std::vector<int64_t> output_node_dims;
     size_t num_output_nodes = m_session->GetOutputCount();
     ATH_MSG_INFO("Have output nodes " << num_output_nodes);
     m_output_node_names.resize(num_output_nodes);
  
     for (std::size_t i = 0; i < num_output_nodes; i++) {
         // print output node names
         char* output_name = m_session->GetOutputNameAllocated(i, allocator).release();
         ATH_MSG_INFO("Output " << i << " : "
                                << " name= " << output_name);
         m_output_node_names[i] = output_name;
  
         Ort::TypeInfo type_info = m_session->GetOutputTypeInfo(i);
         auto tensor_info = type_info.GetTensorTypeAndShapeInfo();
         ONNXTensorElementDataType type = tensor_info.GetElementType();
         ATH_MSG_INFO("Output " << i << " : "
                                << " type= " << type);
  
         // print output shapes/dims
         output_node_dims = tensor_info.GetShape();
         ATH_MSG_INFO("Output " << i << " : num_dims= " << output_node_dims.size());
         for (std::size_t j = 0; j < output_node_dims.size(); j++) {
             if (output_node_dims[j] < 0) output_node_dims[j] = 1;
             ATH_MSG_INFO("Output" << i << " : dim " << j << "= " << output_node_dims[j]);
         }
     }
  
     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.

◆ interfaceID()

static const InterfaceID& ICaloMuonScoreTool::interfaceID ( )

inlinestaticinherited

Definition at line 22 of file ICaloMuonScoreTool.h.

22 {return IID_ICaloMuonScoreTool;}

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

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

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

◆ runOnnxInference()

float CaloMuonScoreTool::runOnnxInference ( std::vector< float > & tensor ) const

private

Definition at line 207 of file CaloMuonScoreTool.cxx.

                                                                         {
     // create input tensor object from data values
     ATH_MSG_DEBUG("in CaloMuonScoreTool::runOnnxInference()");
  
     auto memory_info = Ort::MemoryInfo::CreateCpu(OrtArenaAllocator, OrtMemTypeDefault);
     int input_tensor_size(m_etaBins * m_phiBins * m_nChannels);
     Ort::Value input_tensor =
         Ort::Value::CreateTensor<float>(memory_info, tensor.data(), input_tensor_size, m_input_node_dims.data(), m_input_node_dims.size());
  
     // score model & input tensor, get back output tensor
  
     // Ort::Session::Run is non-const.
     // However, the onxx authors claim that it is safe to call
     // from multiple threads:
     //  https://github.com/Microsoft/onnxruntime/issues/114
     Ort::Session* session ATLAS_THREAD_SAFE = m_session.get();
     auto output_tensors = session->Run(Ort::RunOptions{nullptr}, m_input_node_names.data(), &input_tensor, m_input_node_names.size(),
                                          m_output_node_names.data(), m_output_node_names.size());
  
     // Get pointer to output tensor float values
     float *output_score_array = output_tensors.front().GetTensorMutableData<float>();
  
     // Binary classification - the score is just the first element of the output tensor
     float output_score = output_score_array[0];
  
     return output_score;
 }

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

◆ unwrapPhiAngles()

std::vector< float > CaloMuonScoreTool::unwrapPhiAngles ( const std::vector< float > & v ) const

private

Definition at line 118 of file CaloMuonScoreTool.cxx.

                                                                                     {
     std::vector<float> out(in.size());
  
     out[0] = in[0];
  
     for (unsigned int i = 1; i < out.size(); i++) {
         float d = xAOD::P4Helpers::deltaPhi(in[i], in[i - 1]);
         out[i] = out[i - 1] + d;
     }
  
     return out;
 }

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

Gaudi::Property<float> CaloMuonScoreTool::m_CaloCellAssociationConeSize

private

Initial value:

{this, "CaloCellAssociationConeSize", 0.2,

"Size of the cone within which calo cells are associated with a track particle"}

Definition at line 75 of file CaloMuonScoreTool.h.

◆ m_caloCellAssociationTool

ToolHandle<Rec::IParticleCaloCellAssociationTool> CaloMuonScoreTool::m_caloCellAssociationTool {this, "ParticleCaloCellAssociationTool", ""}

private

Definition at line 87 of file CaloMuonScoreTool.h.

◆ m_CaloMuonEtaCut

Gaudi::Property<double> CaloMuonScoreTool::m_CaloMuonEtaCut

private

Initial value:

{this, "CaloMuonEtaCut", 1.0,

"Eta cut (absolute value) up to which a track particle's muon score will be calculated"}

Definition at line 104 of file CaloMuonScoreTool.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_etaBins

Gaudi::Property<int> CaloMuonScoreTool::m_etaBins {this, "etaBins", 30, "Number of bins in eta"}

private

Definition at line 77 of file CaloMuonScoreTool.h.

◆ m_etaCut

Gaudi::Property<float> CaloMuonScoreTool::m_etaCut

private

Initial value:

{
        this, "etaCut", 0.25,
        "Eta cut on the calorimeter cells associated with the track particle after centering of the calorimeter image"}

Definition at line 79 of file CaloMuonScoreTool.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_input_node_dims

std::vector<int64_t> CaloMuonScoreTool::m_input_node_dims

private

Definition at line 98 of file CaloMuonScoreTool.h.

◆ m_input_node_names

std::vector<const char *> CaloMuonScoreTool::m_input_node_names

private

Definition at line 94 of file CaloMuonScoreTool.h.

◆ m_modelFileName

Gaudi::Property<std::string> CaloMuonScoreTool::m_modelFileName {this, "ModelFileName", "CaloTrkMuIdTools/nnBased_201022/CaloMuonCNN_1.onnx"}

private

Definition at line 102 of file CaloMuonScoreTool.h.

◆ m_nChannels

Gaudi::Property<int> CaloMuonScoreTool::m_nChannels {this, "nChannels", 7, "Number of colour channels in the convolutional neural network"}

private

Definition at line 85 of file CaloMuonScoreTool.h.

◆ m_output_node_names

std::vector<const char *> CaloMuonScoreTool::m_output_node_names

private

Definition at line 96 of file CaloMuonScoreTool.h.

◆ m_phiBins

Gaudi::Property<int> CaloMuonScoreTool::m_phiBins {this, "phiBins", 30, "Number of bins in phi"}

private

Definition at line 78 of file CaloMuonScoreTool.h.

◆ m_phiCut

Gaudi::Property<float> CaloMuonScoreTool::m_phiCut

private

Initial value:

{
        this, "phiCut", 0.25,
        "Phi cut on the calorimeter cells associated with the track particle after centering of the calorimeter image"}

Definition at line 82 of file CaloMuonScoreTool.h.

◆ m_session

std::unique_ptr<Ort::Session> CaloMuonScoreTool::m_session

private

Definition at line 92 of file CaloMuonScoreTool.h.

◆ m_svc

ServiceHandle<AthOnnx::IOnnxRuntimeSvc> CaloMuonScoreTool::m_svc {this, "ONNXRuntimeSvc", "AthOnnx::OnnxRuntimeSvc", "CaloMuonScoreTool ONNXRuntimeSvc"}

private

Handle to AthOnnx::IOnnxRuntimeSvc.

Definition at line 90 of file CaloMuonScoreTool.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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CaloMuonScoreTool()

◆ ~CaloMuonScoreTool()

Member Function Documentation

◆ channelForSamplingId()

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

◆ fillInputVectors()

◆ getBin()

◆ getInputTensor()

◆ getMedian()

◆ getMuonScore()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ runOnnxInference()

◆ sysInitialize()

◆ sysStart()

◆ unwrapPhiAngles()

◆ updateVHKA()

Member Data Documentation

◆ m_CaloCellAssociationConeSize

◆ m_caloCellAssociationTool

◆ m_CaloMuonEtaCut

◆ m_detStore

◆ m_etaBins

◆ m_etaCut

◆ m_evtStore

◆ m_input_node_dims

◆ m_input_node_names

◆ m_modelFileName

◆ m_nChannels

◆ m_output_node_names

◆ m_phiBins

◆ m_phiCut

◆ m_session

◆ m_svc

◆ m_varHandleArraysDeclared

◆ m_vhka