CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
OnlineBeamSpotESProducer Class Reference
Inheritance diagram for OnlineBeamSpotESProducer:
edm::ESProducer edm::ESProxyFactoryProducer edm::eventsetup::DataProxyProvider

Public Member Functions

 OnlineBeamSpotESProducer (const edm::ParameterSet &p)
 
std::shared_ptr< const BeamSpotObjectsproduce (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
 
SerialTaskQueueChainqueue ()
 
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 ESProxyFactoryProduceroperator= (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 ComponentDescriptiondescription () const
 
void fillRecordsNotAllowingConcurrentIOVs (std::set< EventSetupRecordKey > &recordsNotAllowingConcurrentIOVs) const
 
virtual void initConcurrentIOVs (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
 
bool isUsingRecord (const EventSetupRecordKey &key) const
 
KeyedProxieskeyedProxies (const EventSetupRecordKey &iRecordKey, unsigned int iovIndex=0)
 
const DataProxyProvideroperator= (const DataProxyProvider &)=delete
 
void setAppendToDataLabel (const edm::ParameterSet &)
 
void setDescription (const ComponentDescription &iDescription)
 
std::set< EventSetupRecordKeyusingRecords () 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 BeamSpotOnlineObjectscheckSingleBS (const BeamSpotOnlineObjects *bs1)
 
const BeamSpotOnlineObjectscompareBS (const BeamSpotOnlineObjects *bs1, const BeamSpotOnlineObjects *bs2)
 

Private Attributes

edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineHLTObjectsRcdbsHLTToken_
 
edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineLegacyObjectsRcdbsLegacyToken_
 
edm::ESGetToken< BeamSpotObjects, BeamSpotTransientObjectsRcd > const 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 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 >
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.

References bsHLTToken_, bsLegacyToken_, fakeBS_, BeamSpotObjects::setBeamWidthX(), BeamSpotObjects::setBeamWidthY(), BeamSpotObjects::setPosition(), BeamSpotObjects::setSigmaZ(), BeamSpotObjects::setType(), and edm::ESProducer::setWhatProduced().

45  : timeThreshold_(p.getParameter<int>("timeThreshold")),
46  sigmaZThreshold_(p.getParameter<double>("sigmaZThreshold")) {
47  auto cc = setWhatProduced(this);
48 
51  fakeBS_.setSigmaZ(15.);
52  fakeBS_.setPosition(0.0001, 0.0001, 0.0001);
53  fakeBS_.setType(-1);
54 
57 }
auto setWhatProduced(T *iThis, const es::Label &iLabel={})
Definition: ESProducer.h:163
edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineHLTObjectsRcd > bsHLTToken_
void setType(int type)
set beam type
edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineLegacyObjectsRcd > bsLegacyToken_
void setSigmaZ(double val)
set sigma Z, RMS bunch length
void setPosition(double x, double y, double z)
set XYZ position
void setBeamWidthX(double val)
set average transverse beam width X
void setBeamWidthY(double val)
set average transverse beam width Y

Member Function Documentation

◆ checkSingleBS()

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

Definition at line 119 of file OnlineBeamSpotESProducer.cc.

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

Referenced by produce().

119  {
120  // Current time to be compared with the one read from the payload
121  auto currentTime =
122  std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::system_clock::now().time_since_epoch());
123 
124  // Get the beamspot creation time and compute the time difference wrt currentTime
125  auto bs1time = std::chrono::microseconds(bs1->creationTime());
126  auto diffBStime1 = (currentTime - bs1time).count();
127 
128  // Convert timeThreshold_ from hours to microseconds for comparison
129  auto limitTime = std::chrono::microseconds((std::chrono::hours)timeThreshold_).count();
130 
131  // Check that the BS is within the timeThreshold, converges and passes the sigmaZthreshold
132  if (diffBStime1 < limitTime && bs1->sigmaZ() > sigmaZThreshold_ && bs1->beamType() == 2) {
133  return bs1;
134  } else {
135  return nullptr;
136  }
137 }
cond::Time_t creationTime() const
int beamType() const
get beam type

◆ compareBS()

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

Definition at line 66 of file OnlineBeamSpotESProducer.cc.

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

Referenced by produce().

67  {
68  // Current time to be compared with the one read from the payload
69  auto currentTime =
70  std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::system_clock::now().time_since_epoch());
71 
72  // Get two beamspot creation times and compute the time difference wrt currentTime
73  auto bs1time = std::chrono::microseconds(bs1->creationTime());
74  auto diffBStime1 = (currentTime - bs1time).count();
75  auto bs2time = std::chrono::microseconds(bs2->creationTime());
76  auto diffBStime2 = (currentTime - bs2time).count();
77 
78  // Convert timeThreshold_ from hours to microseconds for comparison
79  auto limitTime = std::chrono::microseconds((std::chrono::hours)timeThreshold_).count();
80 
81  // Logic to choose between the two BeamSpots:
82  // 1. If both BS are older than limitTime retun fake BS
83  // 2. If only one BS is newer than limitTime return it only if it has
84  // sigmaZ larger than sigmaZthreshold_ and the fit converged (BeamType 2)
85  // 3. If both are newer than the limit threshold return
86  // the BS that converged and has larger sigmaZ
87  if (diffBStime1 > limitTime && diffBStime2 > limitTime) {
88  edm::LogInfo("OnlineBeamSpotESProducer") << "Defaulting to fake because both payloads are too old.";
89  return nullptr;
90  } else if (diffBStime2 > limitTime) {
91  if (bs1->sigmaZ() > sigmaZThreshold_ && bs1->beamType() == 2) {
92  return bs1;
93  } else {
94  edm::LogInfo("OnlineBeamSpotESProducer")
95  << "Defaulting to fake because the legacy Beam Spot is not suitable and HLT one is too old.";
96  return nullptr;
97  }
98  } else if (diffBStime1 > limitTime) {
99  if (bs2->sigmaZ() > sigmaZThreshold_ && bs2->beamType() == 2) {
100  return bs2;
101  } else {
102  edm::LogInfo("OnlineBeamSpotESProducer")
103  << "Defaulting to fake because the HLT Beam Spot is not suitable and the legacy one too old.";
104  return nullptr;
105  }
106  } else {
107  if (bs1->sigmaZ() > bs2->sigmaZ() && bs1->beamType() == 2) {
108  return bs1;
109  } else if (bs2->sigmaZ() >= bs1->sigmaZ() && bs2->beamType() == 2) {
110  return bs2;
111  } else {
112  edm::LogInfo("OnlineBeamSpotESProducer")
113  << "Defaulting to fake because despite both payloads are young enough, none has the right BeamType.";
114  return nullptr;
115  }
116  }
117 }
cond::Time_t creationTime() const
int beamType() const
get beam type
Log< level::Info, false > LogInfo
double sigmaZ() const
get sigma Z, RMS bunch length

◆ fillDescriptions()

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

Definition at line 59 of file OnlineBeamSpotESProducer.cc.

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

59  {
61  dsc.add<int>("timeThreshold", 48)->setComment("hours");
62  dsc.add<double>("sigmaZThreshold", 2.)->setComment("cm");
63  desc.addWithDefaultLabel(dsc);
64 }
void setComment(std::string const &value)
ParameterDescriptionBase * add(U const &iLabel, T const &value)

◆ produce()

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

Definition at line 139 of file OnlineBeamSpotESProducer.cc.

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

139  {
140  auto legacyRec = iRecord.tryToGetRecord<BeamSpotOnlineLegacyObjectsRcd>();
141  auto hltRec = iRecord.tryToGetRecord<BeamSpotOnlineHLTObjectsRcd>();
142  if (not legacyRec and not hltRec) {
143  edm::LogInfo("OnlineBeamSpotESProducer") << "None of the Beam Spots in ES are available! \n returning a fake one.";
144  return std::shared_ptr<const BeamSpotObjects>(&fakeBS_, edm::do_nothing_deleter());
145  }
146 
147  const BeamSpotOnlineObjects* best;
148  if (legacyRec and hltRec) {
149  best = compareBS(&legacyRec->get(bsLegacyToken_), &hltRec->get(bsHLTToken_));
150  } else if (legacyRec) {
151  best = checkSingleBS(&legacyRec->get(bsLegacyToken_));
152  } else {
153  best = checkSingleBS(&hltRec->get(bsHLTToken_));
154  }
155  if (best) {
156  return std::shared_ptr<const BeamSpotObjects>(best, edm::do_nothing_deleter());
157  } else {
158  return std::shared_ptr<const BeamSpotObjects>(&fakeBS_, edm::do_nothing_deleter());
159  edm::LogInfo("OnlineBeamSpotESProducer")
160  << "None of the Online BeamSpots in the ES is suitable, \n returning a fake one. ";
161  }
162 };
const BeamSpotOnlineObjects * checkSingleBS(const BeamSpotOnlineObjects *bs1)
edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineHLTObjectsRcd > bsHLTToken_
const BeamSpotOnlineObjects * compareBS(const BeamSpotOnlineObjects *bs1, const BeamSpotOnlineObjects *bs2)
edm::ESGetToken< BeamSpotOnlineObjects, BeamSpotOnlineLegacyObjectsRcd > bsLegacyToken_
Log< level::Info, false > LogInfo

Member Data Documentation

◆ bsHLTToken_

edm::ESGetToken<BeamSpotOnlineObjects, BeamSpotOnlineHLTObjectsRcd> OnlineBeamSpotESProducer::bsHLTToken_
private

Definition at line 35 of file OnlineBeamSpotESProducer.cc.

Referenced by OnlineBeamSpotESProducer(), and produce().

◆ bsLegacyToken_

edm::ESGetToken<BeamSpotOnlineObjects, BeamSpotOnlineLegacyObjectsRcd> OnlineBeamSpotESProducer::bsLegacyToken_
private

Definition at line 36 of file OnlineBeamSpotESProducer.cc.

Referenced by OnlineBeamSpotESProducer(), and produce().

◆ bsToken_

edm::ESGetToken<BeamSpotObjects, BeamSpotTransientObjectsRcd> const OnlineBeamSpotESProducer::bsToken_
private

Definition at line 34 of file OnlineBeamSpotESProducer.cc.

◆ fakeBS_

BeamSpotObjects OnlineBeamSpotESProducer::fakeBS_
private

Definition at line 38 of file OnlineBeamSpotESProducer.cc.

Referenced by OnlineBeamSpotESProducer(), and produce().

◆ sigmaZThreshold_

const double OnlineBeamSpotESProducer::sigmaZThreshold_
private

Definition at line 40 of file OnlineBeamSpotESProducer.cc.

Referenced by checkSingleBS(), and compareBS().

◆ timeThreshold_

const int OnlineBeamSpotESProducer::timeThreshold_
private

Definition at line 39 of file OnlineBeamSpotESProducer.cc.

Referenced by checkSingleBS(), and compareBS().