Tool to coordinate time-of-flight calculation for various types of muons. More...

#include <MuonCombinedTimingTool.h>

Inheritance diagram for Rec::MuonCombinedTimingTool:

Collaboration diagram for Rec::MuonCombinedTimingTool:

Public Member Functions
	MuonCombinedTimingTool (const std::string &, const std::string &, const IInterface *)
virtual	~MuonCombinedTimingTool ()=default
	default destructor
virtual StatusCode	initialize ()
	standard Athena-Algorithm method
virtual std::vector< Trk::SpaceTimePoint * >	timeMeasurements (const xAOD::Muon &muon) const
	the main method providing the vector of space-time points
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
virtual const Trk::SegmentCollection *	getSegmentContainer (const xAOD::Muon &muon) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< Trk::ITrackTimingTool >	m_trtTimingTool
	time calculation in subdetector responsibility: inner detector
ToolHandle< Trk::ITrackTimingTool >	m_caloTimingTool
	time calculation in subdetector responsibility: calorimeter
ToolHandle< Trk::ITrackTimingTool >	m_mdtSegmentTimingTool
	time calculation in subdetector responsibility: muon spectrometer (T0 fit) for MDT and CSC
ToolHandle< Trk::ITrackTimingTool >	m_rpcTimingTool
	time calculation in subdetector responsibility: muon spectrometer (RPC timing)
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

Tool to coordinate time-of-flight calculation for various types of muons.

It analyses the type of measurements contributing to the muon and calls the appropriate detector tools.

Author: Wolfgang Liebig <->

Definition at line 27 of file MuonCombinedTimingTool.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

◆ MuonCombinedTimingTool()

Rec::MuonCombinedTimingTool::MuonCombinedTimingTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 11 of file MuonCombinedTimingTool.cxx.

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

◆ ~MuonCombinedTimingTool()

virtual Rec::MuonCombinedTimingTool::~MuonCombinedTimingTool ( )

virtualdefault

default destructor

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

◆ getSegmentContainer()

const Trk::SegmentCollection * Rec::MuonCombinedTimingTool::getSegmentContainer ( const xAOD::Muon & muon ) const

privatevirtual

Definition at line 62 of file MuonCombinedTimingTool.cxx.

{
    return nullptr;
}

◆ initialize()

StatusCode Rec::MuonCombinedTimingTool::initialize ( )

virtual

standard Athena-Algorithm method

Definition at line 20 of file MuonCombinedTimingTool.cxx.

{
 
    StatusCode sc = AlgTool::initialize();
    if (sc.isFailure()) return sc;
 
    if (!m_trtTimingTool.empty()) {
        ATH_CHECK(m_trtTimingTool.retrieve());
        ATH_MSG_DEBUG("Retrieved " << m_trtTimingTool.name());
    }
    if (!m_caloTimingTool.empty()) {
        ATH_CHECK(m_caloTimingTool.retrieve());
        ATH_MSG_DEBUG("Retrieved " << m_caloTimingTool.name());
    }
    if (!m_mdtSegmentTimingTool.empty()) {
        ATH_CHECK(m_mdtSegmentTimingTool.retrieve());
        ATH_MSG_DEBUG("Retrieved " << m_mdtSegmentTimingTool.name());
    }
    if (!m_rpcTimingTool.empty()) {
        ATH_CHECK(m_rpcTimingTool.retrieve());
        ATH_MSG_DEBUG("Retrieved " << m_rpcTimingTool.name());
    }
 
    ATH_MSG_DEBUG("initialize() successful in " << name());
    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 & Rec::IMuonCombinedTimingTool::interfaceID ( )

inlinestaticinherited

Definition at line 40 of file IMuonCombinedTimingTool.h.

40{ return IID_IMuonCombinedTimingTool; }

Rec::IID_IMuonCombinedTimingTool

static const InterfaceID IID_IMuonCombinedTimingTool("Rec::IMuonCombinedTimingTool", 1, 0)

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

◆ timeMeasurements()

std::vector< Trk::SpaceTimePoint * > Rec::MuonCombinedTimingTool::timeMeasurements ( const xAOD::Muon & muon ) const

virtual

the main method providing the vector of space-time points

Implements Rec::IMuonCombinedTimingTool.

Definition at line 49 of file MuonCombinedTimingTool.cxx.

{
    std::vector<Trk::SpaceTimePoint*> spaceTimePoints;  // empty vector
    ATH_MSG_WARNING(
        "This tool is not migrated to xAOD yet, please volunteer to update it if you need the information filled");
 
    return spaceTimePoints;
}

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

ToolHandle<Trk::ITrackTimingTool> Rec::MuonCombinedTimingTool::m_caloTimingTool

private

Initial value:

{
        this,
        "CaloTimingTool",
        "Rec::TrackInCaloTimingTool/TrackInCaloTimingTool",
    }

time calculation in subdetector responsibility: calorimeter

Definition at line 47 of file MuonCombinedTimingTool.h.

                                                    {
        this,
        "CaloTimingTool",
        "Rec::TrackInCaloTimingTool/TrackInCaloTimingTool",
    };

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

ToolHandle<Trk::ITrackTimingTool> Rec::MuonCombinedTimingTool::m_mdtSegmentTimingTool

private

Initial value:

{
        this,
        "MDT_TimingTool",
        "Muon::SegmentTimingTool/SegmentTimingTool",
    }

time calculation in subdetector responsibility: muon spectrometer (T0 fit) for MDT and CSC

Definition at line 53 of file MuonCombinedTimingTool.h.

                                                          {
        this,
        "MDT_TimingTool",
        "Muon::SegmentTimingTool/SegmentTimingTool",
    };

◆ m_rpcTimingTool

ToolHandle<Trk::ITrackTimingTool> Rec::MuonCombinedTimingTool::m_rpcTimingTool

private

Initial value:

{
        this,
        "RPC_TimingTool",
        "",
    }

time calculation in subdetector responsibility: muon spectrometer (RPC timing)

Definition at line 59 of file MuonCombinedTimingTool.h.

                                                   {
        this,
        "RPC_TimingTool",
        "",
    };

◆ m_trtTimingTool

ToolHandle<Trk::ITrackTimingTool> Rec::MuonCombinedTimingTool::m_trtTimingTool

private

Initial value:

{
        this,
        "InDetTimingTool",
        "InDet::TRT_TrackTimingTool/TRT_TrackTimingTool",
    }

time calculation in subdetector responsibility: inner detector

Definition at line 41 of file MuonCombinedTimingTool.h.

                                                   {
        this,
        "InDetTimingTool",
        "InDet::TRT_TrackTimingTool/TRT_TrackTimingTool",
    };

◆ 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

◆ MuonCombinedTimingTool()

◆ ~MuonCombinedTimingTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getSegmentContainer()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ timeMeasurements()

◆ updateVHKA()

Member Data Documentation

◆ m_caloTimingTool

◆ m_detStore

◆ m_evtStore

◆ m_mdtSegmentTimingTool

◆ m_rpcTimingTool

◆ m_trtTimingTool

◆ m_varHandleArraysDeclared

◆ m_vhka