MuonGMR4::SpectrometerSector Class Reference

A spectrometer sector forms the envelope of all chambers that are placed in the same MS sector & layer E.g. More...

#include <SpectrometerSector.h>

Inheritance diagram for MuonGMR4::SpectrometerSector:

Collaboration diagram for MuonGMR4::SpectrometerSector:

Classes
struct	chamberLocation
	: Helper struct for fast approximate navigation. More...
struct	defineArgs

Public Types
using	ChamberPtr = GeoModel::TransientConstSharedPtr<Chamber>
using	ChamberSet = std::vector<ChamberPtr>

Public Member Functions
	SpectrometerSector (defineArgs &&args)
	Standard constructor taking the defining parameters.
	SpectrometerSector (const SpectrometerSector &other)=delete
	Delete the copy constructor and copy assignment.
SpectrometerSector &	operator= (const SpectrometerSector &other)=delete
	~SpectrometerSector ()=default
bool	operator< (const SpectrometerSector &other) const
std::string	identString () const
	Returns a string encoding the chamber index & the sector of the MS sector.
const Muon::IMuonIdHelperSvc *	idHelperSvc () const
	Returns the IdHelpeSvc.
Muon::MuonStationIndex::ChIndex	chamberIndex () const
	Returns the chamber index scheme.
int	stationPhi () const
	: Returns the station phi of the sector
int	sector () const
	Returns the sector of the MS-sector.
int8_t	side () const
	Returns the side of the MS-sector 1 -> A side ; -1 -> C side.
bool	barrel () const
	Returns whether the sector is placed in the barrel.
const Amg::Transform3D &	localToGlobalTransform (const ActsTrk::GeometryContext &gctx) const
	Returns the local -> global tarnsformation from the sector.
Amg::Transform3D	globalToLocalTransform (const ActsTrk::GeometryContext &gctx) const
	Returns the global -> local transformation from the ATLAS global.
const Acts::PlaneSurface &	surface () const
	Returns the associated surface.
const ChamberSet &	chambers () const
	Returns the associated chambers with this sector.
double	halfXLong () const
	Long-extend of the chamber in the x-direction at positive Y.
double	halfXShort () const
	Short extend of the chamber in the x-direction at negative Y.
double	halfY () const
	Extend of the chamber in the y-direction.
double	halfZ () const
	Thickness of the chamber in the z-direction.
const defineArgs &	parameters () const
	Returns the reference to the defining parameters of the sector.
std::shared_ptr< Acts::Volume >	boundingVolume (const ActsTrk::GeometryContext &gctx) const
	Returns the Acts::Volume representation of the sector.
std::shared_ptr< Acts::VolumeBounds >	bounds () const
	Returns the volume bounds.
Chamber::ReadoutSet	readoutEles () const
	Returns the list of all associated readout elements.
const std::vector< chamberLocation > &	chamberLocations () const
	returns the list of all MDT chambers in the sector for fast navigation
const std::vector< unsigned int > &	logicalLayerIdx (const MuonReadoutElement *reEle) const
	Returns the logic layer numbering of a given Readout Element.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Private Member Functions
std::unordered_map< const MuonReadoutElement *, std::vector< unsigned int > >	fillDetLayIdCache () const
	Function filling the map mapping the readout elements to layer numbers.
Identifier	computeDetLayerId (const MuonReadoutElement *rele) const
	Helper function calculating the logic layer Id and the physical layer id.
unsigned int	nLayerPerReadout (const MuonReadoutElement *rele) const
	Helper function giving the number of measurement layers in a given readout ele.
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
defineArgs	m_args {}
const std::unordered_map< const MuonReadoutElement *, std::vector< unsigned int > >	m_detLayIdCache {fillDetLayIdCache()}
	Map mapping each Readout Element to the layer numbering in the sector frame.
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

A spectrometer sector forms the envelope of all chambers that are placed in the same MS sector & layer E.g.

