Inheritance diagram for OnlineBeamSpotESProducer:

Public Member Functions
	OnlineBeamSpotESProducer (const edm::ParameterSet &p)

std::shared_ptr< const BeamSpotObjects >	produce (const BeamSpotTransientObjectsRcd &)

Public Member Functions inherited from edm::ESProducer
	ESProducer ()

	ESProducer (const ESProducer &)=delete

ESProxyIndex const *	getTokenIndices (unsigned int iIndex) const

ESRecordIndex const *	getTokenRecordIndices (unsigned int iIndex) const

bool	hasMayConsumes () const noexcept

size_t	numberOfTokenIndices (unsigned int iIndex) const

ESProducer const &	operator= (const ESProducer &)=delete

SerialTaskQueueChain &	queue ()

template<typename Record >
std::optional< std::vector< ESProxyIndex > >	updateFromMayConsumes (unsigned int iIndex, const Record &iRecord) const

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &) final

	~ESProducer () noexcept(false) override

Public Member Functions inherited from edm::ESProxyFactoryProducer
	ESProxyFactoryProducer ()

	ESProxyFactoryProducer (const ESProxyFactoryProducer &)=delete

const ESProxyFactoryProducer &	operator= (const ESProxyFactoryProducer &)=delete

	~ESProxyFactoryProducer () noexcept(false) override

Public Member Functions inherited from edm::eventsetup::DataProxyProvider
void	createKeyedProxies (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)

	DataProxyProvider ()

	DataProxyProvider (const DataProxyProvider &)=delete

const ComponentDescription &	description () const

void	fillRecordsNotAllowingConcurrentIOVs (std::set< EventSetupRecordKey > &recordsNotAllowingConcurrentIOVs) const

virtual void	initConcurrentIOVs (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)

bool	isUsingRecord (const EventSetupRecordKey &key) const

KeyedProxies &	keyedProxies (const EventSetupRecordKey &iRecordKey, unsigned int iovIndex=0)

const DataProxyProvider &	operator= (const DataProxyProvider &)=delete

void	setAppendToDataLabel (const edm::ParameterSet &)

void	setDescription (const ComponentDescription &iDescription)

std::set< EventSetupRecordKey >	usingRecords () const

virtual	~DataProxyProvider () noexcept(false)

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

Static Public Member Functions inherited from edm::eventsetup::DataProxyProvider
static void	prevalidate (ConfigurationDescriptions &)

Private Member Functions
const BeamSpotOnlineObjects *	checkSingleBS (const BeamSpotOnlineObjects *bs1)

const BeamSpotOnlineObjects *	compareBS (const BeamSpotOnlineObjects bs1, const BeamSpotOnlineObjects bs2)

bool	isGoodBS (const BeamSpotOnlineObjects *bs1) const

Private Attributes
edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineHLTObjectsRcd >	bsHLTToken_

edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineLegacyObjectsRcd >	bsLegacyToken_

edm::ESGetToken< BeamSpotObjects, BeamSpotTransientObjectsRcd > const	bsToken_

BeamSpotObjects	fakeBS_

const double	sigmaXYThreshold_

const double	sigmaZThreshold_

const int	timeThreshold_

Additional Inherited Members
Protected Types inherited from edm::ESProxyFactoryProducer
using	EventSetupRecordKey = eventsetup::EventSetupRecordKey

Protected Types inherited from edm::eventsetup::DataProxyProvider
using	KeyedProxiesVector = std::vector< std::pair< DataKey, std::shared_ptr< DataProxy > >>

Protected Member Functions inherited from edm::ESProducer
template<typename T >
auto	setWhatProduced (T *iThis, const es::Label &iLabel={})

template<typename T >
auto	setWhatProduced (T iThis, const char iLabel)

template<typename T >
auto	setWhatProduced (T *iThis, const std::string &iLabel)

template<typename T , typename TDecorator >
auto	setWhatProduced (T *iThis, const TDecorator &iDec, const es::Label &iLabel={})

template<typename T , typename TReturn , typename TRecord >
auto	setWhatProduced (T iThis, TReturn(T ::iMethod)(const TRecord &), const es::Label &iLabel={})

template<typename T , typename TReturn , typename TRecord , typename TArg >
auto	setWhatProduced (T iThis, TReturn(T ::iMethod)(const TRecord &), const TArg &iDec, const es::Label &iLabel={})

template<typename TFunc >
auto	setWhatProduced (TFunc &&func, const es::Label &iLabel={})

template<typename TReturn , typename TRecord , typename TFunc , typename TDecorator >
ESConsumesCollectorT< TRecord >	setWhatProduced (TFunc &&func, TDecorator &&iDec, const es::Label &iLabel={})

void	usesResources (std::vector< std::string > const &)

Protected Member Functions inherited from edm::ESProxyFactoryProducer
template<class TFactory >
void	registerFactory (std::unique_ptr< TFactory > iFactory, const std::string &iLabel=std::string())

virtual void	registerFactoryWithKey (const EventSetupRecordKey &iRecord, std::unique_ptr< eventsetup::ProxyFactoryBase > iFactory, const std::string &iLabel=std::string())

KeyedProxiesVector	registerProxies (const EventSetupRecordKey &, unsigned int iovIndex) override

Protected Member Functions inherited from edm::eventsetup::DataProxyProvider
template<class T >
void	usingRecord ()

void	usingRecordWithKey (const EventSetupRecordKey &key)

Detailed Description

Definition at line 24 of file OnlineBeamSpotESProducer.cc.

Constructor & Destructor Documentation

◆ OnlineBeamSpotESProducer()

OnlineBeamSpotESProducer::OnlineBeamSpotESProducer ( const edm::ParameterSet & p )

Definition at line 45 of file OnlineBeamSpotESProducer.cc.

References bsHLTToken_, bsLegacyToken_, gpuPixelDoublets::cc, MillePedeFileConverter_cfg::e, fakeBS_, BeamSpotObjects::setBeamWidthX(), BeamSpotObjects::setBeamWidthY(), BeamSpotObjects::setCovariance(), BeamSpotObjects::setPosition(), BeamSpotObjects::setSigmaZ(), BeamSpotObjects::setType(), and edm::ESProducer::setWhatProduced().

     : timeThreshold_(p.getParameter<int>("timeThreshold")),
       sigmaZThreshold_(p.getParameter<double>("sigmaZThreshold")),
       sigmaXYThreshold_(p.getParameter<double>("sigmaXYThreshold") * 1E-4) {
   auto cc = setWhatProduced(this);
 
   fakeBS_.setBeamWidthX(0.1);
   fakeBS_.setBeamWidthY(0.1);
   fakeBS_.setSigmaZ(15.);
   fakeBS_.setPosition(0.0001, 0.0001, 0.0001);
   fakeBS_.setType(-1);
   // Set diagonal covariance, i.e. errors on the parameters
   fakeBS_.setCovariance(0, 0, 5e-10);
   fakeBS_.setCovariance(1, 1, 5e-10);
   fakeBS_.setCovariance(2, 2, 0.002);
   fakeBS_.setCovariance(3, 3, 0.002);
   fakeBS_.setCovariance(4, 4, 5e-11);
   fakeBS_.setCovariance(5, 5, 5e-11);
   fakeBS_.setCovariance(6, 6, 1e-09);
 
   bsHLTToken_ = cc.consumesFrom<BeamSpotOnlineObjects, BeamSpotOnlineHLTObjectsRcd>();
   bsLegacyToken_ = cc.consumesFrom<BeamSpotOnlineObjects, BeamSpotOnlineLegacyObjectsRcd>();
 }

Member Function Documentation

◆ checkSingleBS()

const BeamSpotOnlineObjects * OnlineBeamSpotESProducer::checkSingleBS ( const BeamSpotOnlineObjects * bs1 )

private

Definition at line 132 of file OnlineBeamSpotESProducer.cc.

References submitPVResolutionJobs::count, BeamSpotOnlineObjects::creationTime(), getRunInfo::hours, isGoodBS(), submitPVValidationJobs::now, and timeThreshold_.

Referenced by produce().

                                                                                                      {
   // Current time to be compared with the one read from the payload
   auto currentTime =
       std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::system_clock::now().time_since_epoch());
 
   // Get the beamspot creation time and compute the time difference wrt currentTime
   auto bs1time = std::chrono::microseconds(bs1->creationTime());
   auto diffBStime1 = (currentTime - bs1time).count();
 
   // Convert timeThreshold_ from hours to microseconds for comparison
   auto limitTime = std::chrono::microseconds((std::chrono::hours)timeThreshold_).count();
 
   // Check that the BS is within the timeThreshold, converges and passes the sigmaZthreshold
   if (diffBStime1 < limitTime && isGoodBS(bs1)) {
     return bs1;
   } else {
     return nullptr;
   }
 }

◆ compareBS()

const BeamSpotOnlineObjects * OnlineBeamSpotESProducer::compareBS	(	const BeamSpotOnlineObjects *	bs1,
		const BeamSpotOnlineObjects *	bs2
	)

private

Definition at line 78 of file OnlineBeamSpotESProducer.cc.

References submitPVResolutionJobs::count, BeamSpotOnlineObjects::creationTime(), getRunInfo::hours, isGoodBS(), submitPVValidationJobs::now, BeamSpotObjects::sigmaZ(), and timeThreshold_.

Referenced by produce().

                                                                                                    {
   // Current time to be compared with the one read from the payload
   auto currentTime =
       std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::system_clock::now().time_since_epoch());
 
   // Get two beamspot creation times and compute the time difference wrt currentTime
   auto bs1time = std::chrono::microseconds(bs1->creationTime());
   auto diffBStime1 = (currentTime - bs1time).count();
   auto bs2time = std::chrono::microseconds(bs2->creationTime());
   auto diffBStime2 = (currentTime - bs2time).count();
 
   // Convert timeThreshold_ from hours to microseconds for comparison
   auto limitTime = std::chrono::microseconds((std::chrono::hours)timeThreshold_).count();
 
   // Logic to choose between the two BeamSpots:
   // 1. If both BS are older than limitTime retun fake BS
   // 2. If only one BS is newer than limitTime return it only if
   //     it passes isGoodBS (checks on sigmaZ, sigmaXY and fit convergence)
   // 3. If both are newer than the limit threshold return the BS that
   //     passes isGoodBS and has larger sigmaZ
   if (diffBStime1 > limitTime && diffBStime2 > limitTime) {
     edm::LogWarning("OnlineBeamSpotESProducer")
         << "Defaulting to fake (fallback to PCL) because both payloads are too old.";
     return nullptr;
   } else if (diffBStime2 > limitTime) {
     if (isGoodBS(bs1)) {
       return bs1;
     } else {
       edm::LogWarning("OnlineBeamSpotESProducer") << "Defaulting to fake (fallback to PCL) because the legacy Beam "
                                                      "Spot is not suitable and HLT one is too old.";
       return nullptr;
     }
   } else if (diffBStime1 > limitTime) {
     if (isGoodBS(bs2)) {
       return bs2;
     } else {
       edm::LogWarning("OnlineBeamSpotESProducer") << "Defaulting to fake (fallback to PCL) because the HLT Beam Spot "
                                                      "is not suitable and the legacy one too old.";
       return nullptr;
     }
   } else {
     if (bs1->sigmaZ() > bs2->sigmaZ() && isGoodBS(bs1)) {
       return bs1;
     } else if (bs2->sigmaZ() >= bs1->sigmaZ() && isGoodBS(bs2)) {
       return bs2;
     } else {
       edm::LogWarning("OnlineBeamSpotESProducer") << "Defaulting to fake (fallback to PCL) because despite both "
                                                      "payloads are young enough, none has passed the fit sanity checks";
       return nullptr;
     }
   }
 }

◆ fillDescriptions()

void OnlineBeamSpotESProducer::fillDescriptions ( edm::ConfigurationDescriptions & desc )

static

Definition at line 70 of file OnlineBeamSpotESProducer.cc.

References edm::ParameterSetDescription::add(), submitPVResolutionJobs::desc, and edm::ParameterDescriptionNode::setComment().

                                                                                   {
   edm::ParameterSetDescription dsc;
   dsc.add<int>("timeThreshold", 48)->setComment("hours");
   dsc.add<double>("sigmaZThreshold", 2.)->setComment("cm");
   dsc.add<double>("sigmaXYThreshold", 4.)->setComment("um");
   desc.addWithDefaultLabel(dsc);
 }

◆ isGoodBS()

bool OnlineBeamSpotESProducer::isGoodBS ( const BeamSpotOnlineObjects * bs1 ) const

private

Definition at line 153 of file OnlineBeamSpotESProducer.cc.

References BeamSpotObjects::beamType(), BeamSpotObjects::beamWidthX(), BeamSpotObjects::beamWidthY(), sigmaXYThreshold_, BeamSpotObjects::sigmaZ(), sigmaZThreshold_, and reco::BeamSpot::Tracker.

Referenced by checkSingleBS(), and compareBS().

                                                                               {
   if (bs1->sigmaZ() > sigmaZThreshold_ && bs1->beamType() == reco::BeamSpot::Tracker &&
       bs1->beamWidthX() > sigmaXYThreshold_ && bs1->beamWidthY() > sigmaXYThreshold_)
     return true;
   else
     return false;
 }

◆ produce()

std::shared_ptr< const BeamSpotObjects > OnlineBeamSpotESProducer::produce ( const BeamSpotTransientObjectsRcd & iRecord )

Definition at line 161 of file OnlineBeamSpotESProducer.cc.

References bsHLTToken_, bsLegacyToken_, checkSingleBS(), compareBS(), fakeBS_, and edm::eventsetup::DependentRecordImplementation< RecordT, ListT >::tryToGetRecord().

                                                                                                                  {
   auto legacyRec = iRecord.tryToGetRecord<BeamSpotOnlineLegacyObjectsRcd>();
   auto hltRec = iRecord.tryToGetRecord<BeamSpotOnlineHLTObjectsRcd>();
   if (not legacyRec and not hltRec) {
     edm::LogWarning("OnlineBeamSpotESProducer")
         << "None of the Beam Spots in ES are available! \n returning a fake one (fallback to PCL).";
     return std::shared_ptr<const BeamSpotObjects>(&fakeBS_, edm::do_nothing_deleter());
   }
 
   const BeamSpotOnlineObjects* best;
   if (legacyRec and hltRec) {
     best = compareBS(&legacyRec->get(bsLegacyToken_), &hltRec->get(bsHLTToken_));
   } else if (legacyRec) {
     best = checkSingleBS(&legacyRec->get(bsLegacyToken_));
   } else {
     best = checkSingleBS(&hltRec->get(bsHLTToken_));
   }
   if (best) {
     return std::shared_ptr<const BeamSpotObjects>(best, edm::do_nothing_deleter());
   } else {
     return std::shared_ptr<const BeamSpotObjects>(&fakeBS_, edm::do_nothing_deleter());
     edm::LogWarning("OnlineBeamSpotESProducer")
         << "None of the Online BeamSpots in the ES is suitable, \n returning a fake one(fallback to PCL).";
   }
 };