#include <FPGATrackSimGNNGraphConstructionTool.h>

Inheritance diagram for FPGATrackSimGNNGraphConstructionTool:

Collaboration diagram for FPGATrackSimGNNGraphConstructionTool:

Public Member Functions
	FPGATrackSimGNNGraphConstructionTool (const std::string &, const std::string &, const IInterface *)

virtual StatusCode	initialize () override

virtual StatusCode	getEdges (const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &hits, std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &edges)

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

void	doModuleMap (const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &hits, std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &edges)

void	getDoubletEdges (const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &hits, std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &edges)

void	applyDoubletCuts (const std::shared_ptr< FPGATrackSimGNNHit > &hit1, const std::shared_ptr< FPGATrackSimGNNHit > &hit2, std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &edges, int hit1_index, int hit2_index, unsigned int modulemap_id)

bool	doMask (float val, float min, float max)

bool	doMinMaxMask (float val, float min, float max)

float	featureSign (float feature)

void	doMetricLearning (const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &hits, std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &edges)

std::vector< float >	getNodeFeatures (const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &hits)

std::vector< float >	embed (const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &hits)

void	doClustering (const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &hits, std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &edges, std::vector< float > &gEmbedded)

void	computeEdgeFeatures (std::shared_ptr< FPGATrackSimGNNEdge > &edge, const std::shared_ptr< FPGATrackSimGNNHit > &hit1, const std::shared_ptr< FPGATrackSimGNNHit > &hit2)

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
ToolHandle< AthOnnx::IOnnxRuntimeInferenceTool >	m_MLInferenceTool {this, "MLInferenceTool", "AthOnnx::OnnxRuntimeInferenceTool"}

Gaudi::Property< std::string >	m_graphTool { this, "graphTool", "", "Tool for graph construction" }

Gaudi::Property< std::string >	m_moduleMapType { this, "moduleMapType", "", "Type for Module Map for graph construction" }

Gaudi::Property< std::string >	m_moduleMapFunc { this, "moduleMapFunc", "", "Function for Module Map for graph construction" }

Gaudi::Property< float >	m_moduleMapTol { this, "moduleMapTol", 0.0, "Tolerance value for Module Map cut calculations" }

Gaudi::Property< std::string >	m_moduleMapPath { this, "moduleMapPath", "", "Location of Module Map ROOT file" }

Gaudi::Property< float >	m_metricLearningR { this, "metricLearningR", 0.0, "Clustering radius for Metric Learning"}

Gaudi::Property< int >	m_metricLearningMaxN { this, "metricLearningMaxN", 1, "Max number of neighbours for Metric Learning"}

std::vector< unsigned int >	m_mid1 {}

std::vector< unsigned int >	m_mid2 {}

std::vector< float >	m_z0min_12 {}

std::vector< float >	m_dphimin_12 {}

std::vector< float >	m_phislopemin_12 {}

std::vector< float >	m_detamin_12 {}

std::vector< float >	m_z0max_12 {}

std::vector< float >	m_dphimax_12 {}

std::vector< float >	m_phislopemax_12 {}

std::vector< float >	m_detamax_12 {}

StringArrayProperty	m_MLFeatureNamesVec

FloatArrayProperty	m_MLFeatureScalesVec

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 27 of file FPGATrackSimGNNGraphConstructionTool.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

◆ FPGATrackSimGNNGraphConstructionTool()

FPGATrackSimGNNGraphConstructionTool::FPGATrackSimGNNGraphConstructionTool	(	const std::string &	algname,
		const std::string &	name,
		const IInterface *	ifc
	)

Definition at line 12 of file FPGATrackSimGNNGraphConstructionTool.cxx.

13 : AthAlgTool(algname, name, ifc) {}

Member Function Documentation

◆ applyDoubletCuts()

void FPGATrackSimGNNGraphConstructionTool::applyDoubletCuts	(	const std::shared_ptr< FPGATrackSimGNNHit > &	hit1,
		const std::shared_ptr< FPGATrackSimGNNHit > &	hit2,
		std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &	edges,
		int	hit1_index,
		int	hit2_index,
		unsigned int	modulemap_id
	)

private

Definition at line 136 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     // Four types of doublet cuts (dEta, z0, dPhi, phiSlope)
     // If an edge passes all four, then it is a valid edge and can be stored
  
     // delta_eta cuts
     float deta = hit1->getEta() - hit2->getEta();
     if(!doMask(deta, m_detamin_12[modulemap_id], m_detamax_12[modulemap_id])) return;
  
     // z0 cuts
     float dz = hit2->getZ() - hit1->getZ();
     float dr = hit2->getR() - hit1->getR();
     float z0 = dr==0. ? 0. : hit1->getZ() - (hit1->getR() * dz / dr);
     if(!doMask(z0, m_z0min_12[modulemap_id], m_z0max_12[modulemap_id])) return;
  
     // delta_phi cuts
     float dphi = P4Helpers::deltaPhi(hit2->getPhi(),hit1->getPhi());
     if(!doMask(dphi, m_dphimin_12[modulemap_id], m_dphimax_12[modulemap_id])) return;
  
     // phislope cuts
     float phislope = dr==0. ? 0. : dphi / dr;
     if(!doMask(phislope, m_phislopemin_12[modulemap_id], m_phislopemax_12[modulemap_id])) return;
  
     // if pass all doublet cuts, then record the edge information
     std::shared_ptr<FPGATrackSimGNNEdge> edge = std::make_shared<FPGATrackSimGNNEdge>();
     edge->setEdgeIndex1(hit1_index);
     edge->setEdgeIndex2(hit2_index);
     computeEdgeFeatures(edge, hit1, hit2);
     edges.emplace_back(edge);
 }

◆ computeEdgeFeatures()

void FPGATrackSimGNNGraphConstructionTool::computeEdgeFeatures	(	std::shared_ptr< FPGATrackSimGNNEdge > &	edge,
		const std::shared_ptr< FPGATrackSimGNNHit > &	hit1,
		const std::shared_ptr< FPGATrackSimGNNHit > &	hit2
	)

private

Definition at line 294 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     float deta = hit1->getEta() - hit2->getEta();
     float dz = hit2->getZ() - hit1->getZ();
     float dr = hit2->getR() - hit1->getR();
     float dphi = P4Helpers::deltaPhi(hit2->getPhi(),hit1->getPhi());
     float phislope = dr==0. ? 0. : dphi / dr;
     
     edge->setEdgeDR(dr);
     edge->setEdgeDPhi(dphi);
     edge->setEdgeDZ(dz);
     edge->setEdgeDEta(deta);
     edge->setEdgePhiSlope(phislope);
     edge->setEdgeRPhiSlope(0.5 * (hit2->getR() + hit1->getR()) * phislope);
 }

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

◆ doClustering()

void FPGATrackSimGNNGraphConstructionTool::doClustering	(	const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &	hits,
		std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &	edges,
		std::vector< float > &	gEmbedded
	)

private