sector 5 in BI on the A-side. The spectrometer sector defines a coordinate system which is primarly used in the pattern recognition stage of the muon reconstruction

    x-axis: Points along the Mdt tubes & is hence sensitive to the phi direction
    y-axis: Points to the next Mdt tube in the layer or in other words to the big wheel
            in the sector, if the chamber is in the barrel or outside in radial direction
    z-axis: Points radially outwards if the chamber is in the barrel or in towards the cavern
            wall if it's an endcap chamber

The origin of the spectrometer sector is placed in the nominal centre of the envelope.

The spectrometer contains pointer to all chambers & readout elements that are enclosed by it.

Definition at line 40 of file SpectrometerSector.h.

Member Typedef Documentation

ChamberPtr

using MuonGMR4::SpectrometerSector::ChamberPtr = GeoModel::TransientConstSharedPtr<Chamber>

Definition at line 42 of file SpectrometerSector.h.

ChamberSet

using MuonGMR4::SpectrometerSector::ChamberSet = std::vector<ChamberPtr>

Definition at line 43 of file SpectrometerSector.h.

Constructor & Destructor Documentation

SpectrometerSector() [1/2]

MuonGMR4::SpectrometerSector::SpectrometerSector

(

defineArgs &&

args

)

Standard constructor taking the defining parameters.

Definition at line 37 of file SpectrometerSector.cxx.

                                                       : 
    AthMessaging("MuonSpectrometerSector"), m_args{std::move(args)} {
        for (auto & chamber : m_args.chambers) {
            chamber->setParent(this);
        }
    }

SpectrometerSector() [2/2]

MuonGMR4::SpectrometerSector::SpectrometerSector ( const SpectrometerSector & other )

delete

Delete the copy constructor and copy assignment.

~SpectrometerSector()

MuonGMR4::SpectrometerSector::~SpectrometerSector ( )

default

Member Function Documentation

barrel()

bool MuonGMR4::SpectrometerSector::barrel

(

)

const

Returns whether the sector is placed in the barrel.

Definition at line 55 of file SpectrometerSector.cxx.

{ return m_args.chambers.front()->barrel(); }

boundingVolume()

std::shared_ptr< Acts::Volume > MuonGMR4::SpectrometerSector::boundingVolume

(

const ActsTrk::GeometryContext &

gctx

)

const

Returns the Acts::Volume representation of the sector.

Parameters

gctx	Geometry context carrrying the alignment transformations

Definition at line 77 of file SpectrometerSector.cxx.

                                                                                                     {
    return std::make_shared<Acts::Volume>(localToGlobalTransform(gctx), bounds());
}

bounds()

std::shared_ptr< Acts::VolumeBounds > MuonGMR4::SpectrometerSector::bounds

(

)

const

Returns the volume bounds.

Definition at line 80 of file SpectrometerSector.cxx.

{ return m_args.bounds; }

chamberIndex()

Muon::MuonStationIndex::ChIndex MuonGMR4::SpectrometerSector::chamberIndex

(

)

const

Returns the chamber index scheme.

Definition at line 52 of file SpectrometerSector.cxx.

{ return m_args.chambers.front()->chamberIndex(); }

chamberLocations()

const std::vector< SpectrometerSector::chamberLocation > & MuonGMR4::SpectrometerSector::chamberLocations

(

)

const

returns the list of all MDT chambers in the sector for fast navigation

Definition at line 88 of file SpectrometerSector.cxx.

                                                                                               {
    return m_args.detectorLocs;
 
}

chambers()

const ChamberSet & MuonGMR4::SpectrometerSector::chambers

(

)

const

Returns the associated chambers with this sector.

Definition at line 61 of file SpectrometerSector.cxx.

{ return m_args.chambers; }

computeDetLayerId()

Identifier MuonGMR4::SpectrometerSector::computeDetLayerId ( const MuonReadoutElement * rele ) const

private

Helper function calculating the logic layer Id and the physical layer id.

