#include <TwinTubeMap.h>

Inheritance diagram for Muon::TwinTubeMap:

Collaboration diagram for Muon::TwinTubeMap:

Classes
struct	HedgehogTray

Public Types
using	HedgehogBoardPtr = HedgehogBoard::HedgehogBoardPtr

Public Member Functions
	TwinTubeMap (const IMuonIdHelperSvc *idHelperSvc)
bool	isTwinTubeLayer (const Identifier &channelId) const
	Returns whether the multilayer is equipped with twin-tubes or not.
Identifier	twinId (const Identifier &channelId) const
	Returns the Identifier of the mapped twin tube.
double	hvDelayTime (const Identifier &channelId) const
	Returns the HV time delay for a given twin tube pair.
void	setDefaultHVDelay (const double hvDelay)
	Sets the default HV delay.
StatusCode	addHedgeHogBoard (const Identifier &detElId, const HedgehogBoardPtr &board, const uint16_t slot)
	Add a new hedgehog board with twin tube mapping.
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 Types
using	Storage = std::unordered_map<IdentifierHash, HedgehogTray>

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
const IMuonIdHelperSvc *	m_idHelperSvc {nullptr}
Storage	m_twinTubesPerRE {}
double	m_defaultHVDelay {0.}
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

Parameters

The	ATLAS R3 MuonSpectrometer has 2 layers with twin tube readout. In Phase II, other multilayers may be upgraded to be twin-tube layers as well. The TwinTubeMap returns for a given Mdt Identifier the associated twin-tube Identifier, if there's any at all.

Definition at line 16 of file TwinTubeMap.h.

Member Typedef Documentation

◆ HedgehogBoardPtr

using Muon::TwinTubeMap::HedgehogBoardPtr = HedgehogBoard::HedgehogBoardPtr

Definition at line 18 of file TwinTubeMap.h.

◆ Storage

using Muon::TwinTubeMap::Storage = std::unordered_map<IdentifierHash, HedgehogTray>

private

Definition at line 45 of file TwinTubeMap.h.

Constructor & Destructor Documentation

◆ TwinTubeMap()

Muon::TwinTubeMap::TwinTubeMap ( const IMuonIdHelperSvc * idHelperSvc )

Definition at line 8 of file TwinTubeMap.cxx.

                                                               :
        AthMessaging{"TwinTubeMap"},
        m_idHelperSvc{idHelperSvc} {
    }

Member Function Documentation

◆ addHedgeHogBoard()

StatusCode Muon::TwinTubeMap::addHedgeHogBoard	(	const Identifier &	detElId,
		const HedgehogBoardPtr &	board,
		const uint16_t	slot )

Add a new hedgehog board with twin tube mapping.

Parameters

detElId	Identifier of the multilayer
board	Pointer to the HedgehogBoard instance encoding the mapping
slot	Integer indicating which tube range is covered by the board

Check for compability

Check the board for consistency

Definition at line 44 of file TwinTubeMap.cxx.

                                                                                                                          {
        ATH_MSG_DEBUG("Add new hedgehog board for "<<m_idHelperSvc->toStringDetEl(detElId)<<" "<<(*board)
                     <<", slot: "<<static_cast<int>(slot));
        const IdentifierHash detHash{m_idHelperSvc->detElementHash(detElId)};
        HedgehogTray& tray{m_twinTubesPerRE[detHash]};
        if (!tray.nTubesPerLay) {
            const int nTubLayers = m_idHelperSvc->mdtIdHelper().tubeLayerMax(detElId);
            tray.nTubesPerLay = board->numTubesPerLayer();
            if (nTubLayers != board->numTubeLayers()) {
                ATH_MSG_FATAL("The new hedgehog board "<<(*board)<<" does not match in terms of tube layers"
                            <<nTubLayers<<" "<<m_idHelperSvc->toStringDetEl(detElId));
                return StatusCode::FAILURE;
            }
        } else if (tray.nTubesPerLay != board->numTubesPerLayer()){
            ATH_MSG_FATAL("Cannot at new hedgeog board in "<<m_idHelperSvc->toStringDetEl(detElId)
                <<"Number of tubes per layer does not match. "<<static_cast<int>(tray.nTubesPerLay)<<" vs. "
                <<static_cast<int>(board->numTubesPerLayer()));
            return StatusCode::FAILURE;
        }
        
        if (board.use_count() < 3) {
            for (uint8_t lay = 1 ; lay<= board->numTubeLayers(); ++lay) {
                for (uint8_t tube = 1; tube<=board->numTubesPerLayer(); ++tube) {
                    TubeLayer in{};
                    in.layer = lay;
                    in.tube = tube;
                    const TubeLayer out = board->twinPair(in);
                    const TubeLayer twinTwin = board->twinPair(out);
                    if (twinTwin != in) {
                        ATH_MSG_FATAL("Back & forth mapping of "<<std::endl<<(*board)<<std::endl
                                   <<" failed. Started with "<<in<<" via "<<out<<" & ended in "<<twinTwin);
                        return StatusCode::FAILURE;
                    }
                }
            }
        }
        if (tray.cards.size() <= slot) {
            tray.cards.resize(slot +1);
        }
        tray.cards[slot] = board;
        return StatusCode::SUCCESS;
    }

◆ hvDelayTime()

double Muon::TwinTubeMap::hvDelayTime ( const Identifier & channelId ) const

Returns the HV time delay for a given twin tube pair.

If there's no dedicated delay safed for the pair, the default value is returned

Definition at line 88 of file TwinTubeMap.cxx.

                                                                     {
        ATH_MSG_VERBOSE("Fetch the hv delay time for "<<m_idHelperSvc->toString(channelId));
        const IdentifierHash detHash{m_idHelperSvc->detElementHash(channelId)};
        Storage::const_iterator twinItr = m_twinTubesPerRE.find(detHash);
        if (twinItr != m_twinTubesPerRE.end()) {
         const HedgehogTray& tray{twinItr->second};
            const MdtIdHelper& idHelper{m_idHelperSvc->mdtIdHelper()};
            const uint8_t tube = idHelper.tube(channelId);
            const uint8_t boardNum =  (tube - tube % tray.nTubesPerLay) / tray.nTubesPerLay;
            if (boardNum < tray.cards.size() && tray.cards[boardNum] && tray.cards[boardNum]->hasHVDelayTime()) {
                ATH_MSG_VERBOSE("Specific delay time set to "<<tray.cards[boardNum]->hvDelayTime());
                return tray.cards[boardNum]->hvDelayTime();
            }
        }
        return m_defaultHVDelay;
    }        

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

◆ isTwinTubeLayer()

bool Muon::TwinTubeMap::isTwinTubeLayer ( const Identifier & channelId ) const

Returns whether the multilayer is equipped with twin-tubes or not.

Parameters

channelId Identifier of a tube in the multilayer

Definition at line 12 of file TwinTubeMap.cxx.

                                                                       {
        ATH_MSG_VERBOSE("Check whether "<<m_idHelperSvc->toStringDetEl(channelId)<<" is a twin tube layer");
        const IdentifierHash detHash{m_idHelperSvc->detElementHash(channelId)};
        Storage::const_iterator itr = m_twinTubesPerRE.find(detHash);
        return itr != m_twinTubesPerRE.end();
    }

◆ 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 163 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 178 of file AthMessaging.h.

179{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:163

◆ 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_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ setDefaultHVDelay()

void Muon::TwinTubeMap::setDefaultHVDelay ( const double hvDelay )

Sets the default HV delay.

Definition at line 104 of file TwinTubeMap.cxx.

                                                            {
        ATH_MSG_DEBUG("Set the default HV delay to "<<hvDelay<<" ns.");
        m_defaultHVDelay = hvDelay;
    }

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

◆ twinId()

Identifier Muon::TwinTubeMap::twinId ( const Identifier & channelId ) const

Returns the Identifier of the mapped twin tube.

If the Identifier has no twin, then the Identifier is returned.

Parameters

channelId Identifier of the tube of interest

Definition at line 19 of file TwinTubeMap.cxx.

                                                                    {
        ATH_MSG_VERBOSE("Fetch the twin tube id for "<<m_idHelperSvc->toString(channelId));
        const IdentifierHash detHash{m_idHelperSvc->detElementHash(channelId)};
        Storage::const_iterator twinItr = m_twinTubesPerRE.find(detHash);
        if (twinItr != m_twinTubesPerRE.end()) {
            const HedgehogTray& tray{twinItr->second};
            const MdtIdHelper& idHelper{m_idHelperSvc->mdtIdHelper()};
            TubeLayer in{};
            in.tube = idHelper.tube(channelId);
            in.layer = idHelper.tubeLayer(channelId);
            
            const uint8_t boardNum =  ( (in.tube-1) - (in.tube-1) % tray.nTubesPerLay) / tray.nTubesPerLay;
            if (boardNum >= tray.cards.size() || !tray.cards[boardNum]) {
                return channelId;
            }
            const TubeLayer out = tray.cards[boardNum]->twinPair(in);
            if (in != out) {                
                const Identifier twinId = idHelper.channelID(channelId,idHelper.multilayer(channelId),
                                                             out.layer, out.tube + tray.nTubesPerLay*boardNum);
                ATH_MSG_VERBOSE("The matching twin tube is "<<m_idHelperSvc->toString(twinId));
                return twinId; 
            }
        }
        return channelId;
    }

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_defaultHVDelay

double Muon::TwinTubeMap::m_defaultHVDelay {0.}

private

Definition at line 48 of file TwinTubeMap.h.

48{0.};

◆ m_idHelperSvc

const IMuonIdHelperSvc* Muon::TwinTubeMap::m_idHelperSvc {nullptr}

private

Definition at line 39 of file TwinTubeMap.h.

39{nullptr};

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ 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.

◆ m_twinTubesPerRE

Storage Muon::TwinTubeMap::m_twinTubesPerRE {}

private

Definition at line 46 of file TwinTubeMap.h.

46{};

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

◆ HedgehogBoardPtr

◆ Storage

Constructor & Destructor Documentation

◆ TwinTubeMap()

Member Function Documentation

◆ addHedgeHogBoard()

◆ hvDelayTime()

◆ initMessaging()

◆ isTwinTubeLayer()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ setDefaultHVDelay()

◆ setLevel()

◆ twinId()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_defaultHVDelay

◆ m_idHelperSvc

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_twinTubesPerRE