tool to remove overlaps between segments More...

#include <MuonSegmentOverlapRemovalTool.h>

Inheritance diagram for Muon::MuonSegmentOverlapRemovalTool:

Collaboration diagram for Muon::MuonSegmentOverlapRemovalTool:

Public Types
typedef std::vector< MuonSegment * >	SegVec

Public Member Functions
	MuonSegmentOverlapRemovalTool (const std::string &, const std::string &, const IInterface *)
	constructor More...

virtual	~MuonSegmentOverlapRemovalTool ()=default
	destructor More...

StatusCode	initialize () override
	AlgTool initilize. More...

void	removeDuplicates (Trk::SegmentCollection &segments) const override
	remove duplicates from a vector of segments. More...

std::unique_ptr< MuonSegmentCombination >	removeDuplicates (const MuonSegmentCombination &combi) const override
	remove duplicates from a MuonSegmentCombination. More...

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 ()
	access to tool interface More...

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
SegVec	removeDuplicates (MuonSegmentCombination::SegmentVec &segments) 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
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc

ServiceHandle< Muon::IMuonEDMHelperSvc >	m_edmHelperSvc
	EDM Helper tool. More...

PublicToolHandle< Muon::MuonEDMPrinterTool >	m_printer
	EDM printer tool. More...

Gaudi::Property< bool >	m_removePartialOverlaps
	remove partial overlaps between segments More...

Gaudi::Property< double >	m_overlapFractionCut
	cut on overlap fraction for segments More...

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

tool to remove overlaps between segments

Definition at line 25 of file MuonSegmentOverlapRemovalTool.h.

Member Typedef Documentation

◆ SegVec

typedef std::vector<MuonSegment*> Muon::MuonSegmentOverlapRemovalTool::SegVec

Definition at line 45 of file MuonSegmentOverlapRemovalTool.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ MuonSegmentOverlapRemovalTool()

Muon::MuonSegmentOverlapRemovalTool::MuonSegmentOverlapRemovalTool	(	const std::string &	ty,
		const std::string &	na,
		const IInterface *	pa
	)

constructor

Definition at line 14 of file MuonSegmentOverlapRemovalTool.cxx.

                                                                                                                                :
         AthAlgTool(ty, na, pa) {
         declareInterface<IMuonSegmentOverlapRemovalTool>(this);
     }

◆ ~MuonSegmentOverlapRemovalTool()

virtual Muon::MuonSegmentOverlapRemovalTool::~MuonSegmentOverlapRemovalTool ( )

virtualdefault

destructor

Member Function Documentation

◆ 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

◆ initialize()

StatusCode Muon::MuonSegmentOverlapRemovalTool::initialize ( )

override

AlgTool initilize.

Definition at line 19 of file MuonSegmentOverlapRemovalTool.cxx.

                                                          {
         ATH_CHECK(AlgTool::initialize());
         ATH_CHECK(m_edmHelperSvc.retrieve());
         ATH_CHECK(m_printer.retrieve());
         ATH_CHECK(m_idHelperSvc.retrieve());
         return StatusCode::SUCCESS;
     }

◆ inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

◆ interfaceID()

static const InterfaceID& Muon::IMuonSegmentOverlapRemovalTool::interfaceID ( )

inlinestaticinherited

access to tool interface

Definition at line 25 of file IMuonSegmentOverlapRemovalTool.h.

                                                 {
             static const InterfaceID IID_IMuonSegmentOverlapRemovalTool("Muon::IMuonSegmentOverlapRemovalTool", 1, 0);
             return IID_IMuonSegmentOverlapRemovalTool;
         }

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

◆ removeDuplicates() [1/3]

std::unique_ptr< MuonSegmentCombination > Muon::MuonSegmentOverlapRemovalTool::removeDuplicates ( const MuonSegmentCombination & combi ) const

overridevirtual

remove duplicates from a MuonSegmentCombination.

The callers should take ownership of the new SegmentCombination. If the combination is unchanged the routine will return a nullptr

Implements Muon::IMuonSegmentOverlapRemovalTool.

Definition at line 173 of file MuonSegmentOverlapRemovalTool.cxx.

                                                                                                                                    {
         // store pointers to segments that should be kept
         std::set<MuonSegment*> segmentsToBeKept;
         unsigned int nsegments = 0;  // total number of segments
  
         unsigned int nstations = combi.numberOfStations();
  
         ATH_MSG_DEBUG(" removing duplicate from MuonSegmentCombination with  " << nstations << " stations");
  
         // loop over segments, add them to the chamber layers
         // loop over chambers in combi and extract segments
         for (unsigned int i = 0; i < nstations; ++i) {
             // loop over segments in station
             MuonSegmentCombination::SegmentVec* stationSegs = combi.stationSegments(i);
  
             // check if not empty
             if (!stationSegs || stationSegs->empty()) continue;
  
             nsegments += stationSegs->size();
  
             // clean segments
             SegVec cleanedSegments = removeDuplicates(*stationSegs);
             segmentsToBeKept.insert(cleanedSegments.begin(), cleanedSegments.end());
         }
  
         // check whether all segments were kept
         if (nsegments == segmentsToBeKept.size()) {
             ATH_MSG_DEBUG("  no segments removed ");
             return nullptr;
         }
  
         std::unique_ptr<MuonSegmentCombination> newCombi = std::make_unique<MuonSegmentCombination>();
  
         // create a new combination removing segments that overlap
         for (unsigned int i = 0; i < nstations; ++i) {
             // loop over segments in station
             MuonSegmentCombination::SegmentVec* stationSegs = combi.stationSegments(i);
  
             // check if not empty
             if (!stationSegs || stationSegs->empty()) continue;
  
             std::unique_ptr<std::vector<std::unique_ptr<MuonSegment>>> segVec =
                 std::make_unique<std::vector<std::unique_ptr<MuonSegment>>>();
             segVec->reserve(stationSegs->size());
  
             // loop over segments and add them if they are in the keep set
             for (const std::unique_ptr<MuonSegment>& seg : *stationSegs) {
                 if (!segmentsToBeKept.count(seg.get())) {
                     continue;
                 } else {
                     segVec->emplace_back(seg->clone());
                 }
             }
             // if not empty add segments
             if (!segVec->empty()) newCombi->addSegments(std::move(segVec));
         }
  
         ATH_MSG_DEBUG(" removed " << nsegments - segmentsToBeKept.size() << " duplicates, new size " << segmentsToBeKept.size());
  
         return newCombi;
     }

◆ removeDuplicates() [2/3]

MuonSegmentOverlapRemovalTool::SegVec Muon::MuonSegmentOverlapRemovalTool::removeDuplicates ( MuonSegmentCombination::SegmentVec & segments ) const

private

Definition at line 237 of file MuonSegmentOverlapRemovalTool.cxx.

                                                           {
         ATH_MSG_DEBUG(" working on segment vector of size " << segments.size());
  
         CompareMuonSegmentKeys compareSegmentKeys{};
  
         // create a vector with pairs of MuonSegmentKey and a pointer to the corresponding segment to resolve ambiguities
         std::vector<std::pair<MuonSegmentKey, MuonSegment*>> goodSegments;
         goodSegments.reserve(segments.size());
  
         // loop over new segments, copy them into collection
         for (const std::unique_ptr<MuonSegment>& seg : segments) {
             // create segment key object
             MuonSegmentKey sk(*seg);
             Identifier chId = m_edmHelperSvc->chamberId(*seg);
             bool isCsc = m_idHelperSvc->isCsc(chId);
  
             // should this segment be inserted?
             bool insertAsGood(true);
  
             // loop over already accepted segments and compare the current segment with the good ones
             for (std::pair<MuonSegmentKey, MuonSegment*>& good_seg : goodSegments) {
                 CompareMuonSegmentKeys::OverlapResult overlapResult = compareSegmentKeys(good_seg.first, sk);
                 if (overlapResult == CompareMuonSegmentKeys::Identical) {
                     // for now keep the one with the best chi2
                     const Trk::FitQuality* fq1 = good_seg.second->fitQuality();
                     const Trk::FitQuality* fq2 = seg->fitQuality();
                     double chi2good = fq1 ? fq1->chiSquared() : 1e10;
                     double chi2current = fq2 ? fq2->chiSquared() : 1e10;
                     // we should not insert this segment
                     if (chi2good > chi2current) {
                         ATH_MSG_VERBOSE(" replacing (chi2) " << m_printer->print(*good_seg.second) << std::endl
                                                              << " with      " << m_printer->print(*seg));
  
                         // good segment of worse quality, replace it
                         good_seg.first = sk;
                         good_seg.second = seg.get();
                     } else {
                         ATH_MSG_VERBOSE(" discarding (chi2) " << m_printer->print(*seg));
                     }
                     insertAsGood = false;
                     break;
                 } else if (overlapResult == CompareMuonSegmentKeys::SuperSet) {
                     // good segment of better quality, keep it and discard current segment
                     ATH_MSG_VERBOSE(" discarding (subset) " << m_printer->print(*seg));
                     insertAsGood = false;
                     break;
                 } else if (overlapResult == CompareMuonSegmentKeys::SubSet) {
                     // good segment of worse quality, replace it
                     ATH_MSG_VERBOSE(" replacing (superset) " << m_printer->print(*good_seg.second) << std::endl
                                                              << " with      " << m_printer->print(*seg));
                     good_seg.first = sk;
                     good_seg.second = seg.get();
                     insertAsGood = false;
                     break;
                 } else if (overlapResult == CompareMuonSegmentKeys::PartialOverlap && m_removePartialOverlaps) {
                     // keep CSC segments with partial overlap
                     if (isCsc) continue;
  
                     // partial overlap, for now keep the one most hits
                     if (compareSegmentKeys.segment1Size < compareSegmentKeys.segment2Size) {
                         ATH_MSG_VERBOSE(" replacing (mdt hits) " << m_printer->print(*good_seg.second) << std::endl
                                                                  << " with      " << m_printer->print(*seg));
  
                         // good segment of worse quality, replace it
                         good_seg.first = sk;
                         good_seg.second = seg.get();
                     } else if (compareSegmentKeys.segment1Size == compareSegmentKeys.segment2Size) {
                         // same size
  
                         // if the original entry has more trigger hits discard current segment
                         if (compareSegmentKeys.segment1SizeTrigger > compareSegmentKeys.segment2SizeTrigger) {
                             ATH_MSG_VERBOSE(" discarding (trigger hits) " << m_printer->print(*seg));
                             insertAsGood = false;
                             break;
                         } else if (compareSegmentKeys.segment1SizeTrigger < compareSegmentKeys.segment2SizeTrigger) {
                             // good segment of worse quality, replace it
                             ATH_MSG_VERBOSE(" replacing (trigger hits) " << m_printer->print(*good_seg.second) << std::endl
                                                                          << " with      " << m_printer->print(*seg));
                             good_seg.first = sk;
                             good_seg.second = seg.get();
                             insertAsGood = false;
                             break;
                         } else if (compareSegmentKeys.segment1SizeTrigger == compareSegmentKeys.segment2SizeTrigger) {
                             // for now look at the overlap fraction
                         }
                         // calculate the overlap fraction
                         double overlapFraction = (double)compareSegmentKeys.intersectionSize / (double)compareSegmentKeys.segment1Size;
                         if (overlapFraction > m_overlapFractionCut) {
                             ATH_MSG_VERBOSE(" discarding (overlap fraction) " << m_printer->print(*seg));
                             insertAsGood = false;
                             break;
                         }
  
                         continue;
                     } else {
                         ATH_MSG_VERBOSE(" discarding " << m_printer->print(*seg));
                     }
                     insertAsGood = false;
                     break;
                 } else if (overlapResult == CompareMuonSegmentKeys::NoOverlap) {
                     // no overlap, move on to next segment
                     continue;
                 } else if (overlapResult == CompareMuonSegmentKeys::Unknown) {
                     ATH_MSG_WARNING(" Got invalid return argument comparing segments: " << compareSegmentKeys.print(overlapResult));
                     continue;
                 }
             }
  
             // add segment if needed
             if (insertAsGood) {
                 ATH_MSG_VERBOSE(" no overlap " << m_printer->print(*seg));
                 goodSegments.emplace_back(sk, seg.get());
             }
         }
  
         SegVec cleanedSegments;
         for (const std::pair<MuonSegmentKey, MuonSegment*>& good_seg : goodSegments) { cleanedSegments.push_back(good_seg.second); }
         ATH_MSG_DEBUG(" Segments after removal " << cleanedSegments.size() << " total number of removed segments "
                                                  << segments.size() - cleanedSegments.size());
  
         return cleanedSegments;
     }

◆ removeDuplicates() [3/3]

void Muon::MuonSegmentOverlapRemovalTool::removeDuplicates ( Trk::SegmentCollection & segments ) const

overridevirtual

remove duplicates from a vector of segments.

The caller should take ownership of the segments

Implements Muon::IMuonSegmentOverlapRemovalTool.

Definition at line 27 of file MuonSegmentOverlapRemovalTool.cxx.

                                                                                              {
         ATH_MSG_DEBUG(" working on segment vector of size " << segments.size());
  
         CompareMuonSegmentKeys compareSegmentKeys{};
  
         // create a vector with pairs of MuonSegmentKey and a pointer to the corresponding segment to resolve ambiguities
         std::vector<std::pair<MuonSegmentKey, MuonSegment*>> goodSegments;
         goodSegments.reserve(segments.size());
         std::vector<MuonSegment*> segmentsToErase;
  
         // loop over new segments, copy them into collection
         for (Trk::Segment* tseg : segments) {
             // create segment key object
             MuonSegment* seg = dynamic_cast<MuonSegment*>(tseg);
             if (!seg) {
                 ATH_MSG_WARNING("segment is not MuonSegment");
                 continue;
             }
             MuonSegmentKey sk{*seg};
             Identifier chId = m_edmHelperSvc->chamberId(*seg);
             bool isCsc = m_idHelperSvc->isCsc(chId);
  
             // should this segment be inserted?
             bool insertAsGood = true;
  
             // loop over already accepted segments and compare the current segment with the good ones
             for (std::pair<MuonSegmentKey, MuonSegment*>& good_seg : goodSegments) {
                 CompareMuonSegmentKeys::OverlapResult overlapResult = compareSegmentKeys(good_seg.first, sk);
                 if (overlapResult == CompareMuonSegmentKeys::Identical) {
                     // for now keep the one with the best chi2
                     const Trk::FitQuality* fq1 = good_seg.second->fitQuality();
                     const Trk::FitQuality* fq2 = seg->fitQuality();
                     double chi2good = fq1 ? fq1->chiSquared() : 1e10;
                     double chi2current = fq2 ? fq2->chiSquared() : 1e10;
                     // we should not insert this segment
                     if (chi2good > chi2current) {
                         ATH_MSG_VERBOSE(" replacing (chi2) " << m_printer->print(*good_seg.second) << std::endl
                                                              << " with      " << m_printer->print(*seg));
  
                         // good segment of worse quality, replace it
                         segmentsToErase.push_back(good_seg.second);
                         good_seg.first = sk;
                         good_seg.second = seg;
  
                     } else {
                         ATH_MSG_VERBOSE(" discarding (chi2) " << m_printer->print(*seg));
                         segmentsToErase.push_back(seg);
                     }
                     insertAsGood = false;
                     break;
                 } else if (overlapResult == CompareMuonSegmentKeys::SuperSet) {
                     // good segment of better quality, keep it and discard current segment
                     ATH_MSG_VERBOSE(" discarding (subset) " << m_printer->print(*seg));
                     segmentsToErase.push_back(seg);
                     insertAsGood = false;
                     break;
                 } else if (overlapResult == CompareMuonSegmentKeys::SubSet) {
                     // good segment of worse quality, replace it
                     ATH_MSG_VERBOSE(" replacing (superset) " << m_printer->print(*good_seg.second) << std::endl
                                                              << " with      " << m_printer->print(*seg));
                     segmentsToErase.push_back(good_seg.second);
                     good_seg.first = sk;
                     good_seg.second = seg;
                     insertAsGood = false;
                     break;
                 } else if (overlapResult == CompareMuonSegmentKeys::PartialOverlap && m_removePartialOverlaps) {
                     // keep CSC segments with partial overlap
                     if (isCsc) continue;
  
                     // partial overlap, for now keep the one most hits
                     if (compareSegmentKeys.segment1Size < compareSegmentKeys.segment2Size) {
                         ATH_MSG_VERBOSE(" replacing (mdt hits) " << m_printer->print(*good_seg.second) << std::endl
                                                                  << " with      " << m_printer->print(*seg));
  
                         // good segment of worse quality, replace it
                         segmentsToErase.push_back(good_seg.second);
                         good_seg.first = sk;
                         good_seg.second = seg;
                         insertAsGood = false;
                         break;
                     } else if (compareSegmentKeys.segment1Size == compareSegmentKeys.segment2Size) {
                         // same size
  
                         // if the original entry has more trigger hits discard current segment
                         if (compareSegmentKeys.segment1SizeTrigger > compareSegmentKeys.segment2SizeTrigger) {
                             ATH_MSG_VERBOSE(" discarding (trigger hits) " << m_printer->print(*seg));
                             segmentsToErase.push_back(seg);
                             insertAsGood = false;
                             break;
                         } else if (compareSegmentKeys.segment1SizeTrigger < compareSegmentKeys.segment2SizeTrigger) {
                             // good segment of worse quality, replace it
                             ATH_MSG_VERBOSE(" replacing (trigger hits) " << m_printer->print(*good_seg.second) << std::endl
                                                                          << " with      " << m_printer->print(*seg));
                             segmentsToErase.push_back(good_seg.second);
                             good_seg.first = sk;
                             good_seg.second = seg;
                             insertAsGood = false;
                             break;
                         } else if (compareSegmentKeys.segment1SizeTrigger == compareSegmentKeys.segment2SizeTrigger) {
                             // for now look at the overlap fraction
                         }
                         // calculate the overlap fraction
                         double overlapFraction = (double)compareSegmentKeys.intersectionSize / (double)compareSegmentKeys.segment1Size;
                         if (overlapFraction > m_overlapFractionCut) {
                             ATH_MSG_VERBOSE(" discarding (overlap fraction) " << m_printer->print(*seg));
                             segmentsToErase.push_back(seg);
                             insertAsGood = false;
                             break;
                         }
  
                         continue;
                     } else {
                         ATH_MSG_VERBOSE(" discarding " << m_printer->print(*seg));
                         segmentsToErase.push_back(seg);
                     }
                     insertAsGood = false;
                     break;
                 } else if (overlapResult == CompareMuonSegmentKeys::NoOverlap) {
                     // no overlap, move on to next segment
                     continue;
                 } else if (overlapResult == CompareMuonSegmentKeys::Unknown) {
                     ATH_MSG_WARNING(" Got invalid return argument comparing segments: " << compareSegmentKeys.print(overlapResult));
                     continue;
                 }
             }
  
             // add segment if needed
             if (insertAsGood) {
                 ATH_MSG_VERBOSE(" no overlap " << m_printer->print(*seg));
                 goodSegments.emplace_back(std::move(sk), seg);
             }
         }
  
         // erase rejected segments
         for (MuonSegment* to_erase : segmentsToErase) {
             for (Trk::SegmentCollection::iterator sit = segments.begin(); sit != segments.end(); ++sit) {
                 // remove bad segments from collection, then delete them
                 Trk::Segment* tseg = *sit;
                 if (to_erase == dynamic_cast<MuonSegment*>(tseg)) {
                     segments.erase(sit);
                     break;
                 }
             }
         }
     }

◆ 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_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_edmHelperSvc

ServiceHandle<Muon::IMuonEDMHelperSvc> Muon::MuonSegmentOverlapRemovalTool::m_edmHelperSvc

private

Initial value:

{
            this,
            "edmHelper",
            "Muon::MuonEDMHelperSvc/MuonEDMHelperSvc",
            "Handle to the service providing the IMuonEDMHelperSvc interface",
        }

EDM Helper tool.

Definition at line 57 of file MuonSegmentOverlapRemovalTool.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_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::MuonSegmentOverlapRemovalTool::m_idHelperSvc

private

Initial value:

{
            this,
            "MuonIdHelperSvc",
            "Muon::MuonIdHelperSvc/MuonIdHelperSvc",
        }

Definition at line 52 of file MuonSegmentOverlapRemovalTool.h.

◆ m_overlapFractionCut

Gaudi::Property<double> Muon::MuonSegmentOverlapRemovalTool::m_overlapFractionCut

private

Initial value:

{
            this, "OverlapFractionCut", 0.8,
            "Cut overlap fraction, if fraction is smaller than cut both segments are kept"}

cut on overlap fraction for segments

Definition at line 73 of file MuonSegmentOverlapRemovalTool.h.

◆ m_printer

PublicToolHandle<Muon::MuonEDMPrinterTool> Muon::MuonSegmentOverlapRemovalTool::m_printer

private

Initial value:

{
            this,
            "Printer",
            "Muon::MuonEDMPrinterTool/MuonEDMPrinterTool",
        }

EDM printer tool.

Definition at line 64 of file MuonSegmentOverlapRemovalTool.h.

◆ m_removePartialOverlaps

Gaudi::Property<bool> Muon::MuonSegmentOverlapRemovalTool::m_removePartialOverlaps

private

Initial value:

{
            this, "RemovePartialOverlaps", true,
            "removal partial overlaps between segments"}

remove partial overlaps between segments

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ SegVec

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MuonSegmentOverlapRemovalTool()

◆ ~MuonSegmentOverlapRemovalTool()

Member Function Documentation

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

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ removeDuplicates() [1/3]

◆ removeDuplicates() [2/3]

◆ removeDuplicates() [3/3]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_edmHelperSvc

◆ m_evtStore

◆ m_idHelperSvc

◆ m_overlapFractionCut

◆ m_printer

◆ m_removePartialOverlaps

◆ m_varHandleArraysDeclared

◆ m_vhka