This tool cross checks the hits on a track with the hits already stored. More...

#include <MuonAmbiTrackSelectionTool.h>

Inheritance diagram for Muon::MuonAmbiTrackSelectionTool:

Collaboration diagram for Muon::MuonAmbiTrackSelectionTool:

Public Member Functions
	MuonAmbiTrackSelectionTool (const std::string &, const std::string &, const IInterface *)
virtual	~MuonAmbiTrackSelectionTool ()
	default destructor
virtual StatusCode	initialize () override
	standard Athena-Algorithm method
virtual std::tuple< Trk::Track *, bool >	getCleanedOutTrack (const Trk::Track *track, const Trk::TrackScore score, Trk::ClusterSplitProbabilityContainer &splitProbContainer, Trk::PRDtoTrackMap &prd_to_track_map, int trackId=-1, int subtrackId=-1) const override
	Performs cleaning of a track from already used hits.
	DeclareInterfaceID (IAmbiTrackSelectionTool, 1, 0)
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
PublicToolHandle< Muon::MuonEDMPrinterTool >	m_printer
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc
Gaudi::Property< double >	m_maxOverlapFraction {this, "MaxOverlapFraction", 0.1}
	maximum hit overlap fraction between two track, if higher track will be rejected
Gaudi::Property< bool >	m_keepPartial {this, "KeepPartialOverlaps", true}
	flag to keep partial overlaps
Gaudi::Property< bool >	m_keepMoreThanOne {this, "KeepMoreThanOneShare", true}
	flag to keep overlaps which share more than one presicion layer
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

This tool cross checks the hits on a track with the hits already stored.

Shared hits are allowed to some extent und under certain conditions (e.g. the track score is high enough), additional shared hits are removed if necessary. This tool does not delete any tracks. If the client is going to discard tracks entered into this tool, the tracks have to be deleted by this client.

Author: Niels van Eldik niels.nosp@m..van.nosp@m..eldi.nosp@m.k@ce.nosp@m.rn.ch

Definition at line 34 of file MuonAmbiTrackSelectionTool.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

◆ MuonAmbiTrackSelectionTool()

Muon::MuonAmbiTrackSelectionTool::MuonAmbiTrackSelectionTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 21 of file MuonAmbiTrackSelectionTool.cxx.

                                                                                                                      :
    AthAlgTool(t, n, p) {
    declareInterface<IAmbiTrackSelectionTool>(this);
}

◆ ~MuonAmbiTrackSelectionTool()

virtual Muon::MuonAmbiTrackSelectionTool::~MuonAmbiTrackSelectionTool ( )

inlinevirtual

default destructor

Definition at line 39 of file MuonAmbiTrackSelectionTool.h.

39{};

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ DeclareInterfaceID()

Trk::IAmbiTrackSelectionTool::DeclareInterfaceID	(	IAmbiTrackSelectionTool	,
		1	,
		0	)

inherited

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ getCleanedOutTrack()

std::tuple< Trk::Track *, bool > Muon::MuonAmbiTrackSelectionTool::getCleanedOutTrack	(	const Trk::Track *	track,
		const Trk::TrackScore	score,
		Trk::ClusterSplitProbabilityContainer &	splitProbContainer,
		Trk::PRDtoTrackMap &	prd_to_track_map,
		int	trackId = -1,
		int	subtrackId = -1 ) const

overridevirtual

Performs cleaning of a track from already used hits.

Parameters

track	the input track to be checked and cleaned.
score	the score tha twas given to the input track
prd_to_track_map	a map to identify shared hits.
clusterSplitProbMap	map which associates pixel cluster to cluster splitting probabilities.
trackId	unique track identifier (used by track observer tool)
subtrackId	unique track identifier for cleaned out track (used by track observer tool)

Returns: tuple where the first element is a potiner to a new track or a nullptr and the second element is a flag which is set to false if the input track is to be rejected. The second element of the returned tuple is false if the input input track is to be rejected. The input track is rejected if it does not fulfil quality criteria or if a new cleaned track is created replacing the input track. The second element of the returned tuple is true if the input track does not reuire cleaning, fulfils the quality criteria and should be kept.

Do not trigger the warning if the segment consists purely of phi hits

Implements Trk::IAmbiTrackSelectionTool.

Definition at line 36 of file MuonAmbiTrackSelectionTool.cxx.

                                                                               {
    unsigned int numshared{0}, numhits{0}, numPhiHits{0};
 
    if (!track) {
        return std::make_tuple(nullptr, false);  // "reject" invalid input track
    }
 
    ATH_MSG_VERBOSE("New Track " << m_printer->print(*track));
    ATH_MSG_VERBOSE("trackId " << trackId << ", subtrackId " << subtrackId);
 
    std::map<Muon::MuonStationIndex::StIndex, int> sharedPrecisionPerLayer;
    std::map<Muon::MuonStationIndex::StIndex, int> precisionPerLayer;
    auto is_shared = [&sharedPrecisionPerLayer, &precisionPerLayer, this, &numshared, &numhits, &prd_to_track_map,
                      &numPhiHits](const Trk::RIO_OnTrack *rot) {
        if (!rot || !rot->prepRawData()) return;
        const Identifier rot_id = rot->prepRawData()->identify();
        numPhiHits += m_idHelperSvc->isMuon(rot_id) && m_idHelperSvc->measuresPhi(rot_id);
        if (!m_idHelperSvc->isMdt(rot_id) && !m_idHelperSvc->isMM(rot_id) && !m_idHelperSvc->issTgc(rot_id) &&
              (!m_idHelperSvc->isCsc(rot_id) || m_idHelperSvc->measuresPhi(rot_id))) {
            ATH_MSG_VERBOSE("Measurement " << m_printer->print(*rot) << " is not a precision one");
            return;
        }
        const Muon::MuonStationIndex::StIndex stIndex = m_idHelperSvc->stationIndex(rot_id);
        ++precisionPerLayer[stIndex];
        ++numhits;
        if (!prd_to_track_map.isUsed(*(rot->prepRawData()))) { return; }
 
        ATH_MSG_VERBOSE("Track overlap found! " << m_idHelperSvc->toString(rot_id));
        ++numshared;
        ++sharedPrecisionPerLayer[stIndex];
    };
    for (const Trk::TrackStateOnSurface *iTsos : *track->trackStateOnSurfaces()) {
        // get measurment from TSOS
        const Trk::MeasurementBase *meas = iTsos->measurementOnTrack();
        if (!meas) continue;
 
        // only look at measurements
        if (!iTsos->type(Trk::TrackStateOnSurface::Measurement)) continue;
        const Trk::RIO_OnTrack *rot = dynamic_cast<const Trk::RIO_OnTrack *>(meas);
        if (!rot) {
            // we are only interested in precision hits since only they have the resolution to distinguish between
            // close-by tracks so we only take competing ROTs if they are CSC eta hits
            const Trk::CompetingRIOsOnTrack *competingROT = dynamic_cast<const Trk::CompetingRIOsOnTrack *>(meas);
            if (competingROT) {
                const unsigned int numROTs = competingROT->numberOfContainedROTs();
                for (unsigned int i = 0; i < numROTs; ++i) {
                    const Trk::RIO_OnTrack *comp_rot = &competingROT->rioOnTrack(i);
                    is_shared(comp_rot);
                }
            }
        } else {
            is_shared(rot);
        }
    }
    if (!numhits) {
        if (!numPhiHits)
            ATH_MSG_WARNING("Got track without Muon hits " << m_printer->print(*track) << std::endl
                                                           << m_printer->printMeasurements(*track));
        return std::make_tuple(nullptr, false);  // reject input track
    }
    const double overlapFraction = (double)numshared / (double)numhits;
 
    ATH_MSG_VERBOSE("Track " << m_printer->print(*track) << " has " << numhits << " hit, shared " << numshared << " overlap fraction "
                             << overlapFraction << " layers " << precisionPerLayer.size() << " shared " << sharedPrecisionPerLayer.size());
 
    if (overlapFraction > m_maxOverlapFraction) {
        if (m_keepPartial) {
            if (sharedPrecisionPerLayer.empty()) {
                ATH_MSG_DEBUG("Track is not sharing precision hits, keeping ");
                return std::make_tuple(nullptr, true);  // keep input track
            }
            if (overlapFraction < 0.25 && precisionPerLayer.size() > 2 && precisionPerLayer.size() - sharedPrecisionPerLayer.size() == 1) {
                ATH_MSG_DEBUG("Three station track differing by one precision layer, keeping ");
                return std::make_tuple(nullptr, true);  // keep input track
            }
            if (overlapFraction < 0.35 && precisionPerLayer.size() > 2 && precisionPerLayer.size() - sharedPrecisionPerLayer.size() > 1 &&
                m_keepMoreThanOne) {
                ATH_MSG_DEBUG("Three station track differing by more than one precision layer, keeping ");
                return std::make_tuple(nullptr, true);  // keep input track
            }
        }
        return std::make_tuple(nullptr, false);  // reject input track
    }
 
    return std::make_tuple(nullptr, true);  // keep input track
}

◆ initialize()

StatusCode Muon::MuonAmbiTrackSelectionTool::initialize ( )

overridevirtual

standard Athena-Algorithm method

Definition at line 28 of file MuonAmbiTrackSelectionTool.cxx.

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

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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_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::MuonAmbiTrackSelectionTool::m_idHelperSvc

private

Initial value:

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

Definition at line 55 of file MuonAmbiTrackSelectionTool.h.

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

◆ m_keepMoreThanOne

Gaudi::Property<bool> Muon::MuonAmbiTrackSelectionTool::m_keepMoreThanOne {this, "KeepMoreThanOneShare", true}

private

flag to keep overlaps which share more than one presicion layer

Definition at line 68 of file MuonAmbiTrackSelectionTool.h.

68{this, "KeepMoreThanOneShare", true};

◆ m_keepPartial

Gaudi::Property<bool> Muon::MuonAmbiTrackSelectionTool::m_keepPartial {this, "KeepPartialOverlaps", true}

private

flag to keep partial overlaps

Definition at line 65 of file MuonAmbiTrackSelectionTool.h.

65{this, "KeepPartialOverlaps", true};

◆ m_maxOverlapFraction

Gaudi::Property<double> Muon::MuonAmbiTrackSelectionTool::m_maxOverlapFraction {this, "MaxOverlapFraction", 0.1}

private

maximum hit overlap fraction between two track, if higher track will be rejected

Definition at line 62 of file MuonAmbiTrackSelectionTool.h.

62{this, "MaxOverlapFraction", 0.1};

◆ m_printer

PublicToolHandle<Muon::MuonEDMPrinterTool> Muon::MuonAmbiTrackSelectionTool::m_printer

private

Initial value:

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

Definition at line 50 of file MuonAmbiTrackSelectionTool.h.

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

◆ 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

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MuonAmbiTrackSelectionTool()

◆ ~MuonAmbiTrackSelectionTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getCleanedOutTrack()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_idHelperSvc

◆ m_keepMoreThanOne

◆ m_keepPartial

◆ m_maxOverlapFraction

◆ m_printer

◆ m_varHandleArraysDeclared

◆ m_vhka