GEMOfflineDQMBase Class Reference

#include <GEMOfflineDQMBase.h>

Inheritance diagram for GEMOfflineDQMBase:

Classes
class	BookingHelper

Public Types
typedef std::map< MEMapKey1, MonitorElement * >	MEMap1
typedef std::map< MEMapKey2, MonitorElement * >	MEMap2
typedef std::map< MEMapKey3, MonitorElement * >	MEMap3
typedef std::tuple< int, int >	MEMapKey1
typedef std::tuple< int, int, bool >	MEMapKey2
typedef std::tuple< int, int, bool, int >	MEMapKey3
Public Types inherited from DQMEDAnalyzer
typedef dqm::reco::DQMStore	DQMStore
typedef dqm::reco::MonitorElement	MonitorElement
Public Types inherited from edm::stream::EDProducer< edm::GlobalCache< DQMEDAnalyzerGlobalCache >, edm::EndRunProducer, edm::EndLuminosityBlockProducer, edm::Accumulator >
typedef CacheContexts< T... >	CacheTypes
typedef CacheTypes::GlobalCache	GlobalCache
typedef AbilityChecker< T... >	HasAbility
typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache
typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext
typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache
typedef CacheTypes::RunCache	RunCache
typedef RunContextT< RunCache, GlobalCache >	RunContext
typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Member Functions
template<typename T >
bool	checkRefs (const std::vector< T * > &)
template<typename AnyKey >
TString	convertKeyToStr (const AnyKey &key)
template<typename AnyKey >
void	fillME (std::map< AnyKey, MonitorElement * > &, const AnyKey &, const float)
template<typename AnyKey >
void	fillME (std::map< AnyKey, MonitorElement * > &, const AnyKey &, const float, const float y)
	GEMOfflineDQMBase (const edm::ParameterSet &)
int	getDetOccXBin (const GEMDetId &, const edm::ESHandle< GEMGeometry > &)
int	getDetOccXBin (const int, const int, const int)
int	getMaxVFAT (const int)
int	getNumEtaPartitions (const GEMStation *)
int	getVFATNumber (const int, const int, const int)
int	getVFATNumberByStrip (const int, const int, const int)
void	setDetLabelsEta (MonitorElement *, const GEMStation *)
void	setDetLabelsVFAT (MonitorElement *, const GEMStation *)
Public Member Functions inherited from DQMEDAnalyzer
void	accumulate (edm::Event const &event, edm::EventSetup const &setup) final
virtual void	analyze (edm::Event const &, edm::EventSetup const &)
void	beginLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &setup) final
void	beginRun (edm::Run const &run, edm::EventSetup const &setup) final
void	beginStream (edm::StreamID id) final
virtual void	bookHistograms (DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &)=0
virtual void	dqmBeginRun (edm::Run const &, edm::EventSetup const &)
	DQMEDAnalyzer ()
void	endLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &setup) final
void	endRun (edm::Run const &run, edm::EventSetup const &setup) final
virtual bool	getCanSaveByLumi ()
Public Member Functions inherited from edm::stream::EDProducer< edm::GlobalCache< DQMEDAnalyzerGlobalCache >, edm::EndRunProducer, edm::EndLuminosityBlockProducer, edm::Accumulator >
	EDProducer ()=default
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndRuns () const final

Public Attributes
std::string	log_category_

Additional Inherited Members
Static Public Member Functions inherited from DQMEDAnalyzer
static void	globalEndJob (DQMEDAnalyzerGlobalCache const *)
static void	globalEndLuminosityBlockProduce (edm::LuminosityBlock &lumi, edm::EventSetup const &setup, LuminosityBlockContext const *context)
static void	globalEndRunProduce (edm::Run &run, edm::EventSetup const &setup, RunContext const *context)
static std::unique_ptr< DQMEDAnalyzerGlobalCache >	initializeGlobalCache (edm::ParameterSet const &)
Protected Member Functions inherited from DQMEDAnalyzer
uint64_t	meId () const
Protected Attributes inherited from DQMEDAnalyzer
edm::EDPutTokenT< DQMToken >	lumiToken_
edm::EDPutTokenT< DQMToken >	runToken_
unsigned int	streamId_

Detailed Description

Definition at line 11 of file GEMOfflineDQMBase.h.

Member Typedef Documentation

MEMap1

typedef std::map<MEMapKey1, MonitorElement*> GEMOfflineDQMBase::MEMap1

Definition at line 18 of file GEMOfflineDQMBase.h.

MEMap2

typedef std::map<MEMapKey2, MonitorElement*> GEMOfflineDQMBase::MEMap2

Definition at line 19 of file GEMOfflineDQMBase.h.

MEMap3

typedef std::map<MEMapKey3, MonitorElement*> GEMOfflineDQMBase::MEMap3

Definition at line 20 of file GEMOfflineDQMBase.h.

MEMapKey1

typedef std::tuple<int, int> GEMOfflineDQMBase::MEMapKey1

Definition at line 15 of file GEMOfflineDQMBase.h.

MEMapKey2

typedef std::tuple<int, int, bool> GEMOfflineDQMBase::MEMapKey2

Definition at line 16 of file GEMOfflineDQMBase.h.

MEMapKey3

typedef std::tuple<int, int, bool, int> GEMOfflineDQMBase::MEMapKey3

Definition at line 17 of file GEMOfflineDQMBase.h.

Constructor & Destructor Documentation

GEMOfflineDQMBase()

GEMOfflineDQMBase::GEMOfflineDQMBase ( const edm::ParameterSet &  pset )

explicit

Definition at line 3 of file GEMOfflineDQMBase.cc.

                                                                {
  log_category_ = pset.getUntrackedParameter<std::string>("logCategory");
}

References log_category_, muonDTDigis_cfi::pset, and AlCaHLTBitMon_QueryRunRegistry::string.

Member Function Documentation

checkRefs()

template<typename T >

bool GEMOfflineDQMBase::checkRefs ( const std::vector< T * > &  refs )

inline

Definition at line 123 of file GEMOfflineDQMBase.h.

                                                                  {
  if (refs.empty())
    return false;
  if (refs.front() == nullptr)
    return false;
  return true;
}

Referenced by GEMOfflineMonitor::bookDetectorOccupancy(), GEMEfficiencyAnalyzer::bookDetectorOccupancy(), and getNumEtaPartitions().

convertKeyToStr()

template<typename AnyKey >

TString GEMOfflineDQMBase::convertKeyToStr

(

const AnyKey &

key

)

Definition at line 132 of file GEMOfflineDQMBase.h.

                                                            {
  if constexpr (std::is_same_v<AnyKey, MEMapKey1>) {
    return TString::Format("Region %d, Station %d.", std::get<0>(key), std::get<1>(key));
 
  } else if constexpr (std::is_same_v<AnyKey, MEMapKey2>) {
    const char* superchamber_type = std::get<2>(key) ? "Odd" : "Even";
    return TString::Format(
        "Region %d, Station %d, %s Superchamber", std::get<0>(key), std::get<1>(key), superchamber_type);
 
  } else if constexpr (std::is_same_v<AnyKey, MEMapKey3>) {
    const char* superchamber_type = std::get<2>(key) ? "Odd" : "Even";
    return TString::Format("Region %d, Station %d, %s Superchamber, Roll %d",
                           std::get<0>(key),
                           std::get<1>(key),
                           superchamber_type,
                           std::get<3>(key));
 
  } else {
    return TString::Format("unknown key type: %s", typeid(key).name());
  }
}

References crabWrapper::key, and Skims_PA_cff::name.

Referenced by fillME().

fillME() [1/2]

template<typename AnyKey >

void GEMOfflineDQMBase::fillME	(	std::map< AnyKey, MonitorElement * > &	me_map,
		const AnyKey &	key,
		const float	x
	)

Definition at line 155 of file GEMOfflineDQMBase.h.

                                                                                                        {
  if (me_map.find(key) == me_map.end()) {
    const TString&& key_str = convertKeyToStr(key);
    edm::LogError(log_category_) << "got invalid key: " << key_str << std::endl;
 
  } else {
    me_map[key]->Fill(x);
  }
}

References convertKeyToStr(), crabWrapper::key, log_category_, and x.

Referenced by GEMOfflineMonitor::analyze(), and GEMEfficiencyAnalyzer::analyze().

fillME() [2/2]

template<typename AnyKey >

void GEMOfflineDQMBase::fillME	(	std::map< AnyKey, MonitorElement * > &	me_map,
		const AnyKey &	key,
		const float	x,
		const float	y
	)

Definition at line 166 of file GEMOfflineDQMBase.h.

                                              {
  if (me_map.find(key) == me_map.end()) {
    const TString&& key_str = convertKeyToStr(key);
    edm::LogError(log_category_) << "got invalid key: " << key_str << std::endl;
 
  } else {
    me_map[key]->Fill(x, y);
  }
}

References convertKeyToStr(), crabWrapper::key, log_category_, x, and y.

getDetOccXBin() [1/2]

int GEMOfflineDQMBase::getDetOccXBin	(	const GEMDetId &	gem_id,
		const edm::ESHandle< GEMGeometry > &	gem
	)

Definition at line 7 of file GEMOfflineDQMBase.cc.

                                                                                                {
  const GEMSuperChamber* superchamber = gem->superChamber(gem_id);
  if (superchamber == nullptr) {
    return -1;
  }
  return getDetOccXBin(gem_id.chamber(), gem_id.layer(), superchamber->nChambers());
}

References GEMDetId::chamber(), getDetOccXBin(), GEMDetId::layer(), and GEMSuperChamber::nChambers().

getDetOccXBin() [2/2]

int GEMOfflineDQMBase::getDetOccXBin ( const int  chamber, const int  layer, const int  n_chambers  )

inline

Definition at line 118 of file GEMOfflineDQMBase.h.

                                                                                                    {
  return n_chambers * (chamber - 1) + layer;
}

References relativeConstraints::chamber.

Referenced by GEMOfflineMonitor::analyze(), GEMEfficiencyAnalyzer::analyze(), getDetOccXBin(), setDetLabelsEta(), and setDetLabelsVFAT().

getMaxVFAT()

int GEMOfflineDQMBase::getMaxVFAT ( const int  station )

inline

Definition at line 99 of file GEMOfflineDQMBase.h.

                                                          {
  if (station == 1)
    return GEMeMap::maxVFatGE11_;
  else if (station == 2)
    return GEMeMap::maxVFatGE21_;
  else
    return -1;
}

References GEMeMap::maxVFatGE11_, GEMeMap::maxVFatGE21_, and relativeConstraints::station.

Referenced by GEMOfflineMonitor::bookDetectorOccupancy(), getVFATNumber(), and setDetLabelsVFAT().

getNumEtaPartitions()

int GEMOfflineDQMBase::getNumEtaPartitions

(

const GEMStation *

station

)

Definition at line 77 of file GEMOfflineDQMBase.cc.

                                                                    {
  const auto&& superchambers = station->superChambers();
  if (not checkRefs(superchambers)) {
    edm::LogError(log_category_) << "failed to get a valid vector of GEMSuperChamber ptrs" << std::endl;
    return 0;
  }
 
  const auto& chambers = superchambers.front()->chambers();
  if (not checkRefs(chambers)) {
    edm::LogError(log_category_) << "failed to get a valid vector of GEMChamber ptrs" << std::endl;
    return 0;
  }
 
  return chambers.front()->nEtaPartitions();
}

References chambers, checkRefs(), log_category_, and relativeConstraints::station.

Referenced by GEMOfflineMonitor::bookDetectorOccupancy(), GEMEfficiencyAnalyzer::bookDetectorOccupancy(), GEMEfficiencyAnalyzer::bookHistograms(), setDetLabelsEta(), and setDetLabelsVFAT().

getVFATNumber()

int GEMOfflineDQMBase::getVFATNumber ( const int  station, const int  ieta, const int  vfat_phi  )

inline

Definition at line 108 of file GEMOfflineDQMBase.h.

                                                                                                 {
  const int max_vfat = getMaxVFAT(station);
  return max_vfat * (ieta - 1) + vfat_phi;
}

References getMaxVFAT(), LEDCalibrationChannels::ieta, and relativeConstraints::station.

Referenced by getVFATNumberByStrip(), and setDetLabelsVFAT().

getVFATNumberByStrip()

int GEMOfflineDQMBase::getVFATNumberByStrip ( const int  station, const int  ieta, const int  strip  )

inline

Definition at line 113 of file GEMOfflineDQMBase.h.

                                                                                                     {
  const int vfat_phi = (strip % GEMeMap::maxChan_) ? strip / GEMeMap::maxChan_ + 1 : strip / GEMeMap::maxChan_;
  return getVFATNumber(station, ieta, vfat_phi);
};

References getVFATNumber(), LEDCalibrationChannels::ieta, GEMeMap::maxChan_, relativeConstraints::station, and digitizers_cfi::strip.

Referenced by GEMOfflineMonitor::analyze().

setDetLabelsEta()

void GEMOfflineDQMBase::setDetLabelsEta	(	MonitorElement *	me,
		const GEMStation *	station
	)

Definition at line 50 of file GEMOfflineDQMBase.cc.

                                                                                     {
  if (me == nullptr) {
    edm::LogError(log_category_) << "MonitorElement* is nullptr" << std::endl;
    return;
  }
 
  me->setAxisTitle("Superchamber / Chamber", 1);
  for (const GEMSuperChamber* superchamber : station->superChambers()) {
    const int num_chambers = superchamber->nChambers();
 
    for (const GEMChamber* chamber : superchamber->chambers()) {
      const int sc = chamber->id().chamber();
      const int ch = chamber->id().layer();
      const int xbin = getDetOccXBin(sc, ch, num_chambers);
      const char* label = Form("%d/%d", sc, ch);
      me->setBinLabel(xbin, label, 1);
    }
  }
 
  const int num_etas = getNumEtaPartitions(station);
  me->setAxisTitle("i#eta", 2);
  for (int ieta = 1; ieta <= num_etas; ieta++) {
    const std::string&& label = std::to_string(ieta);
    me->setBinLabel(ieta, label, 2);
  }
}

References relativeConstraints::chamber, getDetOccXBin(), getNumEtaPartitions(), LEDCalibrationChannels::ieta, label, log_category_, hlt_dqm_clientPB-live_cfg::me, relativeConstraints::station, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by GEMOfflineMonitor::bookDetectorOccupancy(), and GEMEfficiencyAnalyzer::bookDetectorOccupancy().

setDetLabelsVFAT()

void GEMOfflineDQMBase::setDetLabelsVFAT	(	MonitorElement *	me,
		const GEMStation *	station
	)

Definition at line 15 of file GEMOfflineDQMBase.cc.

                                                                                      {
  if (me == nullptr) {
    edm::LogError(log_category_) << "MonitorElement* is nullptr" << std::endl;
    return;
  }
 
  me->setAxisTitle("Superchamber / Chamber", 1);
  for (const GEMSuperChamber* superchamber : station->superChambers()) {
    const int num_chambers = superchamber->nChambers();
    for (const GEMChamber* chamber : superchamber->chambers()) {
      const int sc = chamber->id().chamber();
      const int ch = chamber->id().layer();
      const int xbin = getDetOccXBin(sc, ch, num_chambers);
      const char* label = Form("%d/%d", sc, ch);
      me->setBinLabel(xbin, label, 1);
    }
  }
 
  me->setAxisTitle("VFAT (i#eta)", 2);
  const int max_vfat = getMaxVFAT(station->station());
  if (max_vfat < 0) {
    edm::LogError(log_category_) << "Wrong max VFAT: " << max_vfat << " at Station " << station->station() << std::endl;
    return;
  }
 
  const int num_etas = getNumEtaPartitions(station);
  for (int ieta = 1; ieta <= num_etas; ieta++) {
    for (int vfat_phi = 1; vfat_phi <= max_vfat; vfat_phi++) {
      const int ybin = getVFATNumber(station->station(), ieta, vfat_phi);
      const char* label = Form("%d (%d)", ybin, ieta);
      me->setBinLabel(ybin, label, 2);
    }
  }
}

References relativeConstraints::chamber, getDetOccXBin(), getMaxVFAT(), getNumEtaPartitions(), getVFATNumber(), LEDCalibrationChannels::ieta, label, log_category_, hlt_dqm_clientPB-live_cfg::me, and relativeConstraints::station.

Referenced by GEMOfflineMonitor::bookDetectorOccupancy().

Member Data Documentation

log_category_

std::string GEMOfflineDQMBase::log_category_

Definition at line 45 of file GEMOfflineDQMBase.h.

Referenced by GEMEfficiencyAnalyzer::analyze(), GEMEfficiencyAnalyzer::bookDetectorOccupancy(), GEMEfficiencyAnalyzer::bookHistograms(), fillME(), GEMOfflineDQMBase(), getNumEtaPartitions(), setDetLabelsEta(), and setDetLabelsVFAT().