#include <CalibPPS/TimingCalibration/PPSDiamondSampicTimingCalibrationPCLHarvester/plugins/PPSDiamondSampicTimingCalibrationPCLHarvester.cc>

Inheritance diagram for PPSDiamondSampicTimingCalibrationPCLHarvester:

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

	PPSDiamondSampicTimingCalibrationPCLHarvester (const edm::ParameterSet &)

Public Member Functions inherited from DQMEDHarvester
void	accumulate (edm::Event const &ev, edm::EventSetup const &es) final

void	beginJob () override

void	beginLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &) final

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

virtual void	dqmAnalyze (DQMStore::IBooker &, DQMStore::IGetter &, edm::Event const &, edm::EventSetup const &)

	DQMEDHarvester (edm::ParameterSet const &iConfig)

	DQMEDHarvester ()

virtual void	dqmEndLuminosityBlock (DQMStore::IBooker &, DQMStore::IGetter &, edm::LuminosityBlock const &, edm::EventSetup const &)

virtual void	dqmEndRun (DQMStore::IBooker &, DQMStore::IGetter &, edm::Run const &, edm::EventSetup const &)

void	endLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &) final

void	endLuminosityBlockProduce (edm::LuminosityBlock &lumi, edm::EventSetup const &es) final

void	endProcessBlockProduce (edm::ProcessBlock &) final

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

void	endRunProduce (edm::Run &run, edm::EventSetup const &es) final

	~DQMEDHarvester () override=default

Public Member Functions inherited from edm::one::EDProducer< edm::EndLuminosityBlockProducer, edm::EndRunProducer, edm::EndProcessBlockProducer, edm::one::WatchLuminosityBlocks, edm::one::WatchRuns, edm::one::SharedResources, edm::Accumulator >
	EDProducer ()=default

	EDProducer (const EDProducer &)=delete

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginProcessBlocks () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndProcessBlocks () const final

bool	hasAbilityToProduceInEndRuns () const final

const EDProducer &	operator= (const EDProducer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

Public Member Functions inherited from edm::one::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~EDProducerBase () override

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

std::vector< bool > const &	recordProvenanceList () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

	~ProducerBase () noexcept(false) 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 const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ESResolverIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESResolverIndex > 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 const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, 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::ESRecordsToProductResolverIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &)

Static Public Member Functions inherited from edm::one::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	calibDb (DQMStore::IGetter &iGetter)

void	calibJson (DQMStore::IGetter &iGetter)

void	dqmEndJob (DQMStore::IBooker &, DQMStore::IGetter &) override

bool	getDbSampicChannel (DQMStore::IGetter &iGetter, int &db, int &sampic, int &channel, std::string ch_name, CTPPSDiamondDetId detid)

Private Attributes
std::vector< CTPPSDiamondDetId >	detids_

const std::string	dqmDir_

edm::ESGetToken< CTPPSGeometry, VeryForwardRealGeometryRecord >	geomEsToken_

edm::ESHandle< PPSTimingCalibration >	hTimingCalib_

const std::string	jsonCalibFile_

const std::string	jsonOutputPath_

const unsigned int	min_entries_

edm::ESGetToken< PPSTimingCalibration, PPSTimingCalibrationRcd >	timingCalibrationToken_

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

typedef dqm::harvesting::MonitorElement	MonitorElement

Public Types inherited from edm::one::EDProducerBase
typedef EDProducerBase	ModuleType

Public Types inherited from edm::ProducerBase
template<typename T >
using	BranchAliasSetterT = ProductRegistryHelper::BranchAliasSetterT< T >

using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex > >

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::ProducerBase
template<Transition Tr = Transition::Event>
auto	produces (std::string instanceName) noexcept
	declare what type of product will make and with which optional label More...

template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()

template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()

template<Transition Tr = Transition::Event>
auto	produces () noexcept

ProducesCollector	producesCollector ()

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

void	resetItemsToGetFrom (BranchType iType)

Protected Attributes inherited from DQMEDHarvester
DQMStore *	dqmstore_

edm::GetterOfProducts< DQMToken >	jobmegetter_

edm::EDPutTokenT< DQMToken >	jobToken_

edm::GetterOfProducts< DQMToken >	lumimegetter_

edm::EDPutTokenT< DQMToken >	lumiToken_

edm::GetterOfProducts< DQMToken >	runmegetter_

edm::EDPutTokenT< DQMToken >	runToken_

Detailed Description

Description: Harvester of the DiamondSampic calibration which produces sqlite file with a new channel alignment

Implementation: [Notes on implementation]

Definition at line 45 of file PPSDiamondSampicTimingCalibrationPCLHarvester.cc.

Constructor & Destructor Documentation

◆ PPSDiamondSampicTimingCalibrationPCLHarvester()

PPSDiamondSampicTimingCalibrationPCLHarvester::PPSDiamondSampicTimingCalibrationPCLHarvester ( const edm::ParameterSet & iConfig )

Definition at line 68 of file PPSDiamondSampicTimingCalibrationPCLHarvester.cc.

References edm::ParameterSet::getParameter(), jsonCalibFile_, AlCaHLTBitMon_QueryRunRegistry::string, and timingCalibrationToken_.

     : geomEsToken_(esConsumes<edm::Transition::BeginRun>()),
       dqmDir_(iConfig.getParameter<std::string>("dqmDir")),
       min_entries_(iConfig.getParameter<unsigned int>("minEntries")),
       jsonCalibFile_(iConfig.getParameter<std::string>("jsonCalibFile")),
       jsonOutputPath_(iConfig.getParameter<std::string>("jsonOutputPath")) {
   if (jsonCalibFile_.empty())
     timingCalibrationToken_ = esConsumes<edm::Transition::BeginRun>(
         edm::ESInputTag(iConfig.getParameter<std::string>("timingCalibrationTag")));
 }

Member Function Documentation

◆ beginRun()

void PPSDiamondSampicTimingCalibrationPCLHarvester::beginRun	(	const edm::Run &	iRun,
		const edm::EventSetup &	iSetup
	)

override

Definition at line 82 of file PPSDiamondSampicTimingCalibrationPCLHarvester.cc.

References CTPPSDiamondDetId::check(), detids_, relativeConstraints::geom, geomEsToken_, edm::EventSetup::getData(), edm::EventSetup::getHandle(), hTimingCalib_, jsonCalibFile_, and timingCalibrationToken_.

                                                                                                             {
   if (jsonCalibFile_.empty())
     hTimingCalib_ = iSetup.getHandle(timingCalibrationToken_);
   const auto& geom = iSetup.getData(geomEsToken_);
   for (auto it = geom.beginSensor(); it != geom.endSensor(); ++it) {
     if (!CTPPSDiamondDetId::check(it->first))
       continue;
     const CTPPSDiamondDetId detid(it->first);
     detids_.emplace_back(detid);
   }
 }

◆ calibDb()

void PPSDiamondSampicTimingCalibrationPCLHarvester::calibDb ( DQMStore::IGetter & iGetter )

private

Definition at line 187 of file PPSDiamondSampicTimingCalibrationPCLHarvester.cc.

References cond::service::PoolDBOutputService::currentTime(), dqmiodatasetharvest::db, detids_, dqmDir_, pfMETCorrectionType0_cfi::formula, dqm::implementation::IGetter::get(), getDbSampicChannel(), hTimingCalib_, crabWrapper::key, min_entries_, CTPPSDetId::nPath, submitPVValidationJobs::params, castor_dqm_sourceclient_file_cfg::path, AlCaHarvesting_cff::PPSTimingCalibration, AlCaHLTBitMon_QueryRunRegistry::string, simBeamSpotPI::timeOffset, and cond::service::PoolDBOutputService::writeOneIOV().

Referenced by dqmEndJob().

                                                                                     {
   PPSTimingCalibration calib = *hTimingCalib_;
 
   // book the parameters containers
   PPSTimingCalibration::ParametersMap params;
   PPSTimingCalibration::TimingMap time_info;
 
   std::unordered_map<uint32_t, dqm::reco::MonitorElement*> timeHisto;
   std::string rp_name, plane_name, ch_name, path;
   const std::string& formula = calib.formula();
 
   for (const auto& detid : detids_) {
     detid.channelName(path, CTPPSDiamondDetId::nPath);
     detid.channelName(ch_name);
     path = dqmDir_ + "/" + path + "/" + ch_name;
     const auto chid = detid.rawId();
 
     int db, sampic, channel;
     if (!getDbSampicChannel(iGetter, db, sampic, channel, path, detid))
       continue;
 
     PPSTimingCalibration::Key key;
     key.db = db;
     key.sampic = sampic;
     key.channel = channel;
 
     double timeOffset = calib.timeOffset(db, sampic, channel);
     double timePrecision = calib.timePrecision(db, sampic, channel);
     if (timeOffset == 0 && timePrecision == 0) {
       edm::LogWarning("PPSDiamondSampicTimingCalibrationPCLHarvester:dqmEndJob")
           << "No calibration found for db: " << db << " sampic: " << sampic << " channel: " << channel;
       continue;
     }
 
     int cell_ct = 0;
     while (!calib.parameters(db, sampic, channel, cell_ct).empty()) {
       auto parameters = calib.parameters(db, sampic, channel, cell_ct);
       key.cell = cell_ct;
       params[key] = parameters;
       cell_ct++;
     }
 
     key.cell = -1;
 
     time_info[key] = {timeOffset, timePrecision};
     timeHisto[chid] = iGetter.get(path);
     if (timeHisto[chid] == nullptr) {
       edm::LogWarning("PPSDiamondSampicTimingCalibrationPCLHarvester:dqmEndJob")
           << "Failed to retrieve time monitor for detid: " << detid;
       continue;
     }
 
     if (min_entries_ > 0 && timeHisto[chid]->getEntries() < min_entries_) {
       edm::LogInfo("PPSDiamondSampicTimingCalibrationPCLHarvester:dqmEndJob")
           << "Not enough entries (" << detid << "): " << timeHisto[chid]->getEntries() << " < " << min_entries_
           << ". Skipping calibration.";
       continue;
     }
 
     double new_time_offset = timeOffset - timeHisto[chid]->getMean();
     //scale x axis of the plots by calculated offset
     timeHisto[chid]->getTH1F()->GetXaxis()->Set(
         timeHisto[chid]->getTH1F()->GetXaxis()->GetNbins(),
         timeHisto[chid]->getTH1F()->GetXaxis()->GetXmin() + new_time_offset,   // new Xmin
         timeHisto[chid]->getTH1F()->GetXaxis()->GetXmax() + new_time_offset);  // new Xmax
     timeHisto[chid]->getTH1F()->ResetStats();
 
     time_info[key] = {new_time_offset, timePrecision};
   }
 
   auto calibPPS = PPSTimingCalibration(formula, params, time_info);
   // write the object
   edm::Service<cond::service::PoolDBOutputService> poolDbService;
   poolDbService->writeOneIOV(calibPPS, poolDbService->currentTime(), "PPSTimingCalibrationRcd_SAMPIC");
 }

◆ calibJson()

void PPSDiamondSampicTimingCalibrationPCLHarvester::calibJson ( DQMStore::IGetter & iGetter )

private

Definition at line 128 of file PPSDiamondSampicTimingCalibrationPCLHarvester.cc.

References dqmiodatasetharvest::db, detids_, dqmDir_, pfMETCorrectionType0_cfi::formula, dqm::implementation::IGetter::get(), getDbSampicChannel(), jsonCalibFile_, jsonOutputPath_, min_entries_, CTPPSDetId::nPath, castor_dqm_sourceclient_file_cfg::path, AlCaHLTBitMon_QueryRunRegistry::string, and to_string().

Referenced by dqmEndJob().

                                                                                       {
   std::unordered_map<uint32_t, dqm::reco::MonitorElement*> timeHisto;
   std::string ch_name, path;
 
   pt::ptree node;
   pt::read_json(jsonCalibFile_, node);
   const std::string formula = node.get<std::string>("formula");
 
   for (const auto& detid : detids_) {
     detid.channelName(path, CTPPSDiamondDetId::nPath);
     detid.channelName(ch_name);
     path = dqmDir_ + "/" + path + "/" + ch_name;
     const auto chid = detid.rawId();
 
     int db, sampic, channel;
     if (!getDbSampicChannel(iGetter, db, sampic, channel, path, detid))
       continue;
 
     int ct = 0;
     for (pt::ptree::value_type& par : node.get_child("parameters." + std::to_string(db))) {
       double new_time_offset;
       if (ct == 16 * (1 - sampic) + channel) {  //flip the calibration - sampic 1 is first in json
         double old_time_offset = par.second.get<double>("time_offset");
 
         timeHisto[chid] = iGetter.get(path);
 
         if (timeHisto[chid] == nullptr) {
           edm::LogWarning("PPSDiamondSampicTimingCalibrationPCLHarvester:dqmEndJob")
               << "Failed to retrieve time monitor for detid" << detid;
           par.second.put<double>("time_offset", old_time_offset);
           continue;
         }
 
         if (min_entries_ > 0 && timeHisto[chid]->getEntries() < min_entries_) {
           edm::LogWarning("PPSDiamondSampicTimingCalibrationPCLHarvester:dqmEndJob")
               << "Not enough entries for channel (" << detid << "): " << timeHisto[chid]->getEntries() << " < "
               << min_entries_ << ". Skipping calibration.";
           par.second.put<double>("time_offset", old_time_offset);
           continue;
         }
         new_time_offset = old_time_offset - timeHisto[chid]->getMean();
         //scale x axis of the plots by calculated offset
         timeHisto[chid]->getTH1F()->GetXaxis()->Set(
             timeHisto[chid]->getTH1F()->GetXaxis()->GetNbins(),
             timeHisto[chid]->getTH1F()->GetXaxis()->GetXmin() + new_time_offset,   // new Xmin
             timeHisto[chid]->getTH1F()->GetXaxis()->GetXmax() + new_time_offset);  // new Xmax
         timeHisto[chid]->getTH1F()->ResetStats();
 
         par.second.put<double>("time_offset", new_time_offset);
         break;
       }
       ct++;
     }
   }
   pt::write_json(jsonOutputPath_, node);
 }

◆ dqmEndJob()

void PPSDiamondSampicTimingCalibrationPCLHarvester::dqmEndJob	(	DQMStore::IBooker &	iBooker,
		DQMStore::IGetter &	iGetter
	)

overrideprivatevirtual

Implements DQMEDHarvester.

Definition at line 265 of file PPSDiamondSampicTimingCalibrationPCLHarvester.cc.

References calibDb(), calibJson(), dqm::implementation::NavigatorBase::cd(), dqmDir_, jsonCalibFile_, and dqm::implementation::NavigatorBase::setCurrentFolder().

                                                                                                                 {
   iBooker.cd();
   iBooker.setCurrentFolder(dqmDir_);
   if (jsonCalibFile_.empty())
     calibDb(iGetter);
   else
     calibJson(iGetter);
 }

◆ fillDescriptions()

void PPSDiamondSampicTimingCalibrationPCLHarvester::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 276 of file PPSDiamondSampicTimingCalibrationPCLHarvester.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                                                {
   edm::ParameterSetDescription desc;
   desc.add<std::string>("timingCalibrationTag", "GlobalTag:PPSDiamondSampicCalibration")
       ->setComment("input tag for timing calibration retrieval");
   desc.add<std::string>("dqmDir", "AlCaReco/PPSDiamondSampicTimingCalibrationPCL")
       ->setComment("input path for the various DQM plots");
   desc.add<unsigned int>("minEntries", 1)->setComment("minimal number of hits to extract calibration");
   desc.add<std::string>("jsonCalibFile", "")
       ->setComment(
           "input path for json file containing calibration, if none, calibration will be obtained from db instead");
   desc.add<std::string>("jsonOutputPath", "offset_cal.json")->setComment("output path for the new json calibration");
   descriptions.add("PPSDiamondSampicTimingCalibrationPCLHarvester", desc);
 }

◆ getDbSampicChannel()

bool PPSDiamondSampicTimingCalibrationPCLHarvester::getDbSampicChannel	(	DQMStore::IGetter &	iGetter,
		int &	db,
		int &	sampic,
		int &	channel,
		std::string	ch_name,
		CTPPSDiamondDetId	detid
	)

private

Definition at line 96 of file PPSDiamondSampicTimingCalibrationPCLHarvester.cc.

References dqmiodatasetharvest::db, dqm::implementation::IGetter::get(), and castor_dqm_sourceclient_file_cfg::path.

Referenced by calibDb(), and calibJson().

                                                                                                            {
   auto histDb = iGetter.get(path + "db");
   auto histSampic = iGetter.get(path + "sampic");
   auto histChannel = iGetter.get(path + "channel");
 
   if (histDb == nullptr) {
     edm::LogWarning("PPSDiamondSampicTimingCalibrationPCLHarvester:dqmEndJob")
         << "Failed to retrieve db for detid: " << detid;
     return false;
   }
 
   if (histSampic == nullptr) {
     edm::LogWarning("PPSDiamondSampicTimingCalibrationPCLHarvester:dqmEndJob")
         << "Failed to retrieve sampic for detid: " << detid;
     return false;
   }
 
   if (histChannel == nullptr) {
     edm::LogWarning("PPSDiamondSampicTimingCalibrationPCLHarvester:dqmEndJob")
         << "Failed to retrieve channel hwId for detid: " << detid;
     return false;
   }
 
   db = histDb->getIntValue();
   sampic = histSampic->getIntValue();
   channel = histChannel->getIntValue();
 
   return true;
 }