MdtToyTwinCablingDumpAlg Class Reference

: Simple algorithm to generate a toy cabling map for the twin tubes More...

#include <MdtToyTwinCablingDumpAlg.h>

Inheritance diagram for MdtToyTwinCablingDumpAlg:

Collaboration diagram for MdtToyTwinCablingDumpAlg:

Public Member Functions
	MdtToyTwinCablingDumpAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~MdtToyTwinCablingDumpAlg ()=default
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual unsigned int	cardinality () const override final
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	equipREwithTwins (const Identifier &detElId) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
const MuonGMR4::MuonDetectorManager *	m_detMgr {nullptr}
Gaudi::Property< std::string >	m_cablingJSON {this, "outCablingJSON", "MdtTwinMapping.json", "Cabling JSON"}
Gaudi::Property< std::vector< std::string > >	m_stationsToTwin {this, "stationsToTwin", {}, "List of station names that should have twinned tubes"}
Gaudi::Property< std::vector< std::string > >	m_detElIdToTwin {this, "detElIdToTwin", {"BOL4A13M1", "BOL4C13M1" }}
Gaudi::Property< int >	m_spacing {this, "IndentSpace", -1, "How many spaces shall be used for indentation"}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

: Simple algorithm to generate a toy cabling map for the twin tubes

Definition at line 22 of file MdtToyTwinCablingDumpAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

MdtToyTwinCablingDumpAlg()

MdtToyTwinCablingDumpAlg::MdtToyTwinCablingDumpAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 13 of file MdtToyTwinCablingDumpAlg.cxx.

                                                                                                 :
    AthAlgorithm{name, pSvcLocator} {}

~MdtToyTwinCablingDumpAlg()

virtual MdtToyTwinCablingDumpAlg::~MdtToyTwinCablingDumpAlg ( )

virtualdefault

Member Function Documentation

cardinality()

virtual unsigned int MdtToyTwinCablingDumpAlg::cardinality ( ) const

inlinefinaloverridevirtual

Definition at line 28 of file MdtToyTwinCablingDumpAlg.h.

{return 1;}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

equipREwithTwins()

bool MdtToyTwinCablingDumpAlg::equipREwithTwins ( const Identifier & detElId ) const

private

Definition at line 25 of file MdtToyTwinCablingDumpAlg.cxx.

                                                                               {
    if(std::ranges::find(m_stationsToTwin, m_idHelperSvc->stationNameString(detElId))!= m_stationsToTwin.end()) {
        return true;
    }
    const MdtIdHelper& idHelper{m_idHelperSvc->mdtIdHelper()};
    std::string mlName{std::format("{:}{:d}{:}{:02}M{:d}", 
                                   m_idHelperSvc->stationNameString(detElId),
                                   std::abs(m_idHelperSvc->stationEta(detElId)),
                                   (m_idHelperSvc->stationEta(detElId) > 0 ? 'A' : 'C'),
                                   m_idHelperSvc->sector(detElId),
                                   idHelper.multilayer(detElId))};
    
    ATH_MSG_DEBUG("Test "<<mlName<<", "<<m_detElIdToTwin);
    if(std::ranges::find(m_detElIdToTwin, mlName)!= m_detElIdToTwin.end()) {
        return true;
    }
 
    return m_detElIdToTwin.value().empty() && m_stationsToTwin.value().empty();
}

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode MdtToyTwinCablingDumpAlg::execute ( )

overridevirtual

