Helper class to group muon sgements that may belong to a muon trajectory. More...

#include <MsTrackSeeder.h>

Inheritance diagram for MuonR4::MsTrackSeeder:

Collaboration diagram for MuonR4::MsTrackSeeder:

Classes
struct	Config

Public Types
enum	SeedCoords { eDetSection, eSector, ePosOnCylinder }
	Abrivation of the seed coordinates. More...

using	SearchTree_t = Acts::KDTree< 3, const xAOD::MuonSegment *, double, std::array, 6 >
	Definition of the search tree class. More...

using	Location = MsTrackSeed::Location
	Enum toggling whether the segment is in the endcap or barrel. More...

Public Member Functions
	MsTrackSeeder (const std::string &msgName, Config &&cfg)
	Standard constructor. More...

SearchTree_t	constructTree (const xAOD::MuonSegmentContainer &segments) const
	Construct a complete search tree from a MuonSegment container. More...

Amg::Vector2D	expressOnCylinder (const xAOD::MuonSegment &segment, const Location loc) const
	Expresses the segment on the cylinder surface. More...

bool	withinBounds (const Amg::Vector2D &projPos, const Location loc) const
	Returns whether the expression on the cylinder is within the surface bounds. More...

std::unique_ptr< MsTrackSeedContainer >	findTrackSeeds (const EventContext &ctx, const xAOD::MuonSegmentContainer &segments) const
	Constructs the MS track seeds from the segment container. More...

bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Private Types
using	TreeRawVec_t = SearchTree_t::vector_t
	Abbrivation of the KDTree raw data vector. More...

Private Member Functions
void	appendSegment (const xAOD::MuonSegment *segment, const Location loc, TreeRawVec_t &outContainer) const
	Append the to the raw data container. More...

std::unique_ptr< MsTrackSeedContainer >	resolveOverlaps (MsTrackSeedContainer &&unresolved) const
	Removes exact duplciates or partial subsets of the MsTrackSeeds. More...

void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
Config	m_cfg {}

std::string	m_nm
	Message source name. More...

boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...

std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...

std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...

std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Helper class to group muon sgements that may belong to a muon trajectory.

The reconstructed muon segments are projected onto the surface of a cylinder crossing roughly the middle stations of the MS. They are then appended to a 3-dimensional search tree using the extrapolated coordinate on the cylnder, the cylinder surface index and the segment's associated sector number.

Definition at line 25 of file MsTrackSeeder.h.

Member Typedef Documentation

◆ Location

using MuonR4::MsTrackSeeder::Location = MsTrackSeed::Location

Enum toggling whether the segment is in the endcap or barrel.

Definition at line 48 of file MsTrackSeeder.h.

◆ SearchTree_t

using MuonR4::MsTrackSeeder::SearchTree_t = Acts::KDTree<3, const xAOD::MuonSegment*, double, std::array, 6>

Definition of the search tree class.

Definition at line 46 of file MsTrackSeeder.h.

◆ TreeRawVec_t

using MuonR4::MsTrackSeeder::TreeRawVec_t = SearchTree_t::vector_t

private

Abbrivation of the KDTree raw data vector.

Definition at line 84 of file MsTrackSeeder.h.

Member Enumeration Documentation

◆ SeedCoords

enum MuonR4::MsTrackSeeder::SeedCoords

Abrivation of the seed coordinates.

Enumerator
eDetSection	Encode the seed location (-1,1 -> endcaps, 0 -> barrel
eSector	Sector of the associated spectrometer sector.
ePosOnCylinder	Extrapolation position along the cylinder surface.

Definition at line 50 of file MsTrackSeeder.h.

                            {
                 eDetSection,
                 eSector,
                 ePosOnCylinder
             };

Constructor & Destructor Documentation

◆ MsTrackSeeder()

MuonR4::MsTrackSeeder::MsTrackSeeder	(	const std::string &	msgName,
		Config &&	cfg
	)

Standard constructor.

Parameters

msgName	Name of the seeder's msgStream
cfg	Configured cylinder dimensions, cuts & selection tool

Definition at line 11 of file MsTrackSeeder.cxx.

                                                                       :
         AthMessaging{msgName},
         m_cfg{std::move(cfg)}{}

Member Function Documentation

◆ appendSegment()

void MuonR4::MsTrackSeeder::appendSegment	(	const xAOD::MuonSegment *	segment,
		const Location	loc,
		TreeRawVec_t &	outContainer
	)		const

private

Append the to the raw data container.

If the projection onto the barrel cylinder / endcap discs exceeds the bounds, the segment is not added. Segments in sector 1/16 are mirrored into sector 0/17 to complete the search range

Parameters

segment	Pointer to the segment to add
loc	Switch whether the segment shall be projected onto barrel/endcap
outContainer	Raw KDTree data vector where the segment is appended

Extend the segment's at the sector numbering discontinuity

Definition at line 48 of file MsTrackSeeder.cxx.

                                                                         {
         
         const Amg::Vector2D refPoint{expressOnCylinder(*segment, loc)};
         ATH_MSG_VERBOSE(__func__<<"()  "<<__LINE__<<" - Try to add new segment: "
                     <<detailedSegment(*segment)->msSector()->identString()<<" "
                     <<Amg::toString(segment->position())<<" + "<<Amg::toString(segment->direction())
                     <<" --> "<<Amg::toString(refPoint));
         if (!withinBounds(refPoint, loc)) {
             return;
         }
         std::array<double, 3> coords{};
         coords[eDetSection] = sign(refPoint[1]) * static_cast<int>(loc);
         const int sector = detailedSegment(*segment)->msSector()->sector();
         coords[eSector] = sector;
         coords[ePosOnCylinder] = refPoint[Location::Barrel == loc];
         outContainer.emplace_back(std::move(coords), segment);
         if (sector == 1 || sector== 16) {
             outContainer.emplace_back(outContainer.back()).first[eSector] = (sector == 1 ? 17 : 0);
         }
     }

◆ constructTree()

SearchTree_t MuonR4::MsTrackSeeder::constructTree ( const xAOD::MuonSegmentContainer & segments ) const

Construct a complete search tree from a MuonSegment container.

Parameters

segments Reference to the segment container to construct.

Definition at line 71 of file MsTrackSeeder.cxx.

                                                                                            {
         TreeRawVec_t rawData{};
         rawData.reserve(2*segments.size());
         for (const xAOD::MuonSegment* segment : segments){
             appendSegment(segment, Location::Barrel, rawData);
             appendSegment(segment, Location::Endcap, rawData);
         }
         ATH_MSG_VERBOSE("Create a new tree with "<<rawData.size()<<" entries. ");
         return SearchTree_t{std::move(rawData)};
     }

◆ expressOnCylinder()

Amg::Vector2D MuonR4::MsTrackSeeder::expressOnCylinder	(	const xAOD::MuonSegment &	segment,
		const Location	loc
	)		const

Expresses the segment on the cylinder surface.

Parameters

segment	Reference to the segment of consideration
loc	Surface location: [barrel/endcap]

Definition at line 15 of file MsTrackSeeder.cxx.

                                                                              {
         const Amg::Vector3D pos{segment.position()};
         const Amg::Vector3D dir{segment.direction()};
  
         const Amg::Vector2D projPos{pos.perp(), pos.z()};
         const Amg::Vector2D projDir{dir.perp(), dir.z()};
  
         double lambda{0.};
         if (Location::Barrel == loc) {
             lambda = Amg::intersect<2>(projPos, projDir, Amg::Vector2D::UnitX(), 
                                         m_cfg.barrelRadius).value_or(10. * Gaudi::Units::km);
         } else {
             lambda = Amg::intersect<2>(projPos, projDir, Amg::Vector2D::UnitY(), 
                                        sign(projPos[1])* m_cfg.endcapDiscZ).value_or(10. * Gaudi::Units::km);
         }
         return projPos + lambda * projDir;  
     }

◆ findTrackSeeds()

std::unique_ptr< MsTrackSeedContainer > MuonR4::MsTrackSeeder::findTrackSeeds	(	const EventContext &	ctx,
		const xAOD::MuonSegmentContainer &	segments
	)		const

Constructs the MS track seeds from the segment container.

Parameters

ctx	EventContext to access conditions / event data
segments	Refrence to the overall event's segment container

Bad segment not suitable for track seeding or the segment coordinates are just mirrored at the overlap between sector 1 -> 16

Define the search range.

Ensure that only endcap / barrel seeds are considered. The values are integers -> add tiny margin

Move 25 cm along the projected plane

Include the neighbouring sectors

Using the cube above, let the tree search for all compatible segments

Ensure that the sector overlap and momentum vectors are compatible with a MS trajectory

No segments were combined

Calculate the seed's position

Definition at line 81 of file MsTrackSeeder.cxx.

                                                                                                                         {
         SearchTree_t orderedSegs{constructTree(segments)};
         MsTrackSeedContainer trackSeeds{};
  
         for (const auto& [coords, seedCandidate] : orderedSegs) {
             const Segment* recoCandidate = detailedSegment(*seedCandidate);
              if (coords[eSector] == 0 || coords[eSector] == 17 || 
                 !m_cfg.selector->passSeedingQuality(ctx, *recoCandidate)){
                 continue;
             }
             SearchTree_t::range_t selectRange{};
             selectRange[eDetSection].shrink(coords[eDetSection] - 0.1, coords[eDetSection] + 0.1);
             selectRange[ePosOnCylinder].shrink(coords[ePosOnCylinder] - m_cfg.seedHalfLength, 
                                                coords[ePosOnCylinder] + m_cfg.seedHalfLength);
             selectRange[eSector].shrink(coords[eSector]-1.25, coords[eSector] + 1.25);
             
             MsTrackSeed newSeed{static_cast<Location>(std::abs(coords[eDetSection]))};
             orderedSegs.rangeSearchMapDiscard(selectRange, [this, &ctx, &newSeed, &recoCandidate](
                     const SearchTree_t::coordinate_t& /*coords*/,
                     const xAOD::MuonSegment* extendWithMe) {
                         const Segment* extendCandidate = detailedSegment(*extendWithMe);
                         if (m_cfg.selector->compatibleForTrack(ctx, *recoCandidate, *extendCandidate)) {
                             newSeed.addSegment(extendWithMe);
                         }
             });
             if (newSeed.segments().empty()) {
                 continue;
             }
             newSeed.addSegment(seedCandidate);
             const double r = newSeed.location() == Location::Barrel ? m_cfg.barrelRadius : coords[ePosOnCylinder];
             const double z = newSeed.location() == Location::Barrel ? coords[ePosOnCylinder] 
                                                  : coords[eDetSection]* m_cfg.endcapDiscZ;
             Amg::Vector3D pos = r * Amg::dirFromAngles(seedCandidate->position().phi(), 90. * Gaudi::Units::deg)
                               + z * Amg::Vector3D::UnitZ();
             
             newSeed.setPosition(std::move(pos));
             trackSeeds.emplace_back(std::move(newSeed));
         }
         return resolveOverlaps(std::move(trackSeeds));
     }

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

 {
   m_imsg = Athena::getMessageSvc();
   m_lvl = m_imsg ?
     static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
     MSG::INFO;
 }

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

 {
   MsgStream* ms = m_msg_tls.get();
   if (!ms) {
     if (!m_initialized.test_and_set()) initMessaging();
     ms = new MsgStream(m_imsg,m_nm);
     m_msg_tls.reset( ms );
   }
  
   ms->setLevel (m_lvl);
   return *ms;
 }

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

 {
   if (!m_initialized.test_and_set()) initMessaging();
   if (m_lvl <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ resolveOverlaps()

std::unique_ptr< MsTrackSeedContainer > MuonR4::MsTrackSeeder::resolveOverlaps ( MsTrackSeedContainer && unresolved ) const

private

Removes exact duplciates or partial subsets of the MsTrackSeeds.

Parameters

unresolved Input MsTrackSeedContainer with duplicates

Resort the seeds starting from the ones with the most segments to the lowest

Only seeds which are not subsets of others are kept

Definition at line 135 of file MsTrackSeeder.cxx.

                                                                               {
  
         std::ranges::sort(unresolved, [](const MsTrackSeed& a, const MsTrackSeed&b) {
             return a.segments().size() > b.segments().size();
         });
         auto outputSeeds = std::make_unique<MsTrackSeedContainer>();
         outputSeeds->reserve(unresolved.size());
         std::ranges::copy_if(std::move(unresolved), std::back_inserter(*outputSeeds),
             [this, &outputSeeds](const MsTrackSeed& testMe) {
                 const bool add = std::ranges::none_of(*outputSeeds, [&testMe](const MsTrackSeed& goodSeed){
                                     return testMe < goodSeed;
                                 });
                 if (add) {
                     ATH_MSG_VERBOSE("Add new seed "<<std::endl<<testMe);
                 }
                 return add;
             });
         return outputSeeds;
     } 

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

 {
   m_lvl = lvl;
 }

◆ withinBounds()

bool MuonR4::MsTrackSeeder::withinBounds	(	const Amg::Vector2D &	projPos,
		const Location	loc
	)		const

Returns whether the expression on the cylinder is within the surface bounds.

Parameters

projPos	Projected position on the cylinder
loc	Surface location: [barrel/endcap]

Definition at line 33 of file MsTrackSeeder.cxx.

                                                                {
         using enum Location;
         if (loc == Barrel && std::abs(projPos[1]) > std::min(m_cfg.endcapDiscZ, m_cfg.barrelLength)) {
             ATH_MSG_VERBOSE(__func__<<"()  "<<__LINE__<<" Position "<<Amg::toString(projPos)<<
                             "exceeds cylinder boundaries ("<<m_cfg.barrelRadius<<", "
                             <<std::min(m_cfg.endcapDiscZ, m_cfg.barrelLength)<<")");
             return false;
         } else if (loc == Endcap && (0 > projPos[0] || projPos[0] > m_cfg.endcapDiscRadius)) {
             ATH_MSG_VERBOSE(__func__<<"()  "<<__LINE__<<" Position "<<Amg::toString(projPos)<<
             "exceeds endcap boundaries ("<<m_cfg.endcapDiscRadius<<", "<<(sign(projPos[1])*m_cfg.endcapDiscZ)<<")");
             return false;
         }
         return true;
     }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_cfg

Config MuonR4::MsTrackSeeder::m_cfg {}

private

Definition at line 98 of file MsTrackSeeder.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Location

◆ SearchTree_t

◆ TreeRawVec_t

Member Enumeration Documentation

◆ SeedCoords

Constructor & Destructor Documentation

◆ MsTrackSeeder()

Member Function Documentation

◆ appendSegment()

◆ constructTree()

◆ expressOnCylinder()

◆ findTrackSeeds()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ resolveOverlaps()

◆ setLevel()

◆ withinBounds()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_cfg

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm