Remove (mark) duplicate tracks This tool takes FPGATrackSimTrack as input and mark their status of passing/failing the overlap removal criteria. More...

#include <FPGATrackSimOverlapRemovalTool.h>

Inheritance diagram for FPGATrackSimOverlapRemovalTool:

Collaboration diagram for FPGATrackSimOverlapRemovalTool:

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

	FPGATrackSimOverlapRemovalTool ()=delete

StatusCode	initialize () override

StatusCode	runOverlapRemoval (std::vector< std::shared_ptr< const FPGATrackSimRoad >> &roads)

StatusCode	runOverlapRemoval (std::vector< FPGATrackSimTrack > &tracks)

void	setDoSecondStage (bool v)

bool	getDoSecondStage () const

ORAlgo	getAlgorithm () const

void	findMinChi2MaxHit (const std::vector< int > &duplicates, std::vector< FPGATrackSimTrack > &tracks)

int	findNCommonHits (const FPGATrackSimTrack &, const FPGATrackSimTrack &)

int	findNonOverlapHits (const FPGATrackSimTrack &, const FPGATrackSimTrack &)

StatusCode	removeOverlapping (FPGATrackSimTrack &track1, FPGATrackSimTrack &track2)

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 bool	compareTrackQuality (const FPGATrackSimTrack &track1, const FPGATrackSimTrack &track2)

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	runOverlapRemoval_fast (std::vector< FPGATrackSimTrack > &tracks)

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< bool >	m_do2ndStage { this, "DoSecondStage", false, "Do second stage of not?"}

Gaudi::Property< int >	m_NumOfHitPerGrouping { this, "NumOfHitPerGrouping", 5, "Number of hits pre grouping"}

Gaudi::Property< float >	m_minChi2 { this, "MinChi2", 40, "Minimum chi2 requirement for tracks being considered in OR"}

Gaudi::Property< bool >	m_roadSliceOR { this, "roadSliceOR", true, "Do slice-wise overlap removal for roads (Hough-only)"}

Gaudi::Property< int >	m_localMaxWindowSize { this, "localMaxWindowSize", 0, "Only create roads that are a local maximum within this window size. Set this to 0 to turn off local max filtering"}

Gaudi::Property< unsigned >	m_imageSize_x { this, "nBins_x", 0, "number of bins in, eg, phi_track"}

Gaudi::Property< unsigned >	m_imageSize_y { this, "nBins_y", 0, "number of bins in, eg, q/pT"}

Gaudi::Property< std::string >	m_algorithm { this, "ORAlgo", "Normal", "Overlap removal algorithm"}

Gaudi::Property< bool >	m_doFastOR { this, "doFastOR", false, "Use fast overlap removal algorithm instead of default"}

int	m_totLayers = 0

ORAlgo	m_algo {ORAlgo::Normal}

ServiceHandle< IFPGATrackSimMappingSvc >	m_FPGATrackSimMapping {this,"FPGATrackSimMappingSvc","FPGATrackSimMappingSvc"}

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

Remove (mark) duplicate tracks This tool takes FPGATrackSimTrack as input and mark their status of passing/failing the overlap removal criteria.

Definition at line 32 of file FPGATrackSimOverlapRemovalTool.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

◆ FPGATrackSimOverlapRemovalTool() [1/2]

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

Definition at line 14 of file FPGATrackSimOverlapRemovalTool.cxx.

                                                                                                                                      :
     AthAlgTool(algname, name, ifc)
 {
 }

◆ FPGATrackSimOverlapRemovalTool() [2/2]

FPGATrackSimOverlapRemovalTool::FPGATrackSimOverlapRemovalTool ( )

delete

Member Function Documentation

◆ compareTrackQuality()

bool FPGATrackSimOverlapRemovalTool::compareTrackQuality	(	const FPGATrackSimTrack &	track1,
		const FPGATrackSimTrack &	track2
	)

static

