#include <MuonSystemExtensionTool.h>

Inheritance diagram for Muon::MuonSystemExtensionTool:

Collaboration diagram for Muon::MuonSystemExtensionTool:

Public Types
typedef std::vector< MuonLayerSurface >	SurfaceVec

Public Member Functions
	MuonSystemExtensionTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default AlgTool functions. More...

virtual	~MuonSystemExtensionTool ()=default

StatusCode	initialize () override

bool	muonSystemExtension (const EventContext &ctx, SystemExtensionCache &cache) const override
	get muon system extension More...

bool	muonLayerInterSections (const EventContext &ctx, const MuonCombined::TagBase &cmb_tag, SystemExtensionCache &cache) const override
	Constructs the layer intersections from a primary muon track using the track states in the muon spectrometer. 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 ()
	AlgTool and IAlgTool interface methods. 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
bool	initializeGeometry ()
	initialize geometry More...

bool	initializeGeometryBarrel (int sector, const Amg::Transform3D &sectorRotation)

bool	initializeGeometryEndcap (int sector, MuonStationIndex::DetectorRegionIndex regionIndex, const Amg::Transform3D &sectorRotation)

SurfaceVec	getSurfacesForIntersection (const Trk::TrackParameters &muonEntryPars, const SystemExtensionCache &cache) const
	get surfaces to be intersected for a given start parameters More...

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
ToolHandle< Trk::IParticleCaloExtensionTool >	m_caloExtensionTool

ToolHandle< Trk::IExtrapolator >	m_extrapolator {this,"Extrapolator",""}

PublicToolHandle< MuonEDMPrinterTool >	m_printer {this, "Printer", "Muon::MuonEDMPrinterTool/MuonEDMPrinterTool"}

ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

ServiceHandle< IMuonEDMHelperSvc >	m_edmHelperSvc

std::array< std::array< SurfaceVec, 16 >, MuonStationIndex::DetectorRegionIndexMax >	m_referenceSurfaces {}
	reference surfaces per region and sector More...

MuonSectorMapping	m_sectorMapping
	sector mapping helper 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

Definition at line 32 of file MuonSystemExtensionTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ SurfaceVec

typedef std::vector<MuonLayerSurface> Muon::MuonSystemExtensionTool::SurfaceVec

Definition at line 34 of file MuonSystemExtensionTool.h.

Constructor & Destructor Documentation

◆ MuonSystemExtensionTool()

Muon::MuonSystemExtensionTool::MuonSystemExtensionTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Default AlgTool functions.

Definition at line 38 of file MuonSystemExtensionTool.cxx.

                                                                                                                            :
         AthAlgTool(type, name, parent) {
         declareInterface<IMuonSystemExtensionTool>(this);
     }

◆ ~MuonSystemExtensionTool()

virtual Muon::MuonSystemExtensionTool::~MuonSystemExtensionTool ( )

virtualdefault

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

◆ getSurfacesForIntersection()

MuonSystemExtensionTool::SurfaceVec Muon::MuonSystemExtensionTool::getSurfacesForIntersection	(	const Trk::TrackParameters &	muonEntryPars,
		const SystemExtensionCache &	cache
	)		const

private

get surfaces to be intersected for a given start parameters

Look whether one of the sectors has actually a recorded hit

Definition at line 231 of file MuonSystemExtensionTool.cxx.

                                                                                                                                      {
         // if in endcaps pick endcap surfaces
         const double eta = muonEntryPars.position().eta();
         MuonStationIndex::DetectorRegionIndex regionIndex = MuonStationIndex::Barrel;
         if (eta < -1.05) regionIndex = MuonStationIndex::EndcapC;
         if (eta > 1.05) regionIndex = MuonStationIndex::EndcapA;
  
         // in barrel pick primary sector
         const double phi = muonEntryPars.position().phi();
         std::vector<int> sectors;
         m_sectorMapping.getSectors(phi, sectors);
         SurfaceVec surfaces;
         if (cache.useHitSectors) {
             const auto map_itr = cache.sectorsWithHits->find(regionIndex);
             if (map_itr == cache.sectorsWithHits->end()) {
                 ATH_MSG_DEBUG("No hits in detector region " << Muon::MuonStationIndex::regionName(regionIndex));
                 return surfaces;
             }
             std::vector<int>::const_iterator sec_itr = std::find_if(
                 sectors.begin(), sectors.end(), [&map_itr](const int& sector) -> bool { return map_itr->second.count(sector); });
             if (sec_itr == sectors.end()) {
                 ATH_MSG_DEBUG("No hits found for sector " << m_sectorMapping.getSector(phi) << " in MuonStation "
                                                           << Muon::MuonStationIndex::regionName(regionIndex));
                 return surfaces;
             }
         }
  
         for (const int sector : sectors) {
             surfaces.insert(surfaces.end(), m_referenceSurfaces[regionIndex][sector - 1].begin(),
                             m_referenceSurfaces[regionIndex][sector - 1].end());
         }
         std::stable_sort(surfaces.begin(), surfaces.end(), 
                          [&muonEntryPars](const MuonLayerSurface& s1, const MuonLayerSurface& s2) {
                             return std::abs(pathAlongPars(muonEntryPars,s1.surfacePtr->center())) <
                                    std::abs(pathAlongPars(muonEntryPars,s2.surfacePtr->center()));
                             
                          });
         if (msgLvl(MSG::VERBOSE)) {
             for (auto& s1 : surfaces) {
                 ATH_MSG_VERBOSE("Surface "<<Muon::MuonStationIndex::layerName(s1.layerIndex)
                               <<", center: "<<Amg::toString(s1.surfacePtr->center())
                               <<", pathAlongPars "<<pathAlongPars(muonEntryPars,s1.surfacePtr->center())
                               <<std::endl<<(*s1.surfacePtr));
  
             }
         }
         return surfaces;
     }

◆ initialize()

StatusCode Muon::MuonSystemExtensionTool::initialize ( )

override

Definition at line 43 of file MuonSystemExtensionTool.cxx.

                                                    {
         ATH_CHECK(m_caloExtensionTool.retrieve());
         ATH_CHECK(m_extrapolator.retrieve());
         ATH_CHECK(m_idHelperSvc.retrieve());
         if (!initializeGeometry()) return StatusCode::FAILURE;
  
         return StatusCode::SUCCESS;
     }

◆ initializeGeometry()

bool Muon::MuonSystemExtensionTool::initializeGeometry ( )

private

initialize geometry

Definition at line 52 of file MuonSystemExtensionTool.cxx.

                                                      {
         // initialize reference surfaces hash vectors per region and sector
  
         // first build the barrel, we need different reference planes for all sectors
         ATH_MSG_DEBUG("Initializing barrel ");
         for (unsigned int sector = 1; sector <= 16; ++sector) {
             // get rotation into sector frame
             double sectorPhi = m_sectorMapping.sectorPhi(sector);
             const Amg::Transform3D sectorRotation(Amg::getRotateZ3D(sectorPhi));
             if (!initializeGeometryBarrel(sector, sectorRotation)) return false;
             if (!initializeGeometryEndcap(sector, MuonStationIndex::EndcapA, sectorRotation)) return false;
             if (!initializeGeometryEndcap(sector, MuonStationIndex::EndcapC, sectorRotation)) return false;
         }
  
         return true;
     }

◆ initializeGeometryBarrel()

bool Muon::MuonSystemExtensionTool::initializeGeometryBarrel	(	int	sector,
		const Amg::Transform3D &	sectorRotation
	)

private

Definition at line 105 of file MuonSystemExtensionTool.cxx.

                                                                                                            {
         MuonChamberLayerDescription chamberLayerDescription;
  
         SurfaceVec& surfaces = m_referenceSurfaces[MuonStationIndex::Barrel][sector - 1];
         constexpr double xToZRotation = -M_PI_2;
  
         for (unsigned int stationLayer = MuonStationIndex::BI; stationLayer <= MuonStationIndex::BE; ++stationLayer) {
             // skip BEE if in small sectors, not installed
             if (stationLayer == MuonStationIndex::BE && m_sectorMapping.isSmall(sector)) continue;
  
             // calculate reference position from radial position of the laeyr
             MuonStationIndex::LayerIndex layer = MuonStationIndex::toLayerIndex((MuonStationIndex::StIndex)(stationLayer));
             MuonChamberLayerDescriptor layerDescriptor = chamberLayerDescription.getDescriptor(sector, MuonStationIndex::Barrel, layer);
             Amg::Vector3D positionInSector(layerDescriptor.referencePosition, 0., 0.);
             Amg::Vector3D globalPosition = sectorRotation * positionInSector;
  
             // reference transform + surface
             Amg::Transform3D trans(sectorRotation * Amg::getRotateY3D(xToZRotation));
             trans.pretranslate(globalPosition);
             std::unique_ptr<Trk::PlaneSurface> surface = std::make_unique<Trk::PlaneSurface>(trans);
             // sanity checks
             if (msgLvl(MSG::VERBOSE)) {
                 double sectorPhi = m_sectorMapping.sectorPhi(sector);
                 ATH_MSG_VERBOSE(" sector " << sector << " layer " << MuonStationIndex::layerName(layer) << " phi " << sectorPhi
                                            << " ref theta " << globalPosition.theta() << " phi " << globalPosition.phi() << " r "
                                            << globalPosition.perp() << " pos " << Amg::toString(globalPosition)
                                            << " lpos3d " << Amg::toString(surface->transform().inverse() * globalPosition) 
                                            << " normal: " << Amg::toString(surface->normal()));
             }
             MuonLayerSurface data(std::move(surface), sector, MuonStationIndex::Barrel, layer);
             surfaces.push_back(std::move(data));
  
  
         }
         return true;
     }

◆ initializeGeometryEndcap()

bool Muon::MuonSystemExtensionTool::initializeGeometryEndcap	(	int	sector,
		MuonStationIndex::DetectorRegionIndex	regionIndex,
		const Amg::Transform3D &	sectorRotation
	)

private

Definition at line 69 of file MuonSystemExtensionTool.cxx.

                                                                                                  {
         ATH_MSG_DEBUG("Initializing endcap: sector " << sector << " " << MuonStationIndex::regionName(regionIndex));
  
         SurfaceVec& surfaces = m_referenceSurfaces[regionIndex][sector - 1];
         MuonChamberLayerDescription chamberLayerDescription;
  
         static const std::vector<MuonStationIndex::StIndex> layers = {MuonStationIndex::EI, MuonStationIndex::EE, MuonStationIndex::EM,
                                                          MuonStationIndex::EO};
  
         for (const MuonStationIndex::StIndex& stLayer : layers) {
             // calculate reference position from radial position of the layer
             MuonStationIndex::LayerIndex layer = MuonStationIndex::toLayerIndex(stLayer);
             MuonChamberLayerDescriptor layerDescriptor = chamberLayerDescription.getDescriptor(sector, regionIndex, layer);
             // reference transform + surface
             Amg::Transform3D trans{Amg::getTranslateZ3D(layerDescriptor.referencePosition) *sectorRotation};  //*Amg::AngleAxis3D(xToZRotation,Amg::Vector3D(0.,1.,0.)
             std::unique_ptr<Trk::PlaneSurface> surface = std::make_unique<Trk::PlaneSurface>(trans);
             // sanity checks
             if (msgLvl(MSG::VERBOSE)) {
                 ATH_MSG_VERBOSE("initializeGeometryEndcap() --  sector " << sector << " layer " << MuonStationIndex::layerName(layer) << " surface "
                                             <<Amg::toString(surface->transform())
                                             << " center " << Amg::toString(surface->center()) << " theta " << surface->normal().theta() 
                                             << " normal:  " <<Amg::toString(surface->normal()));
                 
                 
             }
  
             MuonLayerSurface data(std::move(surface), sector, regionIndex, layer);
             surfaces.push_back(std::move(data));
  
  
         }
         ATH_MSG_VERBOSE(" Total number of surfaces " << surfaces.size());
         return true;
     }

◆ 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::IMuonSystemExtensionTool::interfaceID ( )

inlinestaticinherited

AlgTool and IAlgTool interface methods.

Definition at line 35 of file IMuonSystemExtensionTool.h.

                                                 {
             static const InterfaceID IID_IMuonSystemExtensionTool("Muon::IMuonSystemExtensionTool", 1, 0);
             return IID_IMuonSystemExtensionTool;
         }

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

◆ muonLayerInterSections()

bool Muon::MuonSystemExtensionTool::muonLayerInterSections	(	const EventContext &	ctx,
		const MuonCombined::TagBase &	cmb_tag,
		SystemExtensionCache &	cache
	)		const

overridevirtual

Constructs the layer intersections from a primary muon track using the track states in the muon spectrometer.

Get the proper surfaces for the intersections

The parameters are not muon paramaters or the parameters are before the entrance parameters

The track parameters belong the same surface. Do nothing

Check whether there're measurement parameters that are closer to the target surface

Implements Muon::IMuonSystemExtensionTool.

Definition at line 281 of file MuonSystemExtensionTool.cxx.

                                                                                            {
  
         const Trk::Track* cmbTrk = cmbTag.primaryTrack();
         if (!cmbTrk){
             ATH_MSG_WARNING("A combined tag without any track? Please check "<<cmbTag.toString());
             return false;
         }
         const Trk::TrackParameters* entryPars = cache.candidate->getCaloExtension()->muonEntryLayerIntersection();
         std::vector<const Trk::TrackStateOnSurface*> cmbParVec{};
  
         ATH_MSG_VERBOSE("Calo entry parameters "<<m_printer->print(*entryPars));
         std::vector<Muon::MuonSystemExtension::Intersection> intersections{};
         Muon::MuonLayerSurface lastSurf{};
         
         const Trk::TrackStates::const_iterator end_itr = cmbTrk->trackStateOnSurfaces()->end();
         for (Trk::TrackStates::const_iterator itr = cmbTrk->trackStateOnSurfaces()->begin(); itr != end_itr; ++itr) {
             const Trk::TrackStateOnSurface* msTSOS{*itr};
             ATH_MSG_VERBOSE("Track state "<<m_printer->print(*msTSOS));
  
             if (!msTSOS->measurementOnTrack()) {
                 continue;
             } 
             const Identifier measId = m_edmHelperSvc->getIdentifier(*msTSOS->measurementOnTrack());
             const Trk::TrackParameters& msPars{*msTSOS->trackParameters()};
             if (!m_idHelperSvc->isMuon(measId) || pathAlongPars(msPars, msPars.position() - entryPars->position())< 0.){
                 continue;
             }
                
             Muon::MuonStationIndex::DetectorRegionIndex regionIdx = m_idHelperSvc->regionIndex(measId);
             Muon::MuonStationIndex::LayerIndex layerIdx = m_idHelperSvc->layerIndex(measId);
             if (layerIdx == Muon::MuonStationIndex::BarrelExtended) {
                 regionIdx = Muon::MuonStationIndex::DetectorRegionIndex::Barrel;
                 layerIdx = Muon::MuonStationIndex::Inner;
             }
  
             const int sector = m_sectorMapping.getSector(msTSOS->measurementOnTrack()->associatedSurface().center().phi());
        
             if (lastSurf.layerIndex == layerIdx && lastSurf.regionIndex == regionIdx && lastSurf.sector == sector) {
                 continue;
             }
             const SurfaceVec& refSurfaces = m_referenceSurfaces[regionIdx][sector - 1];
             SurfaceVec::const_iterator surfItr = std::find_if(refSurfaces.begin(), refSurfaces.end(),
                                                     [&layerIdx](const MuonLayerSurface& surf){
                                                     return surf.layerIndex == layerIdx;
                                                     });
             if (surfItr == refSurfaces.end()) {
                 ATH_MSG_WARNING("Failed to find a reference surface matching to combined parameters "<<m_printer->print(*msTSOS)
                                 <<", sector: "<<sector <<", layer: "<<Muon::MuonStationIndex::layerName(layerIdx)
                                 <<", region index: "<<Muon::MuonStationIndex::regionName(regionIdx));
                 continue;
             }
             lastSurf = (*surfItr);
             const Trk::Surface& target{*lastSurf.surfacePtr};
                 
             for (Trk::TrackStates::const_iterator closePars = itr+1; closePars != end_itr; ++closePars) {
                 const Trk::TrackStateOnSurface * tsosInChamb{*closePars};
                 if (!tsosInChamb->measurementOnTrack()) continue; 
                 
                 const Trk::TrackParameters& chPars{*tsosInChamb->trackParameters()};
                 if (std::abs(pathAlongPars(chPars, chPars.position() - target.center())) >
                     std::abs(pathAlongPars(*msTSOS->trackParameters(), 
                                             msTSOS->trackParameters()->position() - target.center()))) {
                     break;
                 }
                 itr =  closePars -1;
                 msTSOS = *itr;
             }
                 
             std::unique_ptr<Trk::TrackParameters> exPars{m_extrapolator->extrapolate(ctx, *msTSOS->trackParameters(), 
                                                                                      target, Trk::anyDirection, false, Trk::muon)};
             if (!exPars) {
                 ATH_MSG_VERBOSE(__LINE__<<" - Failed to extrapolate track @ "<<m_printer->print(*msTSOS)
                                 <<", sector: "<<sector
                                 <<", layer: "<<Muon::MuonStationIndex::layerName(layerIdx)
                                 <<", region index: "<<Muon::MuonStationIndex::regionName(regionIdx)
                                 <<" to surface "<<std::endl<<target<<std::endl
                                 <<", sector: "<<lastSurf.sector
                                 <<", layer: "<<Muon::MuonStationIndex::layerName(lastSurf.layerIndex)
                                 <<", region index: "<<Muon::MuonStationIndex::regionName(lastSurf.regionIndex)
                                 <<" pathAlongPars "<<pathAlongPars(*msTSOS->trackParameters(), target.center())
                                 <<", dir: "<<Amg::toString(msTSOS->trackParameters()->momentum().unit()));
                 continue;
             }
             intersections.emplace_back(std::move(exPars), lastSurf);
             
         }
         
         ATH_MSG_VERBOSE("Selected "<<intersections.size()<<" intersections");
         
         if (intersections.empty()) {
             ATH_MSG_DEBUG("Failed to find the intersections for the combined track");
             return false;
         }
         cache.candidate->setExtension(std::make_unique<MuonSystemExtension>(entryPars, std::move(intersections)));
  
         return true;
     }

◆ muonSystemExtension()

bool Muon::MuonSystemExtensionTool::muonSystemExtension	(	const EventContext &	ctx,
		SystemExtensionCache &	cache
	)		const

overridevirtual

get muon system extension

Get the calo extension

Implements Muon::IMuonSystemExtensionTool.

Definition at line 142 of file MuonSystemExtensionTool.cxx.

                                                                                                                 {
         if (!cache.candidate->getCaloExtension()) {
             if (!cache.extensionContainer) {
                 std::unique_ptr<Trk::CaloExtension> caloExtension =
                         m_caloExtensionTool->caloExtension(ctx, cache.candidate->indetTrackParticle());
                 if (!caloExtension || !caloExtension->muonEntryLayerIntersection()) {
                     ATH_MSG_VERBOSE("Failed to create the calo extension for "<<cache.candidate->toString());
                     return false;
                 }
                 cache.candidate->setExtension(caloExtension);
             } else {
                 const Trk::CaloExtension* caloExtension = m_caloExtensionTool->caloExtension(cache.candidate->indetTrackParticle(),
                                                                     *cache.extensionContainer);
                 if (!caloExtension || !caloExtension->muonEntryLayerIntersection()) {
                     ATH_MSG_VERBOSE("Failed to create the calo extension for "<<cache.candidate->toString());
                     return false;
                 }
                 cache.candidate->setExtension(caloExtension);
             }
         }
  
         if (!cache.createSystemExtension) {
             ATH_MSG_VERBOSE("No system extension is required for "<<cache.candidate->toString());
             return true;
         }
         // get entry parameters, use it as current parameter for the extrapolation
         const Trk::TrackParameters* currentPars = cache.candidate->getCaloExtension()->muonEntryLayerIntersection();
  
         // get reference surfaces
         ATH_MSG_VERBOSE(" getSurfacesForIntersection " << currentPars);
         SurfaceVec surfaces = getSurfacesForIntersection(*currentPars, cache);
  
         // store intersections
         std::vector<MuonSystemExtension::Intersection> intersections;
  
         // garbage collection
         std::vector<std::shared_ptr<Trk::TrackParameters> > trackParametersVec;
  
         // loop over reference surfaces
         for (const Muon::MuonLayerSurface& it : surfaces) {
             // extrapolate to next layer
             const Trk::Surface& surface = *it.surfacePtr;
             ATH_MSG_VERBOSE(" startPars: "<<m_printer->print(*currentPars));
             ATH_MSG_VERBOSE(" destination: sector " << it.sector << "  " << MuonStationIndex::regionName(it.regionIndex) << "  "
                                                     << MuonStationIndex::layerName(it.layerIndex) << " phi  " << surface.center().phi()
                                                     << " r " << surface.center().perp() << " z " << surface.center().z());
  
             std::unique_ptr<Trk::TrackParameters> exPars{m_extrapolator->extrapolate(ctx, *currentPars, surface, 
                                                                                      Trk::alongMomentum, false, Trk::muon)};
             if (!exPars) {
                 ATH_MSG_VERBOSE("extrapolation failed, trying next layer ");
                 continue;
             }
             ATH_MSG_DEBUG("Extrapolated in event "<<ctx.eventID().event_number()<<" track @ "<<m_printer->print(*exPars));
  
             //    reject intersections with very big uncertainties (parallel to surface)
             const double sigma_lx = Amg::error(*exPars->covariance(), Trk::locX);
             const double sigma_ly = Amg::error(*exPars->covariance(), Trk::locY);
             if (!Amg::hasPositiveDiagElems(*exPars->covariance()) || std::max(sigma_lx, sigma_ly) > 1. * Gaudi::Units::meter){
                 ATH_MSG_DEBUG("Reject bad extrapolation "<<m_printer->print(*exPars));
                 continue;
             }
  
             // create shared pointer and add to garbage collection
             std::shared_ptr<Trk::TrackParameters> sharedPtr{std::move(exPars)};
             trackParametersVec.emplace_back(sharedPtr);
  
             intersections.emplace_back(sharedPtr, it);
             constexpr double TenCm = 10. * Gaudi::Units::cm;
             if(std::hypot(sigma_lx, sigma_ly) < std::max(TenCm, 10. * std::hypot(Amg::error(*currentPars->covariance(), Trk::locX),
                                                                                  Amg::error(*currentPars->covariance(), Trk::locY)))) {
                 // only update the parameters if errors don't blow up
                 currentPars = sharedPtr.get();
             } else {
                 ATH_MSG_DEBUG("Extrapolation reached at "<<m_printer->print(*sharedPtr)<<" has larger uncertainties than "<<
                               m_printer->print(*currentPars));
             }
         }
         ATH_MSG_DEBUG("Completed extrapolation: destinations " << surfaces.size() << " intersections " << intersections.size());
         if (intersections.empty()){
             ATH_MSG_DEBUG("No system extensions are made for "<<cache.candidate->toString()
                          <<" will accept the candidate: "<< (!cache.requireSystemExtension ? "si": "no"));
             return !cache.requireSystemExtension;
         }
         cache.candidate->setExtension(std::make_unique<MuonSystemExtension>(cache.candidate->getCaloExtension()->muonEntryLayerIntersection(), 
                                                                             std::move(intersections)));
         return true;
     }

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

ToolHandle<Trk::IParticleCaloExtensionTool> Muon::MuonSystemExtensionTool::m_caloExtensionTool

private

Initial value:

{
            this,
            "ParticleCaloExtensionTool",
            "Trk::ParticleCaloExtensionTool/ParticleCaloExtensionTool",
        }

Definition at line 58 of file MuonSystemExtensionTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_edmHelperSvc

ServiceHandle<IMuonEDMHelperSvc> Muon::MuonSystemExtensionTool::m_edmHelperSvc

private

Initial value:

{this,"edmHelper","Muon::MuonEDMHelperSvc/MuonEDMHelperSvc",

"Handle to the service providing the IMuonEDMHelperSvc interface"}

Definition at line 69 of file MuonSystemExtensionTool.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_extrapolator

ToolHandle<Trk::IExtrapolator> Muon::MuonSystemExtensionTool::m_extrapolator {this,"Extrapolator",""}

private

Definition at line 63 of file MuonSystemExtensionTool.h.

◆ m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::MuonSystemExtensionTool::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

private

Definition at line 67 of file MuonSystemExtensionTool.h.

◆ m_printer

PublicToolHandle<MuonEDMPrinterTool> Muon::MuonSystemExtensionTool::m_printer {this, "Printer", "Muon::MuonEDMPrinterTool/MuonEDMPrinterTool"}

private

Definition at line 65 of file MuonSystemExtensionTool.h.

◆ m_referenceSurfaces

std::array<std::array<SurfaceVec, 16> , MuonStationIndex::DetectorRegionIndexMax > Muon::MuonSystemExtensionTool::m_referenceSurfaces {}

private

reference surfaces per region and sector

Definition at line 74 of file MuonSystemExtensionTool.h.

◆ m_sectorMapping

MuonSectorMapping Muon::MuonSystemExtensionTool::m_sectorMapping

private

sector mapping helper

Definition at line 77 of file MuonSystemExtensionTool.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

◆ StoreGateSvc_t

◆ SurfaceVec

Constructor & Destructor Documentation

◆ MuonSystemExtensionTool()

◆ ~MuonSystemExtensionTool()

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

◆ getSurfacesForIntersection()

◆ initialize()

◆ initializeGeometry()

◆ initializeGeometryBarrel()

◆ initializeGeometryEndcap()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ muonLayerInterSections()

◆ muonSystemExtension()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_caloExtensionTool

◆ m_detStore

◆ m_edmHelperSvc

◆ m_evtStore

◆ m_extrapolator

◆ m_idHelperSvc

◆ m_printer

◆ m_referenceSurfaces

◆ m_sectorMapping

◆ m_varHandleArraysDeclared

◆ m_vhka