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)

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

edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineLegacyObjectsRcd >	bsLegacyToken_

const edm::ESGetToken< BeamSpotObjects, BeamSpotTransientObjectsRcd >	bsToken_

BeamSpotObjects	fakeBS_

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 char iLabel)

template<typename T >
auto	setWhatProduced (T *iThis, const es::Label &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 >
ESConsumesCollectorT< TRecord >	setWhatProduced (T iThis, TReturn(T ::iMethod)(const TRecord &), const TArg &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 43 of file OnlineBeamSpotESProducer.cc.

     : timeThreshold_(p.getParameter<int>("timeThreshold")),
       sigmaZThreshold_(p.getParameter<double>("sigmaZThreshold")) {
   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);
  
   bsHLTToken_ = cc.consumesFrom<BeamSpotOnlineObjects, BeamSpotOnlineHLTObjectsRcd>();
   bsLegacyToken_ = cc.consumesFrom<BeamSpotOnlineObjects, BeamSpotOnlineLegacyObjectsRcd>();
 }

References bsHLTToken_, bsLegacyToken_, fakeBS_, BeamSpotObjects::SetBeamWidthX(), BeamSpotObjects::SetBeamWidthY(), BeamSpotObjects::SetPosition(), BeamSpotObjects::SetSigmaZ(), BeamSpotObjects::SetType(), and edm::ESProducer::setWhatProduced().

Member Function Documentation

◆ checkSingleBS()

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

private

Definition at line 119 of file OnlineBeamSpotESProducer.cc.

                                                                                                      {
   // 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->GetCreationTime());
   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 && bs1->GetSigmaZ() > sigmaZThreshold_ && bs1->GetBeamType() == 2) {
     return bs1;
   } else {
     return nullptr;
   }
 }

References submitPVResolutionJobs::count, BeamSpotObjects::GetBeamType(), BeamSpotOnlineObjects::GetCreationTime(), getRunInfo::hours, submitPVValidationJobs::now, sigmaZThreshold_, and timeThreshold_.

Referenced by produce().

◆ compareBS()

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

private

Definition at line 66 of file OnlineBeamSpotESProducer.cc.

                                                                                                    {
   // 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->GetCreationTime());
   auto diffBStime1 = (currentTime - bs1time).count();
   auto bs2time = std::chrono::microseconds(bs2->GetCreationTime());
   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 has
   //    sigmaZ larger than sigmaZthreshold_ and the fit converged (BeamType 2)
   // 3. If both are newer than the limit threshold return
   //    the BS that converged and has larger sigmaZ
   if (diffBStime1 > limitTime && diffBStime2 > limitTime) {
     edm::LogInfo("OnlineBeamSpotESProducer") << "Defaulting to fake becuase both payloads are too old.";
     return nullptr;
   } else if (diffBStime2 > limitTime) {
     if (bs1->GetSigmaZ() > sigmaZThreshold_ && bs1->GetBeamType() == 2) {
       return bs1;
     } else {
       edm::LogInfo("OnlineBeamSpotESProducer")
           << "Defaulting to fake because the legacy Beam Spot is not suitable and HLT one is too old.";
       return nullptr;
     }
   } else if (diffBStime1 > limitTime) {
     if (bs2->GetSigmaZ() > sigmaZThreshold_ && bs2->GetBeamType() == 2) {
       return bs2;
     } else {
       edm::LogInfo("OnlineBeamSpotESProducer")
           << "Defaulting to fake because the HLT Beam Spot is not suitable and the legacy one too old.";
       return nullptr;
     }
   } else {
     if (bs1->GetSigmaZ() > bs2->GetSigmaZ() && bs1->GetBeamType() == 2) {
       return bs1;
     } else if (bs2->GetSigmaZ() >= bs1->GetSigmaZ() && bs2->GetBeamType() == 2) {
       return bs2;
     } else {
       edm::LogInfo("OnlineBeamSpotESProducer")
           << "Defaulting to fake because despite both payloads are young enough, none has the right BeamType.";
       return nullptr;
     }
   }
 }

References submitPVResolutionJobs::count, BeamSpotObjects::GetBeamType(), BeamSpotOnlineObjects::GetCreationTime(), BeamSpotObjects::GetSigmaZ(), getRunInfo::hours, submitPVValidationJobs::now, sigmaZThreshold_, and timeThreshold_.

Referenced by produce().

◆ fillDescriptions()

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

static

Definition at line 59 of file OnlineBeamSpotESProducer.cc.

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

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

◆ produce()

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

Definition at line 139 of file OnlineBeamSpotESProducer.cc.

                                                                                                                  {
   auto legacyRec = iRecord.tryToGetRecord<BeamSpotOnlineLegacyObjectsRcd>();
   auto hltRec = iRecord.tryToGetRecord<BeamSpotOnlineHLTObjectsRcd>();
   if (not legacyRec and not hltRec) {
     edm::LogInfo("OnlineBeamSpotESProducer") << "None of the Beam Spots in ES are available! \n returning a fake one.";
     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::LogInfo("OnlineBeamSpotESProducer")
         << "None of the Online BeamSpots in the ES is suitable, \n returning a fake one. ";
   }
 };