Definition at line 400 of file FPGATrackSimOverlapRemovalTool.cxx.

 {
     std::vector<const FPGATrackSimHit*> hitsInTrack1;
     for ( auto& hit : track1.getFPGATrackSimHits()) {
         if (hit.isReal()) hitsInTrack1.push_back(&hit);
     }
  
     std::vector<const FPGATrackSimHit*> hitsInTrack2;
     for ( auto& hit: track2.getFPGATrackSimHits()){
         if (hit.isReal()) hitsInTrack2.push_back(&hit);
     }
  
     // If one track has more hits than the other, it's better.
     // Return true if track 2 is better than track 1.
     // Otherwise, decide based on chi2.
     bool goodOrder = true;
     if (hitsInTrack1.size() == hitsInTrack2.size()) {
       // Surprising number of cases where the chi2 is actually identical.
       // In these cases, let's default to the track ID number as the next most important property.
       // So put it higher since we are considering later tracks to be better.
       if (track1.getChi2ndof() == track2.getChi2ndof() && track1.getTrackID() < track2.getTrackID()) goodOrder = false; 
       // Now assuming they're different, we want them in decreasing chi2 order
       else if (track1.getChi2ndof() < track2.getChi2ndof()) goodOrder = false;
     } else if (hitsInTrack1.size() > hitsInTrack2.size()) {
       goodOrder = false;
     } 
  
     return goodOrder;
  
 }

◆ 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

◆ findMinChi2MaxHit()

void FPGATrackSimOverlapRemovalTool::findMinChi2MaxHit	(	const std::vector< int > &	duplicates,
		std::vector< FPGATrackSimTrack > &	tracks
	)

Definition at line 182 of file FPGATrackSimOverlapRemovalTool.cxx.

 {
   //  Hardcode the CHI2MAX for now, should change it later
   float minChi2=100000.;
   int   prevID =-1;
   int   maxHitLayers=0;
   for(auto dup: duplicates)
   {
     float t_chi2 = RMtracks.at(dup).getChi2ndof();
     int t_nhitlayers = RMtracks.at(dup).getFPGATrackSimHits().size();
     for(auto& hit : RMtracks.at(dup).getFPGATrackSimHits())
     {
       if(!hit.isReal())
       {
         t_nhitlayers--;
       }
     }
  
     if(t_nhitlayers>maxHitLayers)
     {
       if(prevID!=-1)
       {
         RMtracks.at(prevID).setPassedOR(0);
       }
       prevID=dup;
       maxHitLayers=t_nhitlayers;
       minChi2=t_chi2;
     }
     else if(t_nhitlayers==maxHitLayers)
     {
       if(t_chi2<minChi2)
       {
         if(prevID!=-1)
         {
           RMtracks.at(prevID).setPassedOR(0);
         }
         prevID=dup;
         minChi2=t_chi2;
       }
       else
       {
         RMtracks.at(dup).setPassedOR(0);
       }
     }
     else
     {
       RMtracks.at(dup).setPassedOR(0);
     }
   }
 }

◆ findNCommonHits()

int FPGATrackSimOverlapRemovalTool::findNCommonHits	(	const FPGATrackSimTrack &	Track1,
		const FPGATrackSimTrack &	Track2
	)

Definition at line 233 of file FPGATrackSimOverlapRemovalTool.cxx.

 {
   int nCommHits=0;
  
   // Loop through all layers
   for(unsigned int i = 0; i < Track1.getFPGATrackSimHits().size(); ++i)
   {
     const FPGATrackSimHit& hit1 = Track1.getFPGATrackSimHits().at(i);
     const FPGATrackSimHit& hit2 = Track2.getFPGATrackSimHits().at(i);
  
     // Check if hit is missing
     if(!hit1.isReal() || !hit2.isReal())
     {
       continue;
     }
     // Check if hit on the same plane
     else if(hit1.getLayer() != hit2.getLayer())
     {
       continue;
     }
     // Check if two hits have the same hashID
     else if(hit1.getIdentifierHash() != hit2.getIdentifierHash())
     {
       continue;
     }
     // Check if two hits have same coordinate. this is difficult due to spacepoints,
     // since the same hit can be used to make multiple spacepoints.
     else if (hit1.getHitType() == HitType::spacepoint && hit2.getHitType() == HitType::spacepoint) {
       if ((hit1.getX() == hit2.getX()) && (hit1.getY() == hit2.getY()) && (hit1.getZ() == hit2.getZ())) {
         nCommHits++;
       } else {
         continue;
       }
     }
     // If both hits aren't spacepoints, we should be able to do this comparison.
     else if (hit1.getPhiCoord() == hit2.getPhiCoord()
           && hit1.getEtaCoord() == hit2.getEtaCoord()) {
       nCommHits++;
     }
     else
     {
       continue;
     }
   }
   return nCommHits;
 }

◆ findNonOverlapHits()

int FPGATrackSimOverlapRemovalTool::findNonOverlapHits	(	const FPGATrackSimTrack &	Track1,
		const FPGATrackSimTrack &	Track2
	)

Definition at line 280 of file FPGATrackSimOverlapRemovalTool.cxx.

 {
   int nonOverlapHits=0;
  
   // Loop through all layers
   for(unsigned int i = 0; i < Track1.getFPGATrackSimHits().size(); ++i)
   {
     const FPGATrackSimHit& hit1 = Track1.getFPGATrackSimHits().at(i);
     const FPGATrackSimHit& hit2 = Track2.getFPGATrackSimHits().at(i);
     //  First make sure we are looking at real hits
     if(!hit1.isReal() || !hit2.isReal())
     {
       continue;
     }
     //  Check if two hits are on the same plane
     else if(hit1.getLayer() != hit2.getLayer())
     {
       nonOverlapHits++;
     }
     // Check if two hits have the same hashID
     else if(hit1.getIdentifierHash() != hit2.getIdentifierHash())
     {
       nonOverlapHits++;
     }
     // Check if two hits have same coordinate. this is difficult due to spacepoints,
     // since the same hit can be used to make multiple spacepoints.
     else if (hit1.getHitType() == HitType::spacepoint && hit2.getHitType() == HitType::spacepoint) {
       if ((hit1.getX() != hit2.getX()) || (hit1.getY() == hit2.getY()) || (hit1.getZ() == hit2.getZ())) {
         nonOverlapHits++;
       } else {
         continue;
       }
     }
     else if(hit1.getPhiCoord() != hit1.getPhiCoord()
             || hit1.getEtaCoord() != hit1.getEtaCoord())
     {
       nonOverlapHits++;
     }
     else
     {
       continue;
     }
   }
   return nonOverlapHits;
 }

◆ getAlgorithm()

ORAlgo FPGATrackSimOverlapRemovalTool::getAlgorithm ( ) const

inline

Definition at line 48 of file FPGATrackSimOverlapRemovalTool.h.

48 {return m_algo;}

◆ getDoSecondStage()

bool FPGATrackSimOverlapRemovalTool::getDoSecondStage ( ) const

inline

Definition at line 47 of file FPGATrackSimOverlapRemovalTool.h.

47 { return m_do2ndStage; }

◆ initialize()

StatusCode FPGATrackSimOverlapRemovalTool::initialize ( )

override

