#include <RecoVertex/BeamSpotProducer/plugins/BeamSpotCompatibilityChecker.cc>

Inheritance diagram for BeamSpotCompatibilityChecker:

Public Member Functions
void	analyze (edm::StreamID, edm::Event const &, edm::EventSetup const &) const final

	BeamSpotCompatibilityChecker (const edm::ParameterSet &)

	~BeamSpotCompatibilityChecker () override=default

Public Member Functions inherited from edm::global::EDAnalyzer<>
	EDAnalyzer ()=default

	EDAnalyzer (const EDAnalyzer &)=delete

const EDAnalyzer &	operator= (const EDAnalyzer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

bool	wantsStreamLuminosityBlocks () const final

bool	wantsStreamRuns () const final

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

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

	~EDAnalyzerBase () 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 std::array< float, 6 >	compareBS (const reco::BeamSpot &BSA, const reco::BeamSpot &BSB)

static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Attributes
edm::ESGetToken< BeamSpotObjects, BeamSpotObjectsRcd >	bsFromDBToken_

const edm::EDGetTokenT< reco::BeamSpot >	bsFromEventToken_

edm::EDGetTokenT< reco::BeamSpot >	dbBSfromEventToken_

const bool	dbFromEvent_

const double	throwingThreshold_

const bool	verbose_

const double	warningThreshold_

Static Private Attributes
static constexpr int	cmToum = 10000

Additional Inherited Members
Public Types inherited from edm::global::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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)

Detailed Description

Description: Class to check the compatibilty between the BeamSpot payload in the database and the one in the event

Implementation: Makes use of the Significance struct to establish how compatible are the data members of the two BeamSpots in input

Definition at line 78 of file BeamSpotCompatibilityChecker.cc.

Constructor & Destructor Documentation

◆ BeamSpotCompatibilityChecker()

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

explicit

Definition at line 102 of file BeamSpotCompatibilityChecker.cc.

References bsFromDBToken_, dbBSfromEventToken_, dbFromEvent_, Exception, edm::ParameterSet::getParameter(), throwingThreshold_, and warningThreshold_.

     : warningThreshold_(iConfig.getParameter<double>("warningThr")),
       throwingThreshold_(iConfig.getParameter<double>("errorThr")),
       verbose_(iConfig.getUntrackedParameter<bool>("verbose", false)),
       dbFromEvent_(iConfig.getParameter<bool>("dbFromEvent")),
       bsFromEventToken_(consumes<reco::BeamSpot>(iConfig.getParameter<edm::InputTag>("bsFromEvent"))) {
   //now do what ever initialization is needed
   if (warningThreshold_ > throwingThreshold_) {
     throw cms::Exception("ConfigurationError")
         << __PRETTY_FUNCTION__ << "\n Warning threshold (" << warningThreshold_
         << ") cannot be smaller than the throwing threshold (" << throwingThreshold_ << ")" << std::endl;
   }
   if (dbFromEvent_) {
     edm::LogWarning("BeamSpotCompatibilityChecker")
         << "!!!! Warning !!!\nThe Database Beam Spot is going to be taken from the Event via BeamSpotProducer!";
     dbBSfromEventToken_ = consumes<reco::BeamSpot>(iConfig.getParameter<edm::InputTag>("bsFromDB"));
   } else {
     bsFromDBToken_ = esConsumes<BeamSpotObjects, BeamSpotObjectsRcd>();
   }
 }

◆ ~BeamSpotCompatibilityChecker()

BeamSpotCompatibilityChecker::~BeamSpotCompatibilityChecker ( )

overridedefault

Member Function Documentation

◆ analyze()

void BeamSpotCompatibilityChecker::analyze	(	edm::StreamID	sid,
		edm::Event const &	iEvent,
		edm::EventSetup const &	iSetup
	)		const

finalvirtual

Implements edm::global::EDAnalyzerBase.

Definition at line 128 of file BeamSpotCompatibilityChecker.cc.

References funct::abs(), align::BeamSpot, BeamSpotObjects::beamWidthX(), reco::BeamSpot::BeamWidthX(), reco::BeamSpot::BeamWidthY(), bsFromDBToken_, bsFromEventToken_, cmToum, compareBS(), BeamSpotObjects::covariance(), dbBSfromEventToken_, dbFromEvent_, reco::BeamSpot::dimension, BeamSpotObjects::dxdz(), BeamSpotObjects::dydz(), Exception, edm::EventSetup::getHandle(), mps_fire::i, iEvent, dqmiolumiharvest::j, SummaryClient_cfi::labels, makeMuonMisalignmentScenario::matrix, mps_check::msg, edm::ESHandle< T >::product(), BeamSpotObjects::sigmaZ(), reco::BeamSpot::sigmaZ(), AlCaHLTBitMon_QueryRunRegistry::string, throwingThreshold_, to_string(), verbose_, warningThreshold_, BeamSpotObjects::x(), reco::BeamSpot::x0(), BeamSpotObjects::y(), reco::BeamSpot::y0(), BeamSpotObjects::z(), and reco::BeamSpot::z0().

                                                                               {
   using namespace edm;
   reco::BeamSpot spotEvent, spotDB;
 
   edm::Handle<reco::BeamSpot> beamSpotFromEventHandle;
   iEvent.getByToken(bsFromEventToken_, beamSpotFromEventHandle);
   spotEvent = *beamSpotFromEventHandle;
 
   double evt_BSx0 = spotEvent.x0();
   double evt_BSy0 = spotEvent.y0();
   double evt_BSz0 = spotEvent.z0();
   double evt_Beamsigmaz = spotEvent.sigmaZ();
   double evt_BeamWidthX = spotEvent.BeamWidthX();
   double evt_BeamWidthY = spotEvent.BeamWidthY();
 
   if (!dbFromEvent_) {
     edm::ESHandle<BeamSpotObjects> beamhandle = iSetup.getHandle(bsFromDBToken_);
     const BeamSpotObjects* aSpot = beamhandle.product();
 
     // translate from BeamSpotObjects to reco::BeamSpot
     reco::BeamSpot::Point apoint(aSpot->x(), aSpot->y(), aSpot->z());
 
     reco::BeamSpot::CovarianceMatrix matrix;
     for (int i = 0; i < reco::BeamSpot::dimension; ++i) {
       for (int j = 0; j < reco::BeamSpot::dimension; ++j) {
         matrix(i, j) = aSpot->covariance(i, j);
       }
     }
 
     // this assume beam width same in x and y
     spotDB = reco::BeamSpot(apoint, aSpot->sigmaZ(), aSpot->dxdz(), aSpot->dydz(), aSpot->beamWidthX(), matrix);
   } else {
     // take the DB beamspot from the event (different label)
     edm::Handle<reco::BeamSpot> beamSpotFromDBHandle;
     iEvent.getByToken(dbBSfromEventToken_, beamSpotFromDBHandle);
     spotDB = *beamSpotFromDBHandle;
   }
 
   double db_BSx0 = spotDB.x0();
   double db_BSy0 = spotDB.y0();
   double db_BSz0 = spotDB.z0();
   double db_Beamsigmaz = spotDB.sigmaZ();
   double db_BeamWidthX = spotDB.BeamWidthX();
   double db_BeamWidthY = spotDB.BeamWidthY();
 
   double deltaX0 = evt_BSx0 - db_BSx0;
   double deltaY0 = evt_BSy0 - db_BSy0;
   double deltaZ0 = evt_BSz0 - db_BSz0;
   double deltaSigmaX = evt_BeamWidthX - db_BeamWidthX;
   double deltaSigmaY = evt_BeamWidthY - db_BeamWidthY;
   double deltaSigmaZ = evt_Beamsigmaz - db_Beamsigmaz;
 
   if (verbose_) {
     edm::LogPrint("BeamSpotCompatibilityChecker") << "BS from Event: \n" << spotEvent << std::endl;
     edm::LogPrint("BeamSpotCompatibilityChecker") << "BS from DB: \n" << spotDB << std::endl;
   }
 
   auto significances = compareBS(spotDB, spotEvent);
   std::vector<std::string> labels = {"x0", "y0", "z0", "sigmaX", "sigmaY", "sigmaZ"};
 
   std::string msg = " |delta X0|=" + std::to_string(std::abs(deltaX0) * cmToum) +
                     " um |delta Y0|=" + std::to_string(std::abs(deltaY0) * cmToum) +
                     " um |delta Z0|=" + std::to_string(std::abs(deltaZ0) * cmToum) +
                     " um |delta sigmaX|=" + std::to_string(std::abs(deltaSigmaX) * cmToum) +
                     " um |delta sigmaY|=" + std::to_string(std::abs(deltaSigmaY) * cmToum) +
                     " um |delta sigmaZ|=" + std::to_string(std::abs(deltaSigmaZ)) + "cm";
   if (verbose_) {
     edm::LogPrint("BeamSpotCompatibilityChecker") << msg.c_str() << std::endl;
   }
 
   for (unsigned int i = 0; i < 3; i++) {
     auto sig = significances.at(i);
     if (sig > throwingThreshold_) {
       edm::LogError("BeamSpotCompatibilityChecker") << msg.c_str() << std::endl;
       throw cms::Exception("BeamSpotCompatibilityChecker")
           << "[" << __PRETTY_FUNCTION__ << "] \n DB-Event BeamSpot " << labels.at(i) << " distance sigificance " << sig
           << ", exceeds the threshold of " << throwingThreshold_ << "!" << std::endl;
     } else if (sig > warningThreshold_) {
       edm::LogWarning("BeamSpotCompatibilityChecker") << msg.c_str() << std::endl;
       edm::LogWarning("BeamSpotCompatibilityChecker")
           << "[" << __PRETTY_FUNCTION__ << "]  \n  DB-Event BeamSpot " << labels.at(i) << " distance significance "
           << sig << ", exceeds the threshold of " << warningThreshold_ << "!" << std::endl;
     }
   }
 }

◆ compareBS()

std::array< float, 6 > BeamSpotCompatibilityChecker::compareBS	(	const reco::BeamSpot &	BSA,
		const reco::BeamSpot &	BSB
	)

static

Definition at line 216 of file BeamSpotCompatibilityChecker.cc.

References reco::BeamSpot::BeamWidthX(), reco::BeamSpot::BeamWidthXError(), reco::BeamSpot::BeamWidthY(), reco::BeamSpot::BeamWidthYError(), runTheMatrix::ret, reco::BeamSpot::sigmaZ(), reco::BeamSpot::sigmaZ0Error(), reco::BeamSpot::x0(), reco::BeamSpot::x0Error(), reco::BeamSpot::y0(), reco::BeamSpot::y0Error(), reco::BeamSpot::z0(), and reco::BeamSpot::z0Error().

Referenced by analyze().

                                                                                             {
   auto xS = Significance(beamSpotA.x0(), beamSpotB.x0(), beamSpotA.x0Error(), beamSpotB.x0Error());
   auto yS = Significance(beamSpotA.y0(), beamSpotB.y0(), beamSpotA.y0Error(), beamSpotB.y0Error());
   auto zS = Significance(beamSpotA.z0(), beamSpotB.z0(), beamSpotA.z0Error(), beamSpotB.z0Error());
   auto xWS = Significance(
       beamSpotA.BeamWidthX(), beamSpotB.BeamWidthX(), beamSpotA.BeamWidthXError(), beamSpotB.BeamWidthXError());
   auto yWS = Significance(
       beamSpotA.BeamWidthY(), beamSpotB.BeamWidthY(), beamSpotA.BeamWidthYError(), beamSpotB.BeamWidthYError());
   auto zWS = Significance(beamSpotA.sigmaZ(), beamSpotB.sigmaZ(), beamSpotA.sigmaZ0Error(), beamSpotB.sigmaZ0Error());
 
   std::array<float, 6> ret = {
       {xS.getSig(false), yS.getSig(false), zS.getSig(false), xWS.getSig(false), yWS.getSig(false), zWS.getSig(false)}};
   return ret;
 }

◆ fillDescriptions()

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

static

Definition at line 233 of file BeamSpotCompatibilityChecker.cc.

References edm::ConfigurationDescriptions::addWithDefaultLabel(), submitPVResolutionJobs::desc, and ProducerED_cfi::InputTag.

                                                                                               {
   edm::ParameterSetDescription desc;
   desc.add<double>("warningThr", 1.)->setComment("Threshold on the signficances to emit a warning");
   desc.add<double>("errorThr", 3.)->setComment("Threshold on the signficances to abort the job");
   desc.addUntracked<bool>("verbose", false)->setComment("verbose output");
   desc.add<edm::InputTag>("bsFromEvent", edm::InputTag(""))
       ->setComment("edm::InputTag on the BeamSpot from the Event (Reference)");
   desc.add<bool>("dbFromEvent", false)
       ->setComment("Switch to take the (target) DB beamspot from the event instead of the EventSetup");
   desc.add<edm::InputTag>("bsFromDB", edm::InputTag(""))
       ->setComment("edm::InputTag on the BeamSpot from the Event (Target)\n To be used only if dbFromEvent is True");
   descriptions.addWithDefaultLabel(desc);
 }