Class which reads a root file containing "commissioning histograms", analyzes the histograms to extract "monitorables", creates summary histograms, and uploads to DB. More...

#include <SiStripCommissioningOfflineDbClient.h>

Inheritance diagram for SiStripCommissioningOfflineDbClient:

Public Member Functions
	SiStripCommissioningOfflineDbClient (const edm::ParameterSet &)

	~SiStripCommissioningOfflineDbClient () override

Public Member Functions inherited from SiStripCommissioningOfflineClient
void	analyze (const edm::Event &, const edm::EventSetup &) override

void	beginRun (const edm::Run &, const edm::EventSetup &) override

void	endJob () override

	SiStripCommissioningOfflineClient (const edm::ParameterSet &)

	~SiStripCommissioningOfflineClient () 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::array< std::vector< ModuleDescription const * > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, 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

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Protected Member Functions
void	createHistos (const edm::ParameterSet &, const edm::EventSetup &) override

void	uploadToConfigDb () override

Protected Member Functions inherited from SiStripCommissioningOfflineClient
virtual void	setInputFiles (std::vector< std::string > &, const std::string, const std::string, uint32_t, bool)

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)

Private Attributes
edm::ESGetToken< TrackerGeometry, TrackerDigiGeometryRecord >	tkGeomToken_

edm::ESGetToken< TrackerTopology, TrackerTopologyRcd >	tTopoToken_

bool	uploadAnal_

bool	uploadConf_

bool	uploadToDb_

Additional Inherited Members
Public Types inherited from SiStripCommissioningOfflineClient
typedef dqm::harvesting::DQMStore	DQMStore

typedef dqm::harvesting::MonitorElement	MonitorElement

Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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 Types inherited from SiStripCommissioningOfflineClient
typedef std::vector< TH1 * >	Histos

typedef std::map< uint32_t, Histos >	HistosMap

Protected Attributes inherited from SiStripCommissioningOfflineClient
bool	analyzeHistos_

DQMStore *	bei_

bool	clientHistos_

bool	collateHistos_

bool	createSummaryPlots_

CommissioningHistograms *	histos_

std::vector< std::string >	inputFiles_

HistosMap	map_

std::string	outputFileName_

edm::ParameterSet	parameters_

std::string	partitionName_

std::vector< SummaryPlot >	plots_

uint32_t	runNumber_

sistrip::RunType	runType_

bool	uploadToDb_

std::string	xmlFile_

Detailed Description

Class which reads a root file containing "commissioning histograms", analyzes the histograms to extract "monitorables", creates summary histograms, and uploads to DB.

Author: R.Bainbridge, M.Wingham

Definition at line 22 of file SiStripCommissioningOfflineDbClient.h.

Constructor & Destructor Documentation

◆ SiStripCommissioningOfflineDbClient()

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

Definition at line 27 of file SiStripCommissioningOfflineDbClient.cc.

     : SiStripCommissioningOfflineClient(pset),
       uploadAnal_(pset.getUntrackedParameter<bool>("UploadAnalyses", false)),
       uploadConf_(pset.getUntrackedParameter<bool>("UploadHwConfig", false)),
       tTopoToken_{esConsumes<edm::Transition::BeginRun>()},
       tkGeomToken_{esConsumes<edm::Transition::BeginRun>()} {
   LogTrace(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                          << " Constructing object...";
   if (!uploadConf_) {
     edm::LogWarning(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                   << " ===> TEST only! No hardware configurations"
                                   << " will be uploaded to the DB...";
   }
   if (!uploadAnal_) {
     edm::LogWarning(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                   << " ===> TEST only! No analysis descriptions"
                                   << " will be uploaded to the DB...";
   }
 }

◆ ~SiStripCommissioningOfflineDbClient()

SiStripCommissioningOfflineDbClient::~SiStripCommissioningOfflineDbClient ( )

override

Definition at line 49 of file SiStripCommissioningOfflineDbClient.cc.

                                                                           {
   LogTrace(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                          << " Destructing object...";
 }

References LogTrace, and sistrip::mlDqmClient_.

Member Function Documentation

◆ createHistos()

void SiStripCommissioningOfflineDbClient::createHistos	(	const edm::ParameterSet &	pset,
		const edm::EventSetup &	setup
	)

overrideprotectedvirtual

Reimplemented from SiStripCommissioningOfflineClient.

Definition at line 56 of file SiStripCommissioningOfflineDbClient.cc.

                                                                                                               {
   // Check pointer
   if (histos_) {
     edm::LogError(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                 << " CommissioningHistogram object already exists!"
                                 << " Aborting...";
     return;
   }
  
   // Check pointer to BEI
   // is this needed here? bei_ = edm::Service<DQMStore>().operator->();
   if (!bei_) {
     edm::LogError(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                 << " NULL pointer to DQMStore!";
     return;
   }
  
   // Create DB connection
   SiStripConfigDb* db = edm::Service<SiStripConfigDb>().operator->();  //@@ NOT GUARANTEED TO BE THREAD SAFE!
   LogTrace(mlCabling_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                        << " Nota bene: using the SiStripConfigDb API"
                        << " as a \"service\" does not presently guarantee"
                        << " thread-safe behaviour!...";
  
   // Check DB connection
   if (!db) {
     edm::LogError(mlCabling_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                               << " NULL pointer to SiStripConfigDb!"
                               << " Aborting...";
     return;
   }
  
   // Create corresponding "commissioning histograms" object
   if (runType_ == sistrip::FAST_CABLING) {
     histos_ = new FastFedCablingHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::APV_TIMING) {
     histos_ = new ApvTimingHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::OPTO_SCAN) {
     histos_ = new OptoScanHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::VPSP_SCAN) {
     histos_ = new VpspScanHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::PEDESTALS) {
     histos_ = new PedestalsHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::PEDS_ONLY) {
     histos_ = new PedsOnlyHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::PEDS_FULL_NOISE) {
     histos_ = new PedsFullNoiseHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::NOISE) {
     histos_ = new NoiseHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::APV_LATENCY) {
     histos_ = new LatencyHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::FINE_DELAY) {
     histos_ = new FineDelayHistosUsingDb(pset, bei_, db, tTopoToken_, tkGeomToken_);
   } else if (runType_ == sistrip::CALIBRATION || runType_ == sistrip::CALIBRATION_DECO ||
              runType_ == sistrip::CALIBRATION_SCAN || runType_ == sistrip::CALIBRATION_SCAN_DECO) {
     histos_ = new CalibrationHistosUsingDb(pset, bei_, db, tTopoToken_, runType_);
   } else if (runType_ == sistrip::DAQ_SCOPE_MODE) {
     histos_ = new DaqScopeModeHistosUsingDb(pset, bei_, db, tTopoToken_);
   } else if (runType_ == sistrip::UNDEFINED_RUN_TYPE) {
     histos_ = nullptr;
     edm::LogError(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                 << " Undefined run type!";
     return;
   } else if (runType_ == sistrip::UNKNOWN_RUN_TYPE) {
     histos_ = nullptr;
     edm::LogError(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                 << " Unknown run type!";
     return;
   }
   histos_->configure(pset, setup);
  
   CommissioningHistosUsingDb* tmp = dynamic_cast<CommissioningHistosUsingDb*>(histos_);
   if (tmp) {
     tmp->doUploadConf(uploadConf_);
     tmp->doUploadAnal(uploadAnal_);
     std::stringstream ss;
     ss << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]" << std::endl
        << " Uploading hardware configurations?    : " << (tmp->doUploadConf() ? "true" : "false") << std::endl
        << " Uploading calibrations from analysis? : " << (tmp->doUploadAnal() ? "true" : "false") << std::endl;
     edm::LogVerbatim(mlDqmClient_) << ss.str();
   } else {
     edm::LogError(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                 << " NULL pointer to CommissioningHistosUsingDb!";
   }
 }

References sistrip::APV_LATENCY, sistrip::APV_TIMING, SiStripCommissioningOfflineClient::bei_, sistrip::CALIBRATION, sistrip::CALIBRATION_DECO, sistrip::CALIBRATION_SCAN, sistrip::CALIBRATION_SCAN_DECO, CommissioningHistograms::configure(), sistrip::DAQ_SCOPE_MODE, dqmiodatasetharvest::db, sistrip::FAST_CABLING, sistrip::FINE_DELAY, SiStripCommissioningOfflineClient::histos_, LogTrace, sistrip::mlCabling_, sistrip::mlDqmClient_, sistrip::NOISE, sistrip::OPTO_SCAN, sistrip::PEDESTALS, sistrip::PEDS_FULL_NOISE, sistrip::PEDS_ONLY, muonDTDigis_cfi::pset, SiStripCommissioningOfflineClient::runType_, singleTopDQM_cfi::setup, contentValuesCheck::ss, tkGeomToken_, createJobs::tmp, tTopoToken_, sistrip::UNDEFINED_RUN_TYPE, sistrip::UNKNOWN_RUN_TYPE, uploadAnal_, uploadConf_, and sistrip::VPSP_SCAN.

◆ uploadToConfigDb()

void SiStripCommissioningOfflineDbClient::uploadToConfigDb ( )

overrideprotectedvirtual

Reimplemented from SiStripCommissioningOfflineClient.

Definition at line 144 of file SiStripCommissioningOfflineDbClient.cc.

                                                            {
   edm::LogVerbatim(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                  << " Uploading parameters to database...";
   CommissioningHistosUsingDb* tmp = dynamic_cast<CommissioningHistosUsingDb*>(histos_);
   if (tmp) {
     tmp->uploadToConfigDb();
     edm::LogVerbatim(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                    << " Uploaded parameters to database!";
   } else {
     edm::LogError(mlDqmClient_) << "[SiStripCommissioningOfflineDbClient::" << __func__ << "]"
                                 << " NULL pointer to CommissioningHistosUsingDb object!"
                                 << " Upload aborted!...";
   }
 }