Definition at line 238 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     // Create graph edges based on the hits distance in the latent space
     // Creates a directed graph
     int n_dim = 12;
     int size = hits.size();
     float r_squared = m_metricLearningR*m_metricLearningR; 
     int index1 = 0;
     int index2 = 0;
     int count = 0;
     float distance = 0.;
     std::vector<float> start(n_dim); 
  
     // Loop over all hits
     for(int k = 0; k < size; ++k){
         count = 0;
         // Setup current hit
         for(int j = 0; j < n_dim; ++j){
             start[j] = gEmbedded[k*n_dim + j];
         }
         // Loop over the hits not yet checked 
         for (int i = k + 1; i < size; ++i){
             distance = 0.;
             for(int d = 0; d < n_dim; ++d){
                 distance += (start[d] - gEmbedded[i*n_dim + d]) * (start[d] - gEmbedded[i*n_dim + d]);
             }
             // Store edge if the distance between the hits meets is below the limit
             if(distance < r_squared){
                 std::shared_ptr<FPGATrackSimGNNEdge> edge = std::make_shared<FPGATrackSimGNNEdge>();
                 // Set order of edge indices to make a directed graph
                 float d_i_sq = (hits[i]->getR() * hits[i]->getR()) + (hits[i]->getZ() * hits[i]->getZ());
                 float d_k_sq = (hits[k]->getR() * hits[k]->getR()) + (hits[k]->getZ() * hits[k]->getZ());
                 if (d_i_sq < d_k_sq){ 
                     index1 = i;
                     index2 = k;
                 } else {
                     index1 = k;
                     index2 = i;
                 }
                 
                 edge->setEdgeIndex1(index1);
                 edge->setEdgeIndex2(index2);
                 computeEdgeFeatures(edge, hits[index1], hits[index2]);
                 edges.emplace_back(edge);
                 ++count;
             }
             // Upper limit for connections of the same hit
             if(count > m_metricLearningMaxN){
                 break;
             }
         }
  
     }
 }

◆ doMask()

bool FPGATrackSimGNNGraphConstructionTool::doMask	(	float	val,
		float	min,
		float	max
	)

private

Definition at line 167 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     bool mask = false;
     if(m_moduleMapFunc == "minmax") {
         mask = doMinMaxMask(val, min, max);
     }
  
     return mask;
 }

◆ doMetricLearning()

void FPGATrackSimGNNGraphConstructionTool::doMetricLearning	(	const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &	hits,
		std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &	edges
	)

private

Definition at line 196 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     // Use Metric Learning for edge construction 
     // Clustering properties can be set in the input scripta as Gaudi::Property variables
     std::vector<float> gNodeFeatures = getNodeFeatures(hits);
     std::vector<float> gEmbedded = embed(hits);
     doClustering(hits, edges, gEmbedded);
 }

◆ doMinMaxMask()

bool FPGATrackSimGNNGraphConstructionTool::doMinMaxMask	(	float	val,
		float	min,
		float	max
	)

private

Definition at line 177 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     bool mask = false;
  
     if((val <= max * (1.0 + featureSign(max) * m_moduleMapTol)) &&
        (val >= min * (1.0 - featureSign(min) * m_moduleMapTol))) {
         mask = true;
     }
  
     return mask;
 }

◆ doModuleMap()

void FPGATrackSimGNNGraphConstructionTool::doModuleMap	(	const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &	hits,
		std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &	edges
	)

private

Definition at line 93 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     // Use Module Map method for edge building
     // Two types of module maps: Doublet and Triplet
     // For each type of module map there is three functions: minmax, meanrms, and hybrid
     // Use the proper configuration set by the input script and passed as Gaudi::Property variables
     // Currently only Doublet Module Map with minmax cuts exist, but others can be implemented later on as desired
  
     if(m_moduleMapType == "doublet") {
         getDoubletEdges(hits, edges);
     }
 }

◆ embed()

std::vector< float > FPGATrackSimGNNGraphConstructionTool::embed ( const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> & hits )

private

Definition at line 223 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     // Use the ML network to embed the hits in a 12-dim latent space
     std::vector<float> gNodeFeatures = getNodeFeatures(hits);
     std::vector<float> gEmbedded;
  
     std::vector<Ort::Value> gInputTensor;
     StatusCode s = m_MLInferenceTool->addInput(gInputTensor, gNodeFeatures, 0, hits.size());
     std::vector<Ort::Value> gOutputTensor;
     s = m_MLInferenceTool->addOutput(gOutputTensor, gEmbedded, 0, hits.size());
     s = m_MLInferenceTool->inference(gInputTensor, gOutputTensor);
  
     return gEmbedded;
 }

◆ 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

◆ featureSign()