Definition at line 186 of file SpectrometerSector.cxx.

                                                                                    {
 
    switch (rele->detectorType()) {
        case ActsTrk::DetectorType::Mdt:{
            auto mdtRele = dynamic_cast<const MdtReadoutElement*>(rele);
            return idHelperSvc()->mdtIdHelper().channelID(mdtRele->stationName(), 1,
                                                           mdtRele->stationPhi(),
                                                           mdtRele->multilayer(),
                                                            1,1);
        }
        case ActsTrk::DetectorType::Rpc:{
            auto rpcRele = dynamic_cast<const RpcReadoutElement*>(rele);
            return idHelperSvc()->rpcIdHelper().channelID(rpcRele->stationName(), 1, 
                                                           rpcRele->stationPhi(),
                                                             rpcRele->doubletR(), 1, 1, 
                                                               1, 0, 1);
        }
        case ActsTrk::DetectorType::Tgc:{
            auto tgcRele = dynamic_cast<const TgcReadoutElement*>(rele);
            return idHelperSvc()->tgcIdHelper().channelID(tgcRele->stationName(), 1,
                                                           tgcRele->stationPhi(), 
                                                               1, 0, 1);
        }
        case ActsTrk::DetectorType::sTgc:{
           auto stgcRele = dynamic_cast<const sTgcReadoutElement*>(rele);
           return idHelperSvc()->stgcIdHelper().channelID(stgcRele->stationName(), 1,
                                                           stgcRele->stationPhi(), 
                                                           stgcRele->multilayer(),
                                                               1, 0, 1);
        }
        case ActsTrk::DetectorType::Mm:{
            auto mmRele = dynamic_cast<const MmReadoutElement*>(rele);
            return idHelperSvc()->mmIdHelper().channelID(mmRele->stationName(), 1,
                                                          mmRele->stationPhi(), 
                                                          mmRele->multilayer(),
                                                              1, 1);
        }
        default:
            THROW_EXCEPTION("Unexpected Readout Element Type in computeDetLayerId()");
    }
}

fillDetLayIdCache()

std::unordered_map< const MuonReadoutElement *, std::vector< unsigned int > > MuonGMR4::SpectrometerSector::fillDetLayIdCache ( ) const

private

Function filling the map mapping the readout elements to layer numbers.

Definition at line 114 of file SpectrometerSector.cxx.

                                           {
 
    std::unordered_map<const MuonReadoutElement*, std::vector<unsigned int>> cache{};
    const ActsTrk::GeometryContext gctx{};
    const Amg::Transform3D sectorTrans = globalToLocalTransform(gctx);
 
    // sort the Readout elements by z in the sector fram
    Chamber::ReadoutSet reEleSorted {readoutEles()};
    std::ranges::sort(reEleSorted, [&sectorTrans, &gctx](const MuonReadoutElement* reEle1, const MuonReadoutElement* reEle2)-> bool {
        return  (sectorTrans * reEle1->center(gctx, reEle1->identify())).z() < (sectorTrans * reEle2->center(gctx, reEle2->identify())).z();
    });
    
    // this is a function to find the next logical layer, returning the corresponding reEle and Id
    auto nextLayer = [this, &cache, &reEleSorted](const Identifier& lastId) -> 
                    std::pair<const MuonReadoutElement*, const Identifier> {
 
        const MuonReadoutElement* nextReEle {nullptr};
        Identifier nextId {};
 
        for (const MuonReadoutElement* reEle : reEleSorted){
 
            // Check if this reEle has already been filled up
            if (cache.count(reEle)) continue;
 
            // compute the logical layer Id of the first layer of the reEle (first layer/gasgap, first channel, projecting to 
            // stationEta=1, doubletZ=1, doubletPhi=1, according to the technology)
            const Identifier logicalId {computeDetLayerId(reEle)};
 
            //if we find another measurement layer with the same detLayerId as the last we added (e.g. the same gasgap of two RPC z doublets)
            if (logicalId == lastId){
                return std::make_pair(reEle, logicalId);
            }
 
            // Save the next (subsequent) logic layer in z
            if (!nextReEle) {
                nextReEle = reEle;
                nextId = logicalId;
            }
 
        }
        return std::make_pair(nextReEle, nextId);
    };
 
    unsigned int layCounter {0}, nIter {0};
    Identifier lastId {};
    unsigned int deltaN {0};
    while(++nIter <= reEleSorted.size()){
 
        auto [nextReEle, nextId] = nextLayer(lastId);
        if (!nextReEle){
            THROW_EXCEPTION("Failed to retrieve next reEle in fillDetLayIdCache()");
        }
 
        unsigned int nLayers = nLayerPerReadout(nextReEle);
        
        if (nextId != lastId) {
            layCounter += deltaN;
            deltaN = nLayers;
            lastId = nextId;
        }
        else{
            deltaN = std::max(deltaN, nLayers);
        }
        
        cache[nextReEle] = range(layCounter, layCounter + nLayers);
 
        ATH_MSG_DEBUG( identString() << " ReEle: " << idHelperSvc()->toStringDetEl(nextReEle->identify()) << 
                     " Add logicLay: " << idHelperSvc()->toStringGasGap(nextId) << " nInserted, layCounter " << cache.at(nextReEle).size() << " ," << layCounter);
    }
    return cache;
};

