NswDcsDbData Class Reference

#include <NswDcsDbData.h>

Collaboration diagram for NswDcsDbData:

Classes
struct	DcsModule
struct	TDaqConstants

Public Types
enum class	DcsTechType { MMG , MMD , STG }
using	DcsDataType = MuonCond::DcsDataType
using	DcsFsmState = MuonCond::DcsFsmState
using	DcsConstants = MuonCond::DcsConstants

Public Member Functions
	NswDcsDbData (const Muon::IMuonIdHelperSvc *idHelperSvc, const MuonGM::MuonDetectorManager *muonGeoMgr)
virtual	~NswDcsDbData ()=default
void	setDataHv (const DcsTechType tech, const Identifier &chnlId, DcsConstants constants)
void	setDataTDaq (const DcsTechType tech, const Identifier &chnlId, uint64_t timeSince, uint64_t timeUntil, unsigned int elink, bool permanentlyDisabled)
void	setDataEltx (const DcsTechType tech, const Identifier &chnlId)
std::vector< Identifier >	getChannelIdsHv (const DcsTechType tech, const std::string &side) const
const DcsConstants *	getDataForChannelHv (const DcsTechType tech, const Identifier &channelId, bool issTgcQ1OuterHv) const
	Retrieves the calibration constant for a particular readout channel.
bool	isGood (const EventContext &ctx, const Identifier &channelId, bool issTgcQ1OuterHv=false) const
	Returns whether the channel is alive, i.e. DCS state on, etc...
bool	isGoodHv (const Identifier &channelId, bool issTgcQ1OuterHv=false) const
bool	isGoodTDaq (const EventContext &ctx, const Identifier &channelId, bool &permanentlyDisabled) const
bool	isGoodEltx (const Identifier &channelId) const
bool	isConnectedChannel (const Identifier &channelId) const

Private Types
using	ChannelDcsMap = std::vector<DcsModule>
using	ChannelTDaqMap = std::vector<std::map<Identifier, std::set<TDaqConstants>>>
using	ChannelEltxMap = std::vector<std::set<Identifier>>

Private Member Functions
unsigned int	identToModuleIdx (const Identifier &chan_id) const

Private Attributes
ChannelDcsMap	m_data_hv_mmg {}
ChannelDcsMap	m_data_hv_mmd {}
ChannelDcsMap	m_data_hv_stg {}
ChannelTDaqMap	m_data_tdaq_mmg {}
ChannelTDaqMap	m_data_tdaq_stg {}
ChannelEltxMap	m_data_eltx_mmg {}
ChannelEltxMap	m_data_eltx_stg {}
const Muon::IMuonIdHelperSvc *	m_idHelperSvc {}
const MuonGM::MuonDetectorManager *	m_muonGeoMgr {nullptr}

Detailed Description

Definition at line 19 of file NswDcsDbData.h.

Member Typedef Documentation

ChannelDcsMap

using NswDcsDbData::ChannelDcsMap = std::vector<DcsModule>

private

Definition at line 74 of file NswDcsDbData.h.

ChannelEltxMap

using NswDcsDbData::ChannelEltxMap = std::vector<std::set<Identifier>>

private

Definition at line 81 of file NswDcsDbData.h.

ChannelTDaqMap

using NswDcsDbData::ChannelTDaqMap = std::vector<std::map<Identifier, std::set<TDaqConstants>>>

private

Definition at line 78 of file NswDcsDbData.h.

DcsConstants

using NswDcsDbData::DcsConstants = MuonCond::DcsConstants

Definition at line 29 of file NswDcsDbData.h.

DcsDataType

using NswDcsDbData::DcsDataType = MuonCond::DcsDataType

Definition at line 27 of file NswDcsDbData.h.

DcsFsmState

using NswDcsDbData::DcsFsmState = MuonCond::DcsFsmState

Definition at line 28 of file NswDcsDbData.h.