float FPGATrackSimGNNGraphConstructionTool::featureSign ( float feature )

private

Definition at line 189 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     if(feature < 0.0) { return -1.0; }
     else if(feature > 0.0) { return 1.0; }
     else { return 0.0; }
 }

◆ getDoubletEdges()

void FPGATrackSimGNNGraphConstructionTool::getDoubletEdges	(	const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &	hits,
		std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &	edges
	)

private

Definition at line 106 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     // Take the list of hits and use the doublet module map to generate all the edges between hits that pass the doublet cuts
  
     for (size_t i = 0; i < m_mid2.size(); i++) {
         std::vector<std::shared_ptr<FPGATrackSimGNNHit>> hit1_matches;
         std::vector<std::shared_ptr<FPGATrackSimGNNHit>> hit2_matches;
     
         std::vector<int> hit1_indices;
         std::vector<int> hit2_indices;
  
         for (size_t j = 0; j < hits.size(); j++) {
             if (hits[j]->getIdentifier() == m_mid1[i]) {
                 hit1_matches.emplace_back(hits[j]);
                 hit1_indices.emplace_back(j);
             }
             if (hits[j]->getIdentifier() == m_mid2[i]) {
                 hit2_matches.emplace_back(hits[j]);
                 hit2_indices.emplace_back(j);
             }
         }
  
         for (size_t h1 = 0; h1 < hit1_matches.size(); h1++) {
             for (size_t h2 = 0; h2 < hit2_matches.size(); h2++) {
                 applyDoubletCuts(hit1_matches[h1], hit2_matches[h2], edges, hit1_indices[h1], hit2_indices[h2], i);
             }
         }
     }
 }

◆ getEdges()

StatusCode FPGATrackSimGNNGraphConstructionTool::getEdges	(	const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> &	hits,
		std::vector< std::shared_ptr< FPGATrackSimGNNEdge >> &	edges
	)

virtual

Definition at line 38 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     if(m_graphTool == "ModuleMap") {
         doModuleMap(hits, edges);
     }
     else if(m_graphTool == "MetricLearning") {
         doMetricLearning(hits, edges);
     }
  
     return StatusCode::SUCCESS;
 }

◆ getNodeFeatures()

std::vector< float > FPGATrackSimGNNGraphConstructionTool::getNodeFeatures ( const std::vector< std::shared_ptr< FPGATrackSimGNNHit >> & hits )

private

Definition at line 205 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     std::vector<float> gNodeFeatures;
     
     for(auto hit : hits) {
         std::map<std::string, float> features;
         features["r"] = hit->getR();
         features["phi"] = hit->getPhi();
         features["z"] = hit->getZ();
  
         for(size_t i = 0; i < m_MLFeatureNamesVec.size(); i++){
             gNodeFeatures.push_back(
             features[m_MLFeatureNamesVec[i]] / m_MLFeatureScalesVec[i]);
         }
     }
     return gNodeFeatures;
 }

◆ initialize()

StatusCode FPGATrackSimGNNGraphConstructionTool::initialize ( )

overridevirtual

Definition at line 15 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     if(m_graphTool == "ModuleMap") {
         if(m_moduleMapPath == "") { // Require a path provided for the Module Map
                 ATH_MSG_FATAL("ERROR! No Module Map provided. Please provide a valid path to a ROOT file."); 
                 return StatusCode::FAILURE;
         }
         if(m_moduleMapType == "doublet") {
             loadDoubletModuleMap(); // Load the doublet module map and store entry branches in vectors
         }
     }
     else if(m_graphTool == "MetricLearning") {
         ATH_CHECK( m_MLInferenceTool.retrieve() );
         m_MLInferenceTool->printModelInfo();
         assert(m_MLFeatureNamesVec.size() == m_MLFeatureScalesVec.size());
     }
  
     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.

◆ loadDoubletModuleMap()

void FPGATrackSimGNNGraphConstructionTool::loadDoubletModuleMap ( )