Definition at line 44 of file MdtToyTwinCablingDumpAlg.cxx.

                                             {
  using Mapping = Muon::HedgehogBoard::Mapping;
  using HedgeHogBoardPtr = Muon::HedgehogBoard::HedgehogBoardPtr;
  auto createMap = [this](const uint8_t tubeLayers, const uint16_t id) {
      Mapping dummyMap{make_array<uint8_t, 24>(-1)};
      const Muon::HedgehogBoard dummyBoard{dummyMap, tubeLayers, id};
      for (uint8_t layer = 1 ; layer<= dummyBoard.numTubeLayers(); ++layer) {
          for (uint8_t tube = 1; tube<= dummyBoard.numTubesPerLayer(); ++ tube) {
            const uint8_t thisPin = dummyBoard.pinNumber(layer, tube);
            const uint8_t otherTube = dummyBoard.numTubeLayers() == 3 || tube != 2 ? tube +2 : 5;       
            const uint8_t otherPin = dummyBoard.pinNumber(layer, otherTube);
            ATH_MSG_DEBUG("Layer "<<static_cast<int>(layer)<<", "<<static_cast<int>(tube)<<" -> pin: "
                          <<static_cast<int>(thisPin)<<" <=> tube: "<<static_cast<int>(tube + 2)<<", pin: "
                          <<static_cast<int>(otherPin));
            if (dummyMap[thisPin] < dummyMap.size()) {
              continue;
            }            
            dummyMap[otherPin] = thisPin;
            dummyMap[thisPin] = otherPin;
          }
      }
      auto board = std ::make_unique<Muon::HedgehogBoard>(dummyMap, tubeLayers, id);
      ATH_MSG_INFO("Created new hedgehog board "<<std::endl<<(*board));
      return board;
  };
  HedgeHogBoardPtr threeLayBoard{createMap(3,1)}, fourLayBoard{createMap(4,2)};
 
  std::vector<const MuonGMR4::MdtReadoutElement*> reEles{m_detMgr->getAllMdtReadoutElements()};
 
  nlohmann::json payload{};
  Muon::TwinTubeMap twinTubes{m_idHelperSvc.get()};
  for(const MuonGMR4::MdtReadoutElement* reEl : reEles){
    const Identifier id = reEl->identify();
    if (!equipREwithTwins(id)) {
      continue;
    }
    const HedgeHogBoardPtr& pickMe{reEl->numLayers() == 3 ? threeLayBoard : fourLayBoard};
    uint16_t boardCounter{0};
    std::vector<uint16_t> connectedBoards{};
    for (unsigned iTube{1}; iTube<= reEl->numTubesInLay()  + (reEl->numTubesInLay() % pickMe->numTubesPerLayer()); 
                  iTube+=pickMe->numTubesPerLayer()) {
        ATH_CHECK(twinTubes.addHedgeHogBoard(id, pickMe, boardCounter++));
        connectedBoards.push_back(pickMe->boardId());
    }
    nlohmann::json twinPair{};
    twinPair["station"] =   m_idHelperSvc->stationNameString(id);
    twinPair["eta"] = m_idHelperSvc->stationEta(id);
    twinPair["phi"] = m_idHelperSvc->stationPhi(id);
    twinPair["ml"] = m_idHelperSvc->mdtIdHelper().multilayer(id);
    twinPair["mountedBoards"] = connectedBoards;
    payload["TwinTubeMapping"].push_back(std::move(twinPair));
  }
 
  auto dumpHedgeHog = [&payload, this](const HedgeHogBoardPtr& board) {
      if (board.use_count() < 2) {
        ATH_MSG_INFO("The board "<<std::endl<<(*board)<<" has not been used "<<board.use_count());
        return;
      }
      nlohmann::json hedge{};
      hedge["boardId"] = board->boardId();
      hedge["nTubeLayers"] = board->numTubeLayers();
      hedge["hedgeHogPins"] = board->data();
      if (board->hasHVDelayTime()) {
        hedge["hvDelayTime"] = board->hvDelayTime();
      }
      payload["HedgehogBoards"].push_back(std::move(hedge));
  };
  dumpHedgeHog(threeLayBoard);
  dumpHedgeHog(fourLayBoard);
 
  std::ofstream outStream{m_cablingJSON};
  if(!outStream.good()){
    ATH_MSG_FATAL("Failed to create JSON " << m_cablingJSON);
    return StatusCode::FAILURE;
  }
 
  outStream<<payload.dump(m_spacing)<<std::endl;
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

initialize()

StatusCode MdtToyTwinCablingDumpAlg::initialize ( )

overridevirtual

Definition at line 16 of file MdtToyTwinCablingDumpAlg.cxx.

                                                {
    ATH_CHECK(m_idHelperSvc.retrieve());
    ATH_CHECK(detStore()->retrieve(m_detMgr));
    if (!m_idHelperSvc->hasMDT()) {
        ATH_MSG_FATAL("You can't write mdt twin cablings without mdt detectors? ");
        return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_cablingJSON

Gaudi::Property<std::string> MdtToyTwinCablingDumpAlg::m_cablingJSON {this, "outCablingJSON", "MdtTwinMapping.json", "Cabling JSON"}

private

Definition at line 37 of file MdtToyTwinCablingDumpAlg.h.

{this, "outCablingJSON", "MdtTwinMapping.json", "Cabling JSON"};

m_detElIdToTwin

Gaudi::Property<std::vector<std::string> > MdtToyTwinCablingDumpAlg::m_detElIdToTwin {this, "detElIdToTwin", {"BOL4A13M1", "BOL4C13M1" }}

private

Definition at line 40 of file MdtToyTwinCablingDumpAlg.h.

{this, "detElIdToTwin", {"BOL4A13M1", "BOL4C13M1" }};

m_detMgr

const MuonGMR4::MuonDetectorManager* MdtToyTwinCablingDumpAlg::m_detMgr {nullptr}

private

Definition at line 35 of file MdtToyTwinCablingDumpAlg.h.

{nullptr};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_idHelperSvc

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

private

Definition at line 33 of file MdtToyTwinCablingDumpAlg.h.

{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

m_spacing

Gaudi::Property<int> MdtToyTwinCablingDumpAlg::m_spacing {this, "IndentSpace", -1, "How many spaces shall be used for indentation"}

private

Definition at line 41 of file MdtToyTwinCablingDumpAlg.h.

{this, "IndentSpace", -1, "How many spaces shall be used for indentation"};    

m_stationsToTwin

Gaudi::Property<std::vector<std::string> > MdtToyTwinCablingDumpAlg::m_stationsToTwin {this, "stationsToTwin", {}, "List of station names that should have twinned tubes"}

private

Definition at line 38 of file MdtToyTwinCablingDumpAlg.h.

{this, "stationsToTwin", {}, "List of station names that should have twinned tubes"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• MdtToyTwinCablingDumpAlg.h
• MdtToyTwinCablingDumpAlg.cxx