Definition at line 19 of file FPGATrackSimOverlapRemovalTool.cxx.

 {
   ATH_MSG_INFO( "FPGATrackSimOverlapRemovalTool::initialize()" );
   // Check if this is 2nd stage
   if(m_do2ndStage)
   {
     m_totLayers = m_FPGATrackSimMapping->PlaneMap_2nd()->getNLogiLayers();;
   }
   else
   {
     m_totLayers = m_FPGATrackSimMapping->PlaneMap_1st()->getNLogiLayers();;
   }
   ATH_MSG_DEBUG("Total number of layer: " << m_totLayers);
  
   // Check road OR
   if (m_localMaxWindowSize && !m_roadSliceOR)
       ATH_MSG_WARNING("LocalMaxOR only being run per hough slice (i.e. this tool does nothing) since roadSliceOR is turned off");
  
  
   //  Setup OR algorithm
   if(m_algorithm == "Normal") m_algo=ORAlgo::Normal;
   else if(m_algorithm == "Invert") m_algo=ORAlgo::InvertGrouping;
   else
   {
     ATH_MSG_ERROR("initialize(): OR algorithm doesn't exist. ");
     return StatusCode::FAILURE;
   }
   ATH_MSG_DEBUG("Overlap removal algorithm is "<<m_algorithm.value());
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

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

◆ removeOverlapping()

StatusCode FPGATrackSimOverlapRemovalTool::removeOverlapping	(	FPGATrackSimTrack &	track1,
		FPGATrackSimTrack &	track2
	)

Definition at line 327 of file FPGATrackSimOverlapRemovalTool.cxx.

                                                                                                                    {
  
     // Hit comparison
     struct HitCompare {
         bool operator()(const FPGATrackSimHit* a, const FPGATrackSimHit* b) const { 
             auto hash_a = a->getIdentifierHash();
             auto hash_b = b->getIdentifierHash();
             if ( hash_a == hash_b ) {
                 auto phi_a = a->getPhiCoord();
                 auto phi_b = b->getPhiCoord();
                 if ( phi_a == phi_b ) {
                     auto eta_a = a->getEtaCoord();
                     auto eta_b = b->getEtaCoord();
                     if ( eta_a == eta_b) {
                         auto layer_a = a->getLayer();
                         auto layer_b = b->getLayer();
                         return layer_a < layer_b;
                     }
                     return eta_a < eta_b;
                 }
                 return phi_a < phi_b;
             }
             return hash_a <  hash_b; 
         }
     };
  
     std::set<const FPGATrackSimHit*, HitCompare > hitsInTrack1;
     for ( auto& hit : track1.getFPGATrackSimHits()) {
         if (hit.isReal()) hitsInTrack1.insert(&hit);
     }
  
     std::set<const FPGATrackSimHit*, HitCompare> hitsInTrack2;
     for ( auto& hit: track2.getFPGATrackSimHits()){
         if (hit.isReal()) hitsInTrack2.insert(&hit);
     }
  
     std::vector<const FPGATrackSimHit*> sharedHits;    
     std::set_intersection( hitsInTrack1.begin(), hitsInTrack1.end(), 
                          hitsInTrack2.begin(), hitsInTrack2.end(), 
                          std::back_inserter(sharedHits), 
                          HitCompare() );
  
     // Number of real hits in track 1, number of real hits in track 2, number of shared hits, number of non-shared hits (?)
     int nHitsInTrack1 = hitsInTrack1.size();
     int nHitsInTrack2 = hitsInTrack2.size();
     int nSharedHits = sharedHits.size();
     // Original version seems to be only track 1; I want to compare each pair only once so
     // let's make this the most conservative option (i.e. smallest number) ?
     int nonOverlappingHits = std::min(nHitsInTrack1 - nSharedHits, nHitsInTrack2 - nSharedHits);
  
     // Now check if these pass our criteria for overlapping. If not, just return.
     if(getAlgorithm() == ORAlgo::Normal) {
       // Here decision is based on number of overlapping hits.
       // Consider these overlapping if they share >= m_NumOfHitPerGrouping
       if(nSharedHits < m_NumOfHitPerGrouping) return StatusCode::SUCCESS;
  
     } else if(getAlgorithm() == ORAlgo::InvertGrouping) {
       // This is the opposite: duplicates of number of unique hits is <= m_NumOfHitPerGrouping.
       if(nonOverlappingHits > m_NumOfHitPerGrouping) return StatusCode::SUCCESS;
  
     } else {
       // Unknown.
       return StatusCode::FAILURE;
     }
  
     // Made it here: these tracks are overlapping. 
     // But we already sorted them such that track 2 is the one
     // we want to keep, so we can just set track 1 to be removed.
     track1.setPassedOR(0);
  
     return StatusCode::SUCCESS;
 }

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

◆ runOverlapRemoval() [1/2]

StatusCode FPGATrackSimOverlapRemovalTool::runOverlapRemoval ( std::vector< FPGATrackSimTrack > & tracks )

Definition at line 110 of file FPGATrackSimOverlapRemovalTool.cxx.

 {
  
   // Do fast OR instead of requested
   if (m_doFastOR) return runOverlapRemoval_fast(tracks);
  
   // Otherwise, proceed
   ATH_MSG_DEBUG("Beginning runOverlapRemoval()");
  
   // Create tracks to hold and compare
   FPGATrackSimTrack fit1, fit2;
   for(unsigned int i=0; i<tracks.size();i++)
   {
     fit1=tracks.at(i);
     // Apply Chi2 cut
     if(fit1.getChi2ndof()>m_minChi2)
     {
       // Only consider track with chi2 smaller than m_minChi2
       tracks.at(i).setPassedOR(0);
       continue;
     }
  
     // Create vector for holding duplicate track list
     std::vector<int> duplicates(1,i);
  
     // Loop through the remaning tracks
     for(unsigned int j=i+1; j<tracks.size(); j++)
     {
       if(i!=j)
       {
         fit2=tracks.at(j);
         // Apply Chi2 cut
         if(fit2.getChi2ndof()>m_minChi2)
         {
           // Only consider track with chi2 smaller than m_minChi2
           tracks.at(j).setPassedOR(0);
           continue;
         }
         //  Based on the algorithm choose common hit of non-common hit
         if(getAlgorithm() == ORAlgo::Normal)
         {
           // Find the number of common hits between two tracks
           int nOverlappingHits = 0;
           nOverlappingHits=findNCommonHits(fit1,fit2);
  
           // Group overlapping tracks into a vector for removal if at least [m_NumOfHitPerGrouping] hits are the same
           if(nOverlappingHits >= m_NumOfHitPerGrouping)
           {
             duplicates.push_back(j);
           }
         }
         else if(getAlgorithm() == ORAlgo::InvertGrouping)
         {
           //  Find the number of non-common hits between two tracks
           int nNotOverlappingHits=0;
           nNotOverlappingHits=findNonOverlapHits(fit1, fit2);
  
           // If the number of non-overlapping hit is [m_NumOfHitPerGrouping] or less
           if(nNotOverlappingHits <= m_NumOfHitPerGrouping)
           {
             duplicates.push_back(j);
           }
         }
       }
     }
  
     findMinChi2MaxHit(duplicates, tracks);
   }
  
   return StatusCode::SUCCESS;
 }

◆ runOverlapRemoval() [2/2]

StatusCode FPGATrackSimOverlapRemovalTool::runOverlapRemoval ( std::vector< std::shared_ptr< const FPGATrackSimRoad >> & roads )

Definition at line 74 of file FPGATrackSimOverlapRemovalTool.cxx.

 {
     if (roads.empty()) return StatusCode::SUCCESS;
  
     if (!m_roadSliceOR) return StatusCode::SUCCESS;
     size_t in = roads.size();
  
     // Hough image
     vector2D<FPGATrackSimRoad*> acc(m_imageSize_y, m_imageSize_x);
  
     // Slice-wise duplicate removal: accept only one road (with most hits) per bin
     for (auto &r: roads)
     {
         FPGATrackSimRoad* & old = acc(r->getYBin(), r->getXBin());
         if (!old) old = new FPGATrackSimRoad (*r.get());
         else if (r->getNHitLayers() > old->getNHitLayers()) *old = *r.get();
         else if (r->getNHitLayers() == old->getNHitLayers() && r->getNHits() > old->getNHits()) *old = *r.get();
     }
  
     // Reformat to vector
     roads.clear();
     for (unsigned y = 0; y < m_imageSize_y; y++)
       for (unsigned x = 0; x < m_imageSize_x; x++)
         if (FPGATrackSimRoad *tempPtr = acc(y, x); tempPtr && isLocalMax(acc, x, y, m_localMaxWindowSize)/*All-slices local max*/) {
           roads.emplace_back(std::shared_ptr<const FPGATrackSimRoad>(tempPtr));
           acc(y, x) = nullptr;
         }
         else {
           delete acc(y,x);
           acc(y,x) = nullptr;
         }
  
     ATH_MSG_DEBUG("Input: " << in << " Output: " << roads.size());
     return StatusCode::SUCCESS;
 }

◆ runOverlapRemoval_fast()

StatusCode FPGATrackSimOverlapRemovalTool::runOverlapRemoval_fast ( std::vector< FPGATrackSimTrack > & tracks )

private

Definition at line 431 of file FPGATrackSimOverlapRemovalTool.cxx.

 {
   ATH_MSG_DEBUG("Beginning fast overlap removal");
  
   // Sort tracks in order of increasing quality. 
   // This way, once a track has been eliminated in a comparison, we don't
   // need to check it against any other tracks - they will always be
   // better than it.
   std::sort(std::begin(tracks), 
             std::end(tracks), 
             compareTrackQuality); 
  
   // Now compare every pair of tracks.
   // Set passedOR to 0 for the worst one (first one)
   // if they are found to overlap.
   for (unsigned int i=0; i < tracks.size(); i++) {
  
     // Skip track i if bad chi2.
     if (tracks.at(i).getChi2ndof() > m_minChi2) {
       tracks.at(i).setPassedOR(0);
       continue;
     }
  
     // Now check against all other tracks.
     for (unsigned int j=i+1; j< tracks.size(); j++) {
  
       // Uniquely comparing tracks i and j here.
  
       // If have set track i to 0 in a previous comparison, 
       // no need to look at it any more - we're done with it.
       if (!tracks.at(i).passedOR()) break;      
  
       // Ignore j if its chi2 is bad.
       if (tracks.at(j).getChi2ndof() > m_minChi2) tracks.at(j).setPassedOR(0);
  
       // If we just set track j to zero for bad chi2,
       // no need to do the comparison.
       if (!tracks.at(j).passedOR()) continue;      
  
       // If we're still here, two at least semi-decent tracks.
       // Compare them and remove one if necessary.
       ATH_CHECK(removeOverlapping(tracks.at(i),tracks.at(j))); 
  
     }
   }
  
   return StatusCode::SUCCESS;
 }

◆ setDoSecondStage()

void FPGATrackSimOverlapRemovalTool::setDoSecondStage ( bool v )

inline

Definition at line 46 of file FPGATrackSimOverlapRemovalTool.h.

46 { m_do2ndStage = v; }

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

ORAlgo FPGATrackSimOverlapRemovalTool::m_algo {ORAlgo::Normal}

private

Definition at line 72 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_algorithm

Gaudi::Property<std::string> FPGATrackSimOverlapRemovalTool::m_algorithm { this, "ORAlgo", "Normal", "Overlap removal algorithm"}

private

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

Gaudi::Property<bool> FPGATrackSimOverlapRemovalTool::m_do2ndStage { this, "DoSecondStage", false, "Do second stage of not?"}

private

Definition at line 61 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_doFastOR

Gaudi::Property<bool> FPGATrackSimOverlapRemovalTool::m_doFastOR { this, "doFastOR", false, "Use fast overlap removal algorithm instead of default"}

private

Definition at line 69 of file FPGATrackSimOverlapRemovalTool.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_FPGATrackSimMapping

ServiceHandle<IFPGATrackSimMappingSvc> FPGATrackSimOverlapRemovalTool::m_FPGATrackSimMapping {this,"FPGATrackSimMappingSvc","FPGATrackSimMappingSvc"}

private

Definition at line 78 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_imageSize_x

Gaudi::Property<unsigned> FPGATrackSimOverlapRemovalTool::m_imageSize_x { this, "nBins_x", 0, "number of bins in, eg, phi_track"}

private

Definition at line 66 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_imageSize_y

Gaudi::Property<unsigned> FPGATrackSimOverlapRemovalTool::m_imageSize_y { this, "nBins_y", 0, "number of bins in, eg, q/pT"}

private

Definition at line 67 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_localMaxWindowSize

Gaudi::Property<int> FPGATrackSimOverlapRemovalTool::m_localMaxWindowSize { this, "localMaxWindowSize", 0, "Only create roads that are a local maximum within this window size. Set this to 0 to turn off local max filtering"}

private

Definition at line 65 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_minChi2

Gaudi::Property<float> FPGATrackSimOverlapRemovalTool::m_minChi2 { this, "MinChi2", 40, "Minimum chi2 requirement for tracks being considered in OR"}

private

Definition at line 63 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_NumOfHitPerGrouping

Gaudi::Property<int> FPGATrackSimOverlapRemovalTool::m_NumOfHitPerGrouping { this, "NumOfHitPerGrouping", 5, "Number of hits pre grouping"}

private

Definition at line 62 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_roadSliceOR

Gaudi::Property<bool> FPGATrackSimOverlapRemovalTool::m_roadSliceOR { this, "roadSliceOR", true, "Do slice-wise overlap removal for roads (Hough-only)"}

private

Definition at line 64 of file FPGATrackSimOverlapRemovalTool.h.

◆ m_totLayers

int FPGATrackSimOverlapRemovalTool::m_totLayers = 0

private

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

◆ FPGATrackSimOverlapRemovalTool() [1/2]

◆ FPGATrackSimOverlapRemovalTool() [2/2]

Member Function Documentation

◆ compareTrackQuality()

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

◆ findMinChi2MaxHit()

◆ findNCommonHits()

◆ findNonOverlapHits()

◆ getAlgorithm()

◆ getDoSecondStage()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ removeOverlapping()

◆ renounce()

◆ renounceArray()

◆ runOverlapRemoval() [1/2]

◆ runOverlapRemoval() [2/2]

◆ runOverlapRemoval_fast()

◆ setDoSecondStage()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_algo

◆ m_algorithm

◆ m_detStore

◆ m_do2ndStage

◆ m_doFastOR

◆ m_evtStore

◆ m_FPGATrackSimMapping

◆ m_imageSize_x

◆ m_imageSize_y

◆ m_localMaxWindowSize

◆ m_minChi2

◆ m_NumOfHitPerGrouping

◆ m_roadSliceOR

◆ m_totLayers

◆ m_varHandleArraysDeclared

◆ m_vhka