private

Definition at line 50 of file FPGATrackSimGNNGraphConstructionTool.cxx.

 {
     std::unique_ptr<TFile> file(TFile::Open(m_moduleMapPath.value().c_str()));
     std::unique_ptr<TTree> tree(static_cast<TTree*>(file->Get("TreeModuleDoublet")));
  
     unsigned int mid1_value = 0;
     unsigned int mid2_value = 0;
     float z0min_12_value = 0.0;
     float dphimin_12_value = 0.0;
     float phislopemin_12_value = 0.0;
     float detamin_12_value = 0.0;
     float z0max_12_value = 0.0;
     float dphimax_12_value = 0.0;
     float phislopemax_12_value = 0.0;
     float detamax_12_value = 0.0;
  
     tree->SetBranchAddress("Module1", &mid1_value);
     tree->SetBranchAddress("Module2", &mid2_value);
     tree->SetBranchAddress("z0min_12", &z0min_12_value);
     tree->SetBranchAddress("dphimin_12", &dphimin_12_value);
     tree->SetBranchAddress("phiSlopemin_12", &phislopemin_12_value);
     tree->SetBranchAddress("detamin_12", &detamin_12_value);
     tree->SetBranchAddress("z0max_12", &z0max_12_value);
     tree->SetBranchAddress("dphimax_12", &dphimax_12_value);
     tree->SetBranchAddress("phiSlopemax_12", &phislopemax_12_value);
     tree->SetBranchAddress("detamax_12", &detamax_12_value);
  
     int64_t nEntries = tree->GetEntries();
     for (int64_t i = 0; i < nEntries; ++i) {
         tree->GetEntry(i);
         m_mid1.emplace_back(mid1_value);
         m_mid2.emplace_back(mid2_value);
         m_z0min_12.emplace_back(z0min_12_value);
         m_dphimin_12.emplace_back(dphimin_12_value);
         m_phislopemin_12.emplace_back(phislopemin_12_value);
         m_detamin_12.emplace_back(detamin_12_value);
         m_z0max_12.emplace_back(z0max_12_value);
         m_dphimax_12.emplace_back(dphimax_12_value);
         m_phislopemax_12.emplace_back(phislopemax_12_value);
         m_detamax_12.emplace_back(detamax_12_value);
     }
 }

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

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

std::vector<float> FPGATrackSimGNNGraphConstructionTool::m_detamax_12 {}

private

Definition at line 75 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_detamin_12

std::vector<float> FPGATrackSimGNNGraphConstructionTool::m_detamin_12 {}

private

Definition at line 71 of file FPGATrackSimGNNGraphConstructionTool.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_dphimax_12

std::vector<float> FPGATrackSimGNNGraphConstructionTool::m_dphimax_12 {}

private

Definition at line 73 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_dphimin_12

std::vector<float> FPGATrackSimGNNGraphConstructionTool::m_dphimin_12 {}

private

Definition at line 69 of file FPGATrackSimGNNGraphConstructionTool.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_graphTool

Gaudi::Property<std::string> FPGATrackSimGNNGraphConstructionTool::m_graphTool { this, "graphTool", "", "Tool for graph construction" }

private

Definition at line 54 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_metricLearningMaxN

Gaudi::Property<int> FPGATrackSimGNNGraphConstructionTool::m_metricLearningMaxN { this, "metricLearningMaxN", 1, "Max number of neighbours for Metric Learning"}

private

Definition at line 60 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_metricLearningR

Gaudi::Property<float> FPGATrackSimGNNGraphConstructionTool::m_metricLearningR { this, "metricLearningR", 0.0, "Clustering radius for Metric Learning"}

private

Definition at line 59 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_mid1

std::vector<unsigned int> FPGATrackSimGNNGraphConstructionTool::m_mid1 {}

private

Definition at line 66 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_mid2

std::vector<unsigned int> FPGATrackSimGNNGraphConstructionTool::m_mid2 {}

