Concrete implementation of the ITrackScoringTool pABC. More...

#include <MuonTrackScoringTool.h>

Inheritance diagram for Muon::MuonTrackScoringTool:

Collaboration diagram for Muon::MuonTrackScoringTool:

Public Member Functions
	MuonTrackScoringTool (const std::string &, const std::string &, const IInterface *)
virtual	~MuonTrackScoringTool ()=default
virtual StatusCode	initialize () override
virtual bool	passBasicSelections (const Trk::Track &) const override
	check track selections independent from TrackSummary
virtual Trk::TrackScore	score (const Trk::Track &track, bool checkBasicSel) const override
	create a score based on how good the passed track is
virtual Trk::TrackScore	simpleScore (const Trk::Track &track, const Trk::TrackSummary &trackSummary) const override
	create a score based on how good the passed TrackSummary is
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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
ToolHandle< Trk::IExtendedTrackSummaryTool >	m_trkSummaryTool {this, "SumHelpTool", "Trk::TrackSummaryTool"}
PublicToolHandle< MuonEDMPrinterTool >	m_printer
std::vector< Trk::TrackScore >	m_summaryTypeScore
	holds the scores assigned to each Trk::SummaryType from the track's Trk::TrackSummary
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

Concrete implementation of the ITrackScoringTool pABC.

Definition at line 26 of file MuonTrackScoringTool.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

◆ MuonTrackScoringTool()

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

Definition at line 17 of file MuonTrackScoringTool.cxx.

                                                                                                          :
        AthAlgTool(t, n, p), m_summaryTypeScore(Trk::numberOfTrackSummaryTypes) {
        declareInterface<Trk::ITrackScoringTool>(this);
 
        // set some test values
        m_summaryTypeScore[Trk::numberOfPixelHits] = 20;
        m_summaryTypeScore[Trk::numberOfPixelHoles] = -10;       // a hole is bad
 
        m_summaryTypeScore[Trk::numberOfInnermostPixelLayerHits] = 10;        // addition for being b-layer
 
        m_summaryTypeScore[Trk::numberOfGangedPixels] = -5;  // decrease for being ganged
 
        m_summaryTypeScore[Trk::numberOfSCTHits] = 10;        // half of a pixel, since only 1dim
        m_summaryTypeScore[Trk::numberOfSCTHoles] = -5;       // a hole is bad !
 
        m_summaryTypeScore[Trk::numberOfTRTHits] = 2;               // 5 straws ~ 1 SCT
        m_summaryTypeScore[Trk::numberOfTRTHighThresholdHits] = 1;  // addition for being TR
        m_summaryTypeScore[Trk::numberOfOutliersOnTrack] = -2;      // an outlier might happen
 
        // scoring for Muons is missing
        m_summaryTypeScore[Trk::numberOfMdtHits] = 5;
        m_summaryTypeScore[Trk::numberOfTgcPhiHits] = 5;
        m_summaryTypeScore[Trk::numberOfTgcEtaHits] = 5;
        m_summaryTypeScore[Trk::numberOfCscPhiHits] = 5;
        m_summaryTypeScore[Trk::numberOfCscEtaHits] = 5;
        m_summaryTypeScore[Trk::numberOfRpcPhiHits] = 5;
        m_summaryTypeScore[Trk::numberOfRpcEtaHits] = 5;
        // New Small Wheel
        m_summaryTypeScore[Trk::numberOfStgcPhiHits] = 5;
        m_summaryTypeScore[Trk::numberOfStgcEtaHits] = 5;
        m_summaryTypeScore[Trk::numberOfMmHits] = 5;
    }

◆ ~MuonTrackScoringTool()

virtual Muon::MuonTrackScoringTool::~MuonTrackScoringTool ( )

virtualdefault

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

◆ 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

◆ initialize()

StatusCode Muon::MuonTrackScoringTool::initialize ( )

overridevirtual

Definition at line 50 of file MuonTrackScoringTool.cxx.

                                                {
        ATH_CHECK(m_trkSummaryTool.retrieve());
        ATH_MSG_DEBUG("Retrieved tool " << m_trkSummaryTool);
 
        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()

const InterfaceID & Trk::ITrackScoringTool::interfaceID ( )

inlinestaticinherited

Definition at line 37 of file ITrackScoringTool.h.

{
  return IID_ITrackScoringTool;
}

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

◆ passBasicSelections()

virtual bool Muon::MuonTrackScoringTool::passBasicSelections ( const Trk::Track & ) const

inlineoverridevirtual

check track selections independent from TrackSummary

Implements Trk::ITrackScoringTool.

Definition at line 32 of file MuonTrackScoringTool.h.

32{return true;}

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

◆ score()

Trk::TrackScore Muon::MuonTrackScoringTool::score	(	const Trk::Track &	track,
		bool	checkBasicSel ) const

overridevirtual

create a score based on how good the passed track is

Implements Trk::ITrackScoringTool.

Definition at line 57 of file MuonTrackScoringTool.cxx.

                                                                                 {
        Trk::TrackScore score;
        const Trk::TrackSummary* summary = track.trackSummary();
        if (summary) {
            score = simpleScore(track, *summary);
        } else {
            // This is potentially slow, so might need revisiting.
            std::unique_ptr<Trk::TrackSummary> tmpSummary = m_trkSummaryTool->summaryNoHoleSearch(track);
            score = simpleScore(track, *tmpSummary);
        }
        return score;
    }

◆ simpleScore()

Trk::TrackScore Muon::MuonTrackScoringTool::simpleScore	(	const Trk::Track &	track,
		const Trk::TrackSummary &	trackSummary ) const

overridevirtual

create a score based on how good the passed TrackSummary is

Implements Trk::ITrackScoringTool.

Definition at line 70 of file MuonTrackScoringTool.cxx.

                                                                                                                    {
        // --- reject bad tracks
        if (track.fitQuality() && track.fitQuality()->numberDoF() < 0) {
            ATH_MSG_VERBOSE("numberDoF < 0, reject it");
            return Trk::TrackScore(0);
        }
 
        ATH_MSG_DEBUG(m_printer->print(track));
 
        // --- now start scoring
        Trk::TrackScore score(200);  // score of 100 per track
 
        // --- prob(chi2,NDF), protect for chi2<0
        if (track.fitQuality() != nullptr && track.fitQuality()->chiSquared() > 0 && track.fitQuality()->numberDoF() > 0) {
            score += 5 * track.fitQuality()->numberDoF() - track.fitQuality()->chiSquared();
        }
 
        // --- summary score analysis
        for (int i = 0; i < Trk::numberOfTrackSummaryTypes; ++i) {
            int value = trackSummary.get(static_cast<Trk::SummaryType>(i));
            // value is -1 if undefined.
            if (value > 0) {
                score += m_summaryTypeScore[i] * value;
                ATH_MSG_VERBOSE("\tType [" << i << "], value \t= " << value << "], score \t=" << score);
            }
        }
        if (score == 0)
            score =
                0.000001;  // since 0 is the bad track score; you'd have to get very unlucky to get a score of exactly 0 but it can happen
        ATH_MSG_DEBUG(" Track Score " << score);
 
        return score;
    }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in 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_printer

PublicToolHandle<MuonEDMPrinterTool> Muon::MuonTrackScoringTool::m_printer

private

Initial value:

{this, "EDMPrinter", "Muon::MuonEDMPrinterTool/MuonEDMPrinterTool",

"helper to nicely print out tracks"}

Definition at line 43 of file MuonTrackScoringTool.h.

43 {this, "EDMPrinter", "Muon::MuonEDMPrinterTool/MuonEDMPrinterTool",

44 "helper to nicely print out tracks"};

◆ m_summaryTypeScore

std::vector<Trk::TrackScore> Muon::MuonTrackScoringTool::m_summaryTypeScore

private

holds the scores assigned to each Trk::SummaryType from the track's Trk::TrackSummary

Definition at line 47 of file MuonTrackScoringTool.h.

◆ m_trkSummaryTool

ToolHandle<Trk::IExtendedTrackSummaryTool> Muon::MuonTrackScoringTool::m_trkSummaryTool {this, "SumHelpTool", "Trk::TrackSummaryTool"}

private

Todo: make this const, once createSummary method is const

Definition at line 42 of file MuonTrackScoringTool.h.

42{this, "SumHelpTool", "Trk::TrackSummaryTool"};

◆ 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

◆ MuonTrackScoringTool()

◆ ~MuonTrackScoringTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ passBasicSelections()

◆ renounce()

◆ renounceArray()

◆ score()

◆ simpleScore()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_printer

◆ m_summaryTypeScore

◆ m_trkSummaryTool

◆ m_varHandleArraysDeclared

◆ m_vhka