DQMRivetClient Class Reference

#include <DQMRivetClient.h>

Inheritance diagram for DQMRivetClient:

Classes
struct	LumiOption
struct	NormOption
struct	ScaleFactorOption

Public Types
typedef dqm::legacy::DQMStore	DQMStore
typedef dqm::legacy::MonitorElement	MonitorElement
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
void	analyze (const edm::Event &event, const edm::EventSetup &eventSetup) override
	DQMRivetClient (const edm::ParameterSet &pset)
void	endJob () override
void	endRun (const edm::Run &r, const edm::EventSetup &c) override
	EndRun. More...
void	normalizeToIntegral (const std::string &startDir, const std::string &histName, const std::string &normHistName)
void	normalizeToLumi (const std::string &startDir, const std::string &histName, const std::string &normHistName, double xsection)
void	scaleByFactor (const std::string &startDir, const std::string &histName, double factor)
	~DQMRivetClient () override
Public Member Functions inherited from edm::EDAnalyzer
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzer ()
SerialTaskQueue *	globalLuminosityBlocksQueue ()
SerialTaskQueue *	globalRunsQueue ()
ModuleDescription const &	moduleDescription () const
std::string	workerType () const
	~EDAnalyzer () override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase &&)=default
	EDConsumerBase (EDConsumerBase const &)=delete
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase &	operator= (EDConsumerBase &&)=default
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Private Attributes
std::vector< LumiOption >	lumiOptions_
std::vector< NormOption >	normOptions_
std::string	outputFileName_
std::vector< ScaleFactorOption >	scaleOptions_
std::vector< std::string >	subDirs_
DQMStore *	theDQM
unsigned int	verbose_

Additional Inherited Members
Static Public Member Functions inherited from edm::EDAnalyzer
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
static bool	wantsGlobalLuminosityBlocks ()
static bool	wantsGlobalRuns ()
static bool	wantsInputProcessBlocks ()
static bool	wantsProcessBlocks ()
static bool	wantsStreamLuminosityBlocks ()
static bool	wantsStreamRuns ()
Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

Definition at line 12 of file DQMRivetClient.h.

Member Typedef Documentation

DQMStore

typedef dqm::legacy::DQMStore DQMRivetClient::DQMStore

Definition at line 14 of file DQMRivetClient.h.

MonitorElement

typedef dqm::legacy::MonitorElement DQMRivetClient::MonitorElement

Definition at line 15 of file DQMRivetClient.h.

Constructor & Destructor Documentation

DQMRivetClient()

DQMRivetClient::DQMRivetClient

(

const edm::ParameterSet &

pset

)

Definition at line 29 of file DQMRivetClient.cc.

                                                       {
  typedef std::vector<edm::ParameterSet> VPSet;
  typedef std::vector<std::string> vstring;
  typedef boost::escaped_list_separator<char> elsc;
 
  elsc commonEscapes("\\", " \t", "\'");
 
  // Parse Normalization commands
  vstring normCmds = pset.getUntrackedParameter<vstring>("normalizationToIntegral", vstring());
  for (vstring::const_iterator normCmd = normCmds.begin(); normCmd != normCmds.end(); ++normCmd) {
    if (normCmd->empty())
      continue;
    boost::tokenizer<elsc> tokens(*normCmd, commonEscapes);
 
    vector<string> args;
    for (boost::tokenizer<elsc>::const_iterator iToken = tokens.begin(); iToken != tokens.end(); ++iToken) {
      if (iToken->empty())
        continue;
      args.push_back(*iToken);
    }
 
    if (args.empty() or args.size() > 2) {
      LogInfo("DQMRivetClient") << "Wrong input to normCmds\n";
      continue;
    }
 
    NormOption opt;
    opt.name = args[0];
    opt.normHistName = args.size() == 2 ? args[1] : args[0];
 
    normOptions_.push_back(opt);
  }
 
  VPSet normSets = pset.getUntrackedParameter<VPSet>("normalizationToIntegralSets", VPSet());
  for (VPSet::const_iterator normSet = normSets.begin(); normSet != normSets.end(); ++normSet) {
    NormOption opt;
    opt.name = normSet->getUntrackedParameter<string>("name");
    opt.normHistName = normSet->getUntrackedParameter<string>("normalizedTo", opt.name);
 
    normOptions_.push_back(opt);
  }
 
  //normalize to lumi
  vstring lumiCmds = pset.getUntrackedParameter<vstring>("normalizationToLumi", vstring());
  for (vstring::const_iterator lumiCmd = lumiCmds.begin(); lumiCmd != lumiCmds.end(); ++lumiCmd) {
    if (lumiCmd->empty())
      continue;
    boost::tokenizer<elsc> tokens(*lumiCmd, commonEscapes);
 
    vector<string> args;
    for (boost::tokenizer<elsc>::const_iterator iToken = tokens.begin(); iToken != tokens.end(); ++iToken) {
      if (iToken->empty())
        continue;
      args.push_back(*iToken);
    }
 
    if (args.size() != 2) {
      LogInfo("DQMRivetClient") << "Wrong input to lumiCmds\n";
      continue;
    }
 
    DQMRivetClient::LumiOption opt;
    opt.name = args[0];
    opt.normHistName = args[1];
    opt.xsection = pset.getUntrackedParameter<double>("xsection", -1.);
    //opt.xsection = atof(args[2].c_str());
 
    //std::cout << opt.name << " " << opt.normHistName << " " << opt.xsection << std::endl;
    lumiOptions_.push_back(opt);
  }
 
  //multiply by a number
  vstring scaleCmds = pset.getUntrackedParameter<vstring>("scaleBy", vstring());
  for (vstring::const_iterator scaleCmd = scaleCmds.begin(); scaleCmd != scaleCmds.end(); ++scaleCmd) {
    if (scaleCmd->empty())
      continue;
    boost::tokenizer<elsc> tokens(*scaleCmd, commonEscapes);
 
    vector<string> args;
    for (boost::tokenizer<elsc>::const_iterator iToken = tokens.begin(); iToken != tokens.end(); ++iToken) {
      if (iToken->empty())
        continue;
      args.push_back(*iToken);
    }
 
    if (args.empty() or args.size() > 2) {
      LogInfo("DQMRivetClient") << "Wrong input to normCmds\n";
      continue;
    }
 
    ScaleFactorOption opt;
    opt.name = args[0];
    opt.scale = atof(args[1].c_str());
    scaleOptions_.push_back(opt);
  }
 
  outputFileName_ = pset.getUntrackedParameter<string>("outputFileName", "");
  subDirs_ = pset.getUntrackedParameter<vstring>("subDirs");
}

References writedatasetfile::args, runTheMatrix::opt, or, muonDTDigis_cfi::pset, and HistogramManager_cfi::VPSet().

~DQMRivetClient()

DQMRivetClient::~DQMRivetClient ( )

inlineoverride

Definition at line 21 of file DQMRivetClient.h.

{};

Member Function Documentation

analyze()

void DQMRivetClient::analyze ( const edm::Event &  event, const edm::EventSetup &  eventSetup  )

inlineoverridevirtual

Implements edm::EDAnalyzer.

Definition at line 23 of file DQMRivetClient.h.

{};

endJob()

void DQMRivetClient::endJob ( void  )

overridevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 189 of file DQMRivetClient.cc.

                            {
  // Update 2009-09-23
  // Migrated all code from here to endRun
 
  LogTrace("DQMRivetClient") << "inside of ::endJob()" << endl;
}

References LogTrace.

endRun()

void DQMRivetClient::endRun ( const edm::Run &  r, const edm::EventSetup &  c  )

overridevirtual

EndRun.

Reimplemented from edm::EDAnalyzer.

Definition at line 129 of file DQMRivetClient.cc.

                                                                   {
  typedef vector<string> vstring;
 
  // Update 2009-09-23
  // Migrated all code from endJob to this function
  // endJob is not necessarily called in the proper sequence
  // and does not necessarily book histograms produced in
  // that step.
  // It more robust to do the histogram manipulation in
  // this endRun function
 
  theDQM = nullptr;
  theDQM = Service<DQMStore>().operator->();
 
  if (!theDQM) {
    LogInfo("DQMRivetClient") << "Cannot create DQMStore instance\n";
    return;
  }
 
  // Process wildcard in the sub-directory
  set<string> subDirSet;
 
  for (vstring::const_iterator iSubDir = subDirs_.begin(); iSubDir != subDirs_.end(); ++iSubDir) {
    string subDir = *iSubDir;
 
    if (subDir[subDir.size() - 1] == '/')
      subDir.erase(subDir.size() - 1);
 
    subDirSet.insert(subDir);
  }
 
  for (set<string>::const_iterator iSubDir = subDirSet.begin(); iSubDir != subDirSet.end(); ++iSubDir) {
    const string& dirName = *iSubDir;
    for (vector<NormOption>::const_iterator normOption = normOptions_.begin(); normOption != normOptions_.end();
         ++normOption) {
      normalizeToIntegral(dirName, normOption->name, normOption->normHistName);
    }
  }
 
  for (set<string>::const_iterator iSubDir = subDirSet.begin(); iSubDir != subDirSet.end(); ++iSubDir) {
    const string& dirName = *iSubDir;
    for (vector<LumiOption>::const_iterator lumiOption = lumiOptions_.begin(); lumiOption != lumiOptions_.end();
         ++lumiOption) {
      normalizeToLumi(dirName, lumiOption->name, lumiOption->normHistName, lumiOption->xsection);
    }
  }
 
  for (set<string>::const_iterator iSubDir = subDirSet.begin(); iSubDir != subDirSet.end(); ++iSubDir) {
    const string& dirName = *iSubDir;
    for (vector<ScaleFactorOption>::const_iterator scaleOption = scaleOptions_.begin();
         scaleOption != scaleOptions_.end();
         ++scaleOption) {
      scaleByFactor(dirName, scaleOption->name, scaleOption->scale);
    }
  }
 
  if (!outputFileName_.empty())
    theDQM->save(outputFileName_);
}