Member Enumeration Documentation

DcsTechType

enum class NswDcsDbData::DcsTechType

strong

Enumerator
MMG
MMD
STG

Definition at line 22 of file NswDcsDbData.h.

                          {
        MMG, // MM channels
        MMD, // MM drift channels
        STG  // sTGC
    };

Constructor & Destructor Documentation

NswDcsDbData()

NswDcsDbData::NswDcsDbData	(	const Muon::IMuonIdHelperSvc *	idHelperSvc,
		const MuonGM::MuonDetectorManager *	muonGeoMgr )

Definition at line 24 of file NswDcsDbData.cxx.

                                                                                                              :
    m_idHelperSvc(idHelperSvc),
    m_muonGeoMgr(muonGeoMgr){}

~NswDcsDbData()

virtual NswDcsDbData::~NswDcsDbData ( )

virtualdefault

Member Function Documentation

getChannelIdsHv()

std::vector< Identifier > NswDcsDbData::getChannelIdsHv	(	const DcsTechType	tech,
		const std::string &	side ) const

Definition at line 113 of file NswDcsDbData.cxx.

                                                                                 {
    std::vector<Identifier> chnls;
    if(tech == DcsTechType::MMG || tech == DcsTechType::MMD){
        const MmIdHelper& idHelper{m_idHelperSvc->mmIdHelper()};
        const ChannelDcsMap& dcsMap = tech == DcsTechType::MMG ? m_data_hv_mmg : m_data_hv_mmd;
        chnls.reserve(dcsMap.size());
        for(const DcsModule& module : dcsMap) {
            if(module.channels.empty()) continue;
            if(side == "A" && idHelper.stationEta(module.layer_id) < 0) continue;
            if(side == "C" && idHelper.stationEta(module.layer_id) > 0) continue;
            for(unsigned int chn = 1 ; chn <= module.channels.size() ; ++chn) {
                if(!module.channels[chn -1]) continue;
                chnls.push_back(idHelper.channelID(module.layer_id, idHelper.multilayer(module.layer_id), idHelper.gasGap(module.layer_id), chn ));
            }
        }
    } else if(tech == DcsTechType::STG){
        const sTgcIdHelper& idHelper{m_idHelperSvc->stgcIdHelper()};
        const ChannelDcsMap& dcsMap = m_data_hv_stg;
        chnls.reserve(dcsMap.size());
        for(const DcsModule& module : dcsMap) {
            if(module.channels.empty()) continue;
            if(side == "A" && idHelper.stationEta(module.layer_id) < 0) continue;
            if(side == "C" && idHelper.stationEta(module.layer_id) > 0) continue;
            for(unsigned int chn = 1 ; chn <= module.channels.size() ; ++chn) {
                if(!module.channels[chn -1]) continue;
                chnls.push_back(idHelper.channelID(module.layer_id, idHelper.multilayer(module.layer_id), 
                                        idHelper.gasGap(module.layer_id),  idHelper.channelType(module.layer_id), chn ));
            }
        }
    }
    return chnls;
}

getDataForChannelHv()

const NswDcsDbData::DcsConstants * NswDcsDbData::getDataForChannelHv	(	const DcsTechType	tech,
		const Identifier &	channelId,
		bool	issTgcQ1OuterHv ) const

Retrieves the calibration constant for a particular readout channel.