private

Definition at line 67 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_MLFeatureNamesVec

StringArrayProperty FPGATrackSimGNNGraphConstructionTool::m_MLFeatureNamesVec

private

Initial value:

{
            this, "MLFeatureNames",
            {"r", "phi", "z"},
            "Feature names for the Metric Learning model"}

Definition at line 97 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_MLFeatureScalesVec

FloatArrayProperty FPGATrackSimGNNGraphConstructionTool::m_MLFeatureScalesVec

private

Initial value:

{
            this, "MLFeatureScales",
            {1000.0, 3.14159265359, 1000.0},
            "Feature scales for the Metric Learning model"}

Definition at line 101 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_MLInferenceTool

ToolHandle<AthOnnx::IOnnxRuntimeInferenceTool> FPGATrackSimGNNGraphConstructionTool::m_MLInferenceTool {this, "MLInferenceTool", "AthOnnx::OnnxRuntimeInferenceTool"}

private

Definition at line 49 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_moduleMapFunc

Gaudi::Property<std::string> FPGATrackSimGNNGraphConstructionTool::m_moduleMapFunc { this, "moduleMapFunc", "", "Function for Module Map for graph construction" }

private

Definition at line 56 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_moduleMapPath

Gaudi::Property<std::string> FPGATrackSimGNNGraphConstructionTool::m_moduleMapPath { this, "moduleMapPath", "", "Location of Module Map ROOT file" }

private

Definition at line 58 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_moduleMapTol

Gaudi::Property<float> FPGATrackSimGNNGraphConstructionTool::m_moduleMapTol { this, "moduleMapTol", 0.0, "Tolerance value for Module Map cut calculations" }

private

Definition at line 57 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_moduleMapType

Gaudi::Property<std::string> FPGATrackSimGNNGraphConstructionTool::m_moduleMapType { this, "moduleMapType", "", "Type for Module Map for graph construction" }

private

Definition at line 55 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_phislopemax_12

std::vector<float> FPGATrackSimGNNGraphConstructionTool::m_phislopemax_12 {}

private

Definition at line 74 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_phislopemin_12

std::vector<float> FPGATrackSimGNNGraphConstructionTool::m_phislopemin_12 {}

private

Definition at line 70 of file FPGATrackSimGNNGraphConstructionTool.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.

◆ m_z0max_12

std::vector<float> FPGATrackSimGNNGraphConstructionTool::m_z0max_12 {}

private

Definition at line 72 of file FPGATrackSimGNNGraphConstructionTool.h.

◆ m_z0min_12

std::vector<float> FPGATrackSimGNNGraphConstructionTool::m_z0min_12 {}

private

Definition at line 68 of file FPGATrackSimGNNGraphConstructionTool.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

◆ FPGATrackSimGNNGraphConstructionTool()

Member Function Documentation

◆ applyDoubletCuts()

◆ computeEdgeFeatures()

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

◆ doClustering()

◆ doMask()

◆ doMetricLearning()

◆ doMinMaxMask()

◆ doModuleMap()

◆ embed()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ featureSign()

◆ getDoubletEdges()

◆ getEdges()

◆ getNodeFeatures()

◆ initialize()

◆ inputHandles()

◆ loadDoubletModuleMap()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detamax_12

◆ m_detamin_12

◆ m_detStore

◆ m_dphimax_12

◆ m_dphimin_12

◆ m_evtStore

◆ m_graphTool

◆ m_metricLearningMaxN

◆ m_metricLearningR

◆ m_mid1

◆ m_mid2

◆ m_MLFeatureNamesVec

◆ m_MLFeatureScalesVec

◆ m_MLInferenceTool

◆ m_moduleMapFunc

◆ m_moduleMapPath

◆ m_moduleMapTol

◆ m_moduleMapType

◆ m_phislopemax_12

◆ m_phislopemin_12

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_z0max_12

◆ m_z0min_12