References TrackerOfflineValidation_Dqm_cff::dirName, PostProcessor_cff::normalizeToIntegral, PostProcessor_cff::normalizeToLumi, and PostProcessorHcalIsoTrack_cfi::subDir.

normalizeToIntegral()

void DQMRivetClient::normalizeToIntegral	(	const std::string &	startDir,
		const std::string &	histName,
		const std::string &	normHistName
	)

Definition at line 196 of file DQMRivetClient.cc.

                                                                        {
  if (!theDQM->dirExists(startDir)) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "Cannot find sub-directory " << startDir << endl;
    return;
  }
 
  theDQM->cd();
 
  ME* element = theDQM->get(startDir + "/" + histName);
  ME* normME = theDQM->get(startDir + "/" + normHistName);
 
  if (!element) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "No such element '" << histName << "' found\n";
    return;
  }
 
  if (!normME) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "No such element '" << normHistName << "' found\n";
    return;
  }
 
  TH1F* hist = element->getTH1F();
  if (!hist) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "Cannot create TH1F from ME\n";
    return;
  }
 
  TH1F* normHist = normME->getTH1F();
  if (!normHist) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "Cannot create TH1F from ME\n";
    return;
  }
 
  const double entries = normHist->Integral();
  if (entries != 0) {
    hist->Scale(1. / entries, "width");
  } else {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "Zero entries in histogram\n";
  }
 
  return;
}

References compare::hist.

normalizeToLumi()

void DQMRivetClient::normalizeToLumi	(	const std::string &	startDir,
		const std::string &	histName,
		const std::string &	normHistName,
		double	xsection
	)

Definition at line 247 of file DQMRivetClient.cc.

                                                      {
  normalizeToIntegral(startDir, histName, normHistName);
  theDQM->cd();
  ME* element = theDQM->get(startDir + "/" + histName);
  TH1F* hist = element->getTH1F();
  if (!hist) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "Cannot create TH1F from ME\n";
    return;
  }
  hist->Scale(xsection);
  return;
}

References compare::hist, PostProcessor_cff::normalizeToIntegral, and PostProcessor_cff::xsection.

scaleByFactor()

void DQMRivetClient::scaleByFactor	(	const std::string &	startDir,
		const std::string &	histName,
		double	factor
	)

Definition at line 264 of file DQMRivetClient.cc.

                                                                                                      {
  if (!theDQM->dirExists(startDir)) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "Cannot find sub-directory " << startDir << endl;
    return;
  }
 
  theDQM->cd();
 
  ME* element = theDQM->get(startDir + "/" + histName);
 
  if (!element) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "No such element '" << histName << "' found\n";
    return;
  }
 
  TH1F* hist = element->getTH1F();
  if (!hist) {
    LogInfo("DQMRivetClient") << "normalizeToEntries() : "
                              << "Cannot create TH1F from ME\n";
    return;
  }
  hist->Scale(factor);
}

References DQMScaleToClient_cfi::factor, and compare::hist.

Member Data Documentation

lumiOptions_

std::vector<LumiOption> DQMRivetClient::lumiOptions_

private

Definition at line 55 of file DQMRivetClient.h.

normOptions_

std::vector<NormOption> DQMRivetClient::normOptions_

private

Definition at line 54 of file DQMRivetClient.h.

outputFileName_

std::string DQMRivetClient::outputFileName_

private

Definition at line 52 of file DQMRivetClient.h.

scaleOptions_

std::vector<ScaleFactorOption> DQMRivetClient::scaleOptions_

private

Definition at line 56 of file DQMRivetClient.h.

subDirs_

std::vector<std::string> DQMRivetClient::subDirs_

private

Definition at line 51 of file DQMRivetClient.h.

theDQM

DQMStore* DQMRivetClient::theDQM

private

Definition at line 50 of file DQMRivetClient.h.

verbose_

unsigned int DQMRivetClient::verbose_

private

Definition at line 48 of file DQMRivetClient.h.