Definition at line 147 of file NswDcsDbData.cxx.

                                                                                                                 {
    if(tech == DcsTechType::MMG){
        const MmIdHelper& idHelper{m_idHelperSvc->mmIdHelper()};
        if(!idHelper.is_mm(channelId)) return nullptr;
        Identifier dcsChannelIdStripHv = idHelper.pcbID(channelId);
        const ChannelDcsMap& dcsMap = m_data_hv_mmg; // later add something like: type == DcsDataType::HV ? m_data_hv : m_data_lv;
        const unsigned int array_idx = identToModuleIdx(dcsChannelIdStripHv);
        const unsigned int channel = idHelper.channel(dcsChannelIdStripHv) -1;
        if (dcsMap.size() > array_idx && dcsMap.at(array_idx).channels.size() > channel && dcsMap[array_idx].channels[channel]) return dcsMap[array_idx].channels[channel].get();
    } else if (tech == DcsTechType::MMD) {
        const MmIdHelper& idHelper{m_idHelperSvc->mmIdHelper()};
        if(!idHelper.is_mm(channelId)) return nullptr;
        Identifier dcsChannelIdDriftHv = idHelper.multilayerID(channelId);
        const ChannelDcsMap& dcsMap = m_data_hv_mmd;
        const unsigned int array_idx = identToModuleIdx(dcsChannelIdDriftHv);
        const unsigned int channel = idHelper.channel(dcsChannelIdDriftHv) -1;
        if (dcsMap.size() > array_idx && dcsMap.at(array_idx).channels.size() > channel && dcsMap[array_idx].channels[channel]) return dcsMap[array_idx].channels[channel].get();
    } else if(tech == DcsTechType::STG){
        const sTgcIdHelper& idHelper{m_idHelperSvc->stgcIdHelper()};
        if(!idHelper.is_stgc(channelId)) return nullptr;
 
        // the parameter issTgcQ1OuterHv is only relevant for the Q1s of the stgcs. So set it to false if we are not in Q1, just in case
        if(std::abs(idHelper.stationEta(channelId))!= 1) {issTgcQ1OuterHv=false;}
        Identifier dcsChannelId = idHelper.hvID(channelId, !issTgcQ1OuterHv /* the function takes isInnerQ1 therefore invert the isOuterQ1 variable*/);
        const ChannelDcsMap& dcsMap = m_data_hv_stg;
        const unsigned int array_idx = identToModuleIdx(dcsChannelId);
        const unsigned int channel = idHelper.channel(dcsChannelId) -1;
        if (dcsMap.size() > array_idx && dcsMap.at(array_idx).channels.size() > channel && dcsMap[array_idx].channels[channel]) return dcsMap[array_idx].channels[channel].get();
    }
    return nullptr;
}

identToModuleIdx()

unsigned int NswDcsDbData::identToModuleIdx ( const Identifier & chan_id ) const

private

Definition at line 33 of file NswDcsDbData.cxx.

                                                                          {
    const IdentifierHash hash = m_idHelperSvc->detElementHash(chan_id);
    if (m_idHelperSvc->isMM(chan_id)) {
        const MmIdHelper& idHelper{m_idHelperSvc->mmIdHelper()};
        return static_cast<unsigned int>(hash)*(idHelper.gasGapMax()) + (idHelper.gasGap(chan_id) -1);
    } else if (m_idHelperSvc->issTgc(chan_id)) {        
        const sTgcIdHelper& idHelper{m_idHelperSvc->stgcIdHelper()};
        return static_cast<unsigned int>(hash)*(idHelper.gasGapMax()) + (idHelper.gasGap(chan_id) -1);
    }
    THROW_EXCEPTION("NswDcsDbData() - No NSW identifier");
    return -1;
 }

isConnectedChannel()

bool NswDcsDbData::isConnectedChannel

(

const Identifier &

channelId

)

const

Definition at line 257 of file NswDcsDbData.cxx.

                                                                       {
    // for stgc we do not have unconnected channels
    if(m_idHelperSvc->issTgc(channelId)) return true;
 
    if(!m_idHelperSvc->isMM(channelId)) THROW_EXCEPTION("the check for unconnected channels was called with an identifier that is in MM and not sTGC");
    
    const MmIdHelper& idHelper{m_idHelperSvc->mmIdHelper()};
 
    const MuonGM::MMReadoutElement* detectorReadoutElement = m_muonGeoMgr->getMMReadoutElement(channelId);
    if(!detectorReadoutElement) {
       THROW_EXCEPTION("failed to retrieve MMReadoutElement");
    }
    const MuonGM::MuonChannelDesign* channelDesign = detectorReadoutElement->getDesign(channelId);
    if(!channelDesign) {
      THROW_EXCEPTION("failed to retrieve MuonChannelDesign");
    }
 
    int channel_number = idHelper.channel(channelId);
    if(idHelper.isStereo(channelId)){
      if(channel_number <= channelDesign->nMissedBottomStereo  || channel_number >= channelDesign->totalStrips - channelDesign->nMissedTopStereo) {
         return false;
       } 
    } else {
      if(channel_number <= channelDesign->nMissedBottomEta  || channel_number >= channelDesign->totalStrips - channelDesign->nMissedTopEta) {
        return false;
      } 
    }
    return true; 
 
}

isGood()

bool NswDcsDbData::isGood	(	const EventContext &	ctx,
		const Identifier &	channelId,
		bool	issTgcQ1OuterHv = false ) const

Returns whether the channel is alive, i.e. DCS state on, etc...

Definition at line 180 of file NswDcsDbData.cxx.

                                                                                                          {
    // here we will check the different DCS components that need to be good to declare a detector region as good
    // for now we only we only have the HV data
    if(!isGoodHv(channelId, issTgcQ1OuterHv)) return false;
    //isGoodEltx and isGoodTdaq are still under validation, but since they are switched off in the NswDcsAlg their data will be empty so they do not reject hits for now.
    bool permanentlyDisabled{false};
    if(!isGoodTDaq(ctx, channelId, permanentlyDisabled)) return false;
    if(!isGoodEltx(channelId)) return false;
    if(!isConnectedChannel(channelId))  return false;
    return true;
 
}

isGoodEltx()

bool NswDcsDbData::isGoodEltx

(

const Identifier &

channelId

)

const

Definition at line 248 of file NswDcsDbData.cxx.

                                                              {
    const ChannelTDaqMap & data = m_idHelperSvc->isMM(channelId) ? m_data_tdaq_mmg : m_data_tdaq_stg;
    const unsigned int array_idx = identToModuleIdx(channelId);
    if(data.size()<=array_idx || data[array_idx].empty()) return true; // for this ro element no bad elink have been recorded 
    if(data[array_idx].find(channelId) != data[array_idx].end()) return false;
    return true;
}

isGoodHv()

bool NswDcsDbData::isGoodHv	(	const Identifier &	channelId,
		bool	issTgcQ1OuterHv = false ) const

For the moment do not kill the hit if there's no dcs data

Definition at line 194 of file NswDcsDbData.cxx.

                                                                                   {
    if (m_idHelperSvc->issTgc(channelId)){
        const NswDcsDbData::DcsConstants* dcs = getDataForChannelHv(DcsTechType::STG, channelId, issTgcQ1OuterHv);
        return !dcs || dcs->fsmState == DcsFsmState::ON;
    } else if (m_idHelperSvc->isMM(channelId)){
        const NswDcsDbData::DcsConstants* dcsDrift = getDataForChannelHv(DcsTechType::MMD, channelId, issTgcQ1OuterHv);
        bool driftHvIsGood = (!dcsDrift || dcsDrift->fsmState == DcsFsmState::ON);
 
        const NswDcsDbData::DcsConstants* dcsStrips = getDataForChannelHv(DcsTechType::MMG, channelId, issTgcQ1OuterHv);
        bool stripHvIsGood = (!dcsStrips || dcsStrips->fsmState == DcsFsmState::ON);
        
        return  driftHvIsGood && stripHvIsGood; 
    }
    return false;
}

isGoodTDaq()

bool NswDcsDbData::isGoodTDaq	(	const EventContext &	ctx,
		const Identifier &	channelId,
		bool &	permanentlyDisabled ) const

Definition at line 211 of file NswDcsDbData.cxx.

                                                                                                                   {
    const ChannelTDaqMap & data = m_idHelperSvc->isMM(channelId) ? m_data_tdaq_mmg : m_data_tdaq_stg;
    const unsigned int array_idx = identToModuleIdx(channelId);
    if(data.size()<=array_idx || data[array_idx].empty()) return true; // for this ro element no bad elink have been recorded 
    const std::map<Identifier, std::set<TDaqConstants>>& dataInRoElement = data[array_idx];
    Identifier mapIdentifier{0};
    uint elink{0};
 
    if(m_idHelperSvc->issTgc(channelId)){
        const sTgcIdHelper& idHelper{m_idHelperSvc->stgcIdHelper()};
        mapIdentifier = idHelper.febID(channelId);
        auto mapper = Muon::nsw::MapperSTG();
        mapper.elink_info(idHelper.channelType(channelId), !idHelper.isSmall(channelId), std::abs(idHelper.stationEta(channelId))-1, 4*(idHelper.multilayer(channelId)-1) + idHelper.gasGap(channelId) -1, idHelper.channel(channelId), elink);
    } else {
        const MmIdHelper& idHelper{m_idHelperSvc->mmIdHelper()};
        mapIdentifier = idHelper.febID(channelId);
        auto mapper = Muon::nsw::MapperMMG();
        mapper.elink_info(std::abs(idHelper.stationEta(channelId))-1, idHelper.channel(channelId), elink); 
    }
    
    auto elm = dataInRoElement.find(mapIdentifier);
    if(elm == dataInRoElement.end()) return true; // channel in question was not deactivated at all
    TDaqConstants x;
    uint64_t evtTime = ctx.eventID().time_stamp()*1e9; // go from seconds to nanoseconds
    evtTime += ctx.eventID().time_stamp_ns_offset();
    x.timeSince = evtTime;
    x.timeUntil = evtTime;
    x.elink = elink;
 
    auto disabledLink = elm->second.find(x);
    if(disabledLink != elm->second.end()){// elink was deactivated for this time period
        permanentlyDisabled = disabledLink->permanentlyDisabled;
        return false;
    } 
    return true; // checked the channel in question, not deactivated for given run and lumi block combination, all good
}

setDataEltx()

void NswDcsDbData::setDataEltx	(	const DcsTechType	tech,
		const Identifier &	chnlId )

Definition at line 100 of file NswDcsDbData.cxx.

                                                                             {
    ChannelEltxMap& data = tech == DcsTechType::MMG ? m_data_eltx_mmg : m_data_eltx_stg;
    const uint array_idx = identToModuleIdx(channelId);
    if (array_idx >= data.size()) data.resize(array_idx + 1);
    data[array_idx].insert(channelId);
}

setDataHv()

void NswDcsDbData::setDataHv	(	const DcsTechType	tech,
		const Identifier &	chnlId,
		DcsConstants	constants )

Definition at line 50 of file NswDcsDbData.cxx.

                                                                                                {
    if((tech == DcsTechType::MMG || tech == DcsTechType::MMD) ) {
        const MmIdHelper& idHelper{m_idHelperSvc->mmIdHelper()};
        ChannelDcsMap& dcsMap = tech == DcsTechType::MMG ? m_data_hv_mmg : m_data_hv_mmd;
        const unsigned int array_idx = identToModuleIdx(chnlId);
        if (array_idx >= dcsMap.size()) dcsMap.resize(array_idx + 1);
        DcsModule& dcs_mod = dcsMap[array_idx];
        const unsigned int channel = idHelper.channel(chnlId)-1;
        if(dcs_mod.channels.empty())
            dcs_mod.layer_id = m_idHelperSvc->gasGapId(chnlId);
        if(dcs_mod.channels.size() <= channel) dcs_mod.channels.resize(channel +1);
        if(dcs_mod.channels[channel]) {
            THROW_EXCEPTION("NswDcsDbData::setData() -- Cannot overwrite channel");
            return;
        }
        dcs_mod.channels[channel] = std::make_unique<DcsConstants>(std::move(constants));
    } else if(tech == DcsTechType::STG) {
        const sTgcIdHelper& idHelper{m_idHelperSvc->stgcIdHelper()};
        ChannelDcsMap& dcsMap = m_data_hv_stg;
        const unsigned int array_idx = identToModuleIdx(chnlId); 
        if (array_idx >= dcsMap.size()) dcsMap.resize(array_idx + 1);
        DcsModule& dcs_mod = dcsMap.at(array_idx);
        const unsigned int channel = idHelper.channel(chnlId)-1;
        if(dcs_mod.channels.empty()) {
            dcs_mod.layer_id = m_idHelperSvc->layerId(chnlId);
        }
        if(dcs_mod.channels.size() <= channel) dcs_mod.channels.resize(channel +1);
        if(dcs_mod.channels[channel]) {
            THROW_EXCEPTION("setData() -- Cannot overwrite channel");
            return;
        }
        dcs_mod.channels[channel] = std::make_unique<DcsConstants>(std::move(constants));
    }
}

setDataTDaq()

void NswDcsDbData::setDataTDaq	(	const DcsTechType	tech,
		const Identifier &	chnlId,
		uint64_t	timeSince,
		uint64_t	timeUntil,
		unsigned int	elink,
		bool	permanentlyDisabled )

Definition at line 87 of file NswDcsDbData.cxx.

                                                                                                                                                                {
    ChannelTDaqMap& data = tech == DcsTechType::MMG ? m_data_tdaq_mmg : m_data_tdaq_stg;
    const unsigned int array_idx = identToModuleIdx(chnlId);
    if (array_idx >= data.size()) data.resize(array_idx + 1);
    TDaqConstants x;
    x.timeSince = timeSince;
    x.timeUntil = timeUntil;
    x.elink = elink;
    x.permanentlyDisabled = permanentlyDisabled;
    data[array_idx][chnlId].insert(x);
}

Member Data Documentation

m_data_eltx_mmg

ChannelEltxMap NswDcsDbData::m_data_eltx_mmg {}

private

Definition at line 82 of file NswDcsDbData.h.

{};

m_data_eltx_stg

ChannelEltxMap NswDcsDbData::m_data_eltx_stg {}

private

Definition at line 83 of file NswDcsDbData.h.

{};

m_data_hv_mmd

ChannelDcsMap NswDcsDbData::m_data_hv_mmd {}

private

Definition at line 76 of file NswDcsDbData.h.

{};

m_data_hv_mmg

ChannelDcsMap NswDcsDbData::m_data_hv_mmg {}

private

Definition at line 75 of file NswDcsDbData.h.

{};

m_data_hv_stg

ChannelDcsMap NswDcsDbData::m_data_hv_stg {}

private

Definition at line 77 of file NswDcsDbData.h.

{};

m_data_tdaq_mmg

ChannelTDaqMap NswDcsDbData::m_data_tdaq_mmg {}

private

Definition at line 79 of file NswDcsDbData.h.

{};

m_data_tdaq_stg

ChannelTDaqMap NswDcsDbData::m_data_tdaq_stg {}

private

Definition at line 80 of file NswDcsDbData.h.

{};

m_idHelperSvc

const Muon::IMuonIdHelperSvc* NswDcsDbData::m_idHelperSvc {}

private

Definition at line 86 of file NswDcsDbData.h.

{};

m_muonGeoMgr

const MuonGM::MuonDetectorManager* NswDcsDbData::m_muonGeoMgr {nullptr}

private

Definition at line 87 of file NswDcsDbData.h.

{nullptr}; 

---

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

• NswDcsDbData.h
• NswDcsDbData.cxx