globalToLocalTransform()

Amg::Transform3D MuonGMR4::SpectrometerSector::globalToLocalTransform

(

const ActsTrk::GeometryContext &

gctx

)

const

Returns the global -> local transformation from the ATLAS global.

Definition at line 68 of file SpectrometerSector.cxx.

                                                                                                  {
    return localToGlobalTransform(gctx).inverse(); 
}

halfXLong()

double MuonGMR4::SpectrometerSector::halfXLong

(

)

const

Long-extend of the chamber in the x-direction at positive Y.

Definition at line 71 of file SpectrometerSector.cxx.

{ return MuonGMR4::halfXhighY(*m_args.bounds); }

halfXShort()

double MuonGMR4::SpectrometerSector::halfXShort

(

)

const

Short extend of the chamber in the x-direction at negative Y.

Definition at line 72 of file SpectrometerSector.cxx.

{ return MuonGMR4::halfXlowY(*m_args.bounds);  }

halfY()

double MuonGMR4::SpectrometerSector::halfY

(

)

const

Extend of the chamber in the y-direction.

Definition at line 73 of file SpectrometerSector.cxx.

{ return MuonGMR4::halfY(* m_args.bounds); }

halfZ()

double MuonGMR4::SpectrometerSector::halfZ

(

)

const

Thickness of the chamber in the z-direction.

Definition at line 74 of file SpectrometerSector.cxx.

{ return MuonGMR4::halfZ(*m_args.bounds);}

identString()

std::string MuonGMR4::SpectrometerSector::identString

(

)

const

Returns a string encoding the chamber index & the sector of the MS sector.

Definition at line 56 of file SpectrometerSector.cxx.

                                                {
    return std::format("id: {:3d}, {:} {:}-side sector: {:2},",  m_args.id, 
                       Muon::MuonStationIndex::chName(chamberIndex()), 
                       side() == 1 ? 'A' : 'C' , sector());
}

idHelperSvc()

const Muon::IMuonIdHelperSvc * MuonGMR4::SpectrometerSector::idHelperSvc

(

)

const

Returns the IdHelpeSvc.

Definition at line 51 of file SpectrometerSector.cxx.

{ return m_args.chambers.front()->idHelperSvc();}

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();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

localToGlobalTransform()

const Amg::Transform3D & MuonGMR4::SpectrometerSector::localToGlobalTransform

(

const ActsTrk::GeometryContext &

gctx

)

const

Returns the local -> global tarnsformation from the sector.

Parameters

gctx	Geometry context carrrying the alignment transformations

Definition at line 65 of file SpectrometerSector.cxx.

                                                                                                         {
    return surface().localToGlobalTransform(gctx.context());
}            

logicalLayerIdx()

const std::vector< unsigned int > & MuonGMR4::SpectrometerSector::logicalLayerIdx

(

const MuonReadoutElement *

reEle

)

const

Returns the logic layer numbering of a given Readout Element.

Definition at line 109 of file SpectrometerSector.cxx.

                                                                                                       {
    return m_detLayIdCache.at(reEle);
};

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 167 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 182 of file AthMessaging.h.

{ 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 user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

nLayerPerReadout()

unsigned int MuonGMR4::SpectrometerSector::nLayerPerReadout ( const MuonReadoutElement * rele ) const

private

Helper function giving the number of measurement layers in a given readout ele.

Definition at line 228 of file SpectrometerSector.cxx.

                                                                                       {
 
    switch (rele->detectorType()) {
        case ActsTrk::DetectorType::Mdt:{
            auto mdtRele = dynamic_cast<const MdtReadoutElement*>(rele);
            return mdtRele->numLayers();
        }
        case ActsTrk::DetectorType::Rpc:{
            auto rpcRele = dynamic_cast<const RpcReadoutElement*>(rele);
            return rpcRele->nGasGaps();
        }
        case ActsTrk::DetectorType::Tgc:{
            auto tgcRele = dynamic_cast<const TgcReadoutElement*>(rele);
            return tgcRele->nGasGaps();
        }
        case ActsTrk::DetectorType::sTgc:{
           auto stgcRele = dynamic_cast<const sTgcReadoutElement*>(rele);
            return stgcRele->numLayers();
        }
        case ActsTrk::DetectorType::Mm:{
            auto mmRele = dynamic_cast<const MmReadoutElement*>(rele);
            return mmRele->nGasGaps();
        }
        default:
            THROW_EXCEPTION("Unexpected Readout Element Type in nLayerPerReadout()");
    }
}

operator<()

bool MuonGMR4::SpectrometerSector::operator<

(

const SpectrometerSector &

other

)

const

Definition at line 44 of file SpectrometerSector.cxx.

                                                                        {
    return m_args.id < other.m_args.id; 
}

operator=()

SpectrometerSector & MuonGMR4::SpectrometerSector::operator= ( const SpectrometerSector & other )

delete

parameters()

const SpectrometerSector::defineArgs & MuonGMR4::SpectrometerSector::parameters

(

)

const

Returns the reference to the defining parameters of the sector.

Definition at line 50 of file SpectrometerSector.cxx.

{ return m_args; }

readoutEles()

Chamber::ReadoutSet MuonGMR4::SpectrometerSector::readoutEles

(

)

const

Returns the list of all associated readout elements.

Definition at line 81 of file SpectrometerSector.cxx.

                                                        {
    Chamber::ReadoutSet toReturn{};
    for (const ChamberPtr& ch : chambers()) {
        toReturn.insert(toReturn.end(), ch->readoutEles().begin(), ch->readoutEles().end());
    }
    return toReturn;
}

sector()

int MuonGMR4::SpectrometerSector::sector

(

)

const

Returns the sector of the MS-sector.

Definition at line 54 of file SpectrometerSector.cxx.

{return m_args.chambers.front()->sector(); }

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

side()

int8_t MuonGMR4::SpectrometerSector::side

(

)

const

Returns the side of the MS-sector 1 -> A side ; -1 -> C side.

Definition at line 47 of file SpectrometerSector.cxx.

                                      {
    return Acts::copySign(1, chambers().front()->stationEta());
}

stationPhi()

int MuonGMR4::SpectrometerSector::stationPhi

(

)

const

: Returns the station phi of the sector

Definition at line 53 of file SpectrometerSector.cxx.

{ return m_args.chambers.front()->stationPhi(); }

surface()

const Acts::PlaneSurface & MuonGMR4::SpectrometerSector::surface

(

)

const

Returns the associated surface.

Definition at line 62 of file SpectrometerSector.cxx.

                                                          {
    return *m_args.surface;
}

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_args

defineArgs MuonGMR4::SpectrometerSector::m_args {}

private

Definition at line 173 of file SpectrometerSector.h.

{};

m_detLayIdCache

const std::unordered_map<const MuonReadoutElement*, std::vector<unsigned int> > MuonGMR4::SpectrometerSector::m_detLayIdCache {fillDetLayIdCache()}

private

Map mapping each Readout Element to the layer numbering in the sector frame.

Definition at line 178 of file SpectrometerSector.h.

{fillDetLayIdCache()};

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

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:

• SpectrometerSector.h
• SpectrometerSector.cxx