CMS 3D CMS Logo

List of all members | Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
CTPPSOpticalFunctionsESSource Class Reference

Loads optical functions from ROOT files. More...

Inheritance diagram for CTPPSOpticalFunctionsESSource:
edm::ESProducer edm::EventSetupRecordIntervalFinder edm::ESProxyFactoryProducer edm::eventsetup::DataProxyProvider

Classes

struct  Entry
 
struct  FileInfo
 
struct  RPInfo
 

Public Member Functions

 CTPPSOpticalFunctionsESSource (const edm::ParameterSet &)
 
std::unique_ptr< LHCOpticalFunctionsSetCollectionproduce (const CTPPSOpticsRcd &)
 
 ~CTPPSOpticalFunctionsESSource () override=default
 
- 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)
 
- Public Member Functions inherited from edm::EventSetupRecordIntervalFinder
bool concurrentFinder () const
 
const eventsetup::ComponentDescriptiondescriptionForFinder () const
 
 EventSetupRecordIntervalFinder ()
 
 EventSetupRecordIntervalFinder (const EventSetupRecordIntervalFinder &)=delete
 
std::set< eventsetup::EventSetupRecordKeyfindingForRecords () const
 
const ValidityIntervalfindIntervalFor (const eventsetup::EventSetupRecordKey &, const IOVSyncValue &)
 
bool nonconcurrentAndIOVNeedsUpdate (const eventsetup::EventSetupRecordKey &key, const IOVSyncValue &syncValue) const
 
const EventSetupRecordIntervalFinderoperator= (const EventSetupRecordIntervalFinder &)=delete
 
void resetInterval (const eventsetup::EventSetupRecordKey &)
 
void setDescriptionForFinder (const eventsetup::ComponentDescription &iDescription)
 
virtual ~EventSetupRecordIntervalFinder () noexcept(false)
 

Static Public Member Functions

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

Private Member Functions

void setIntervalFor (const edm::eventsetup::EventSetupRecordKey &, const edm::IOVSyncValue &, edm::ValidityInterval &) override
 

Private Attributes

unsigned int m_currentEntry
 
bool m_currentEntryValid
 
std::vector< Entrym_entries
 
std::string m_label
 

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)
 
- Protected Member Functions inherited from edm::EventSetupRecordIntervalFinder
template<class T >
void findingRecord ()
 
void findingRecordWithKey (const eventsetup::EventSetupRecordKey &)
 

Detailed Description

Loads optical functions from ROOT files.

Definition at line 18 of file CTPPSOpticalFunctionsESSource.cc.

Constructor & Destructor Documentation

◆ CTPPSOpticalFunctionsESSource()

CTPPSOpticalFunctionsESSource::CTPPSOpticalFunctionsESSource ( const edm::ParameterSet conf)

Definition at line 58 of file CTPPSOpticalFunctionsESSource.cc.

References TrackerOfflineValidation_Dqm_cff::dirName, mps_splice::entry, MillePedeFileConverter_cfg::fileName, contentValuesFiles::fullPath, edm::ParameterSet::getParameter(), m_entries, m_label, muonDTDigis_cfi::pset, edm::ESProducer::setWhatProduced(), AlCaHLTBitMon_QueryRunRegistry::string, ctppsDiamondDQMSource_cfi::validityRange, OpticalFunctionsConfig_cfi::xangle, and z.

59  : m_label(conf.getParameter<std::string>("label")), m_currentEntryValid(false), m_currentEntry(0) {
60  for (const auto &entry_pset : conf.getParameter<std::vector<edm::ParameterSet>>("configuration")) {
61  edm::EventRange validityRange = entry_pset.getParameter<edm::EventRange>("validityRange");
62 
63  std::vector<FileInfo> fileInfo;
64  for (const auto &pset : entry_pset.getParameter<std::vector<edm::ParameterSet>>("opticalFunctions")) {
65  const double &xangle = pset.getParameter<double>("xangle");
66  const std::string &fileName = pset.getParameter<edm::FileInPath>("fileName").fullPath();
67  fileInfo.push_back({xangle, fileName});
68  }
69 
70  std::unordered_map<unsigned int, RPInfo> rpInfo;
71  for (const auto &pset : entry_pset.getParameter<std::vector<edm::ParameterSet>>("scoringPlanes")) {
72  const unsigned int rpId = pset.getParameter<unsigned int>("rpId");
73  const std::string dirName = pset.getParameter<std::string>("dirName");
74  const double z = pset.getParameter<double>("z");
75  const RPInfo entry = {dirName, z};
76  rpInfo.emplace(rpId, entry);
77  }
78 
79  m_entries.push_back({validityRange, fileInfo, rpInfo});
80  }
81 
82  setWhatProduced(this, m_label);
83  findingRecord<CTPPSOpticsRcd>();
84 }
auto setWhatProduced(T *iThis, const es::Label &iLabel={})
Definition: ESProducer.h:163
T getParameter(std::string const &) const
Definition: ParameterSet.h:303

◆ ~CTPPSOpticalFunctionsESSource()

CTPPSOpticalFunctionsESSource::~CTPPSOpticalFunctionsESSource ( )
overridedefault

Member Function Documentation

◆ fillDescriptions()

void CTPPSOpticalFunctionsESSource::fillDescriptions ( edm::ConfigurationDescriptions descriptions)
static

Definition at line 144 of file CTPPSOpticalFunctionsESSource.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), edm::ParameterSetDescription::addVPSet(), submitPVResolutionJobs::config, submitPVResolutionJobs::desc, haddnano::of, edm::ParameterDescriptionNode::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

144  {
146 
147  desc.add<std::string>("label", "")->setComment("label of the optics record");
148 
149  edm::ParameterSetDescription config_desc;
150 
151  config_desc.add<edm::EventRange>("validityRange", edm::EventRange())->setComment("interval of validity");
152 
154  of_desc.add<double>("xangle")->setComment("half crossing angle value in urad");
155  of_desc.add<edm::FileInPath>("fileName")->setComment("ROOT file with optical functions");
156  std::vector<edm::ParameterSet> of;
157  config_desc.addVPSet("opticalFunctions", of_desc, of)
158  ->setComment("list of optical functions at different crossing angles");
159 
161  sp_desc.add<unsigned int>("rpId")->setComment("associated detector DetId");
162  sp_desc.add<std::string>("dirName")->setComment("associated path to the optical functions file");
163  sp_desc.add<double>("z")->setComment("longitudinal position at scoring plane/detector");
164  std::vector<edm::ParameterSet> sp;
165  config_desc.addVPSet("scoringPlanes", sp_desc, sp)->setComment("list of sensitive planes/detectors stations");
166 
167  std::vector<edm::ParameterSet> config;
168  desc.addVPSet("configuration", config_desc, sp)->setComment("list of configuration blocks");
169 
170  descriptions.add("ctppsOpticalFunctionsESSource", desc);
171 }
void setComment(std::string const &value)
ParameterDescriptionBase * addVPSet(U const &iLabel, ParameterSetDescription const &validator, std::vector< ParameterSet > const &defaults)
ParameterDescriptionBase * add(U const &iLabel, T const &value)
config
parse the configuration file
void add(std::string const &label, ParameterSetDescription const &psetDescription)

◆ produce()

std::unique_ptr< LHCOpticalFunctionsSetCollection > CTPPSOpticalFunctionsESSource::produce ( const CTPPSOpticsRcd )

Definition at line 118 of file CTPPSOpticalFunctionsESSource.cc.

References mps_splice::entry, fcn(), m_currentEntry, m_currentEntryValid, m_entries, eostools::move(), and convertSQLitetoXML_cfg::output.

118  {
119  // prepare output, empty by default
120  auto output = std::make_unique<LHCOpticalFunctionsSetCollection>();
121 
122  // fill the output
123  if (m_currentEntryValid) {
124  const auto &entry = m_entries[m_currentEntry];
125 
126  for (const auto &fi : entry.m_fileInfo) {
127  std::unordered_map<unsigned int, LHCOpticalFunctionsSet> xa_data;
128 
129  for (const auto &rpi : entry.m_rpInfo) {
130  LHCOpticalFunctionsSet fcn(fi.m_fileName, rpi.second.m_dirName, rpi.second.m_scoringPlaneZ);
131  xa_data.emplace(rpi.first, std::move(fcn));
132  }
133 
134  output->emplace(fi.m_xangle, xa_data);
135  }
136  }
137 
138  // commit the output
139  return output;
140 }
Set of optical functions corresponding to one scoring plane along LHC.
void fcn(int &, double *, double &, double *, int)
def move(src, dest)
Definition: eostools.py:511

◆ setIntervalFor()

void CTPPSOpticalFunctionsESSource::setIntervalFor ( const edm::eventsetup::EventSetupRecordKey key,
const edm::IOVSyncValue iosv,
edm::ValidityInterval oValidity 
)
overrideprivatevirtual

Implements edm::EventSetupRecordIntervalFinder.

Definition at line 88 of file CTPPSOpticalFunctionsESSource.cc.

References edm::contains(), mps_fire::end, mps_splice::entry, edm::EventID::event(), edm::IOVSyncValue::eventID(), heavyIonCSV_trainingSettings::idx, edm::EventID::luminosityBlock(), m_currentEntry, m_currentEntryValid, m_entries, edm::EventID::run(), and command_line::start.

90  {
91  for (unsigned int idx = 0; idx < m_entries.size(); ++idx) {
92  const auto &entry = m_entries[idx];
93 
94  // is within an entry ?
95  if (edm::contains(entry.m_validityRange, iosv.eventID())) {
96  m_currentEntryValid = true;
98  oValidity = edm::ValidityInterval(edm::IOVSyncValue(entry.m_validityRange.startEventID()),
99  edm::IOVSyncValue(entry.m_validityRange.endEventID()));
100  return;
101  }
102  }
103 
104  // not within any entry
105  m_currentEntryValid = false;
106  m_currentEntry = 0;
107 
108  edm::LogInfo("") << "No configuration entry found for event " << iosv.eventID()
109  << ", no optical functions will be available.";
110 
111  const edm::EventID start(iosv.eventID().run(), iosv.eventID().luminosityBlock(), iosv.eventID().event());
112  const edm::EventID end(iosv.eventID().run(), iosv.eventID().luminosityBlock(), iosv.eventID().event());
114 }
Definition: start.py:1
bool contains(EventRange const &lh, EventID const &rh)
Definition: EventRange.cc:37
std::pair< Time_t, Time_t > ValidityInterval
Definition: Time.h:17
LuminosityBlockNumber_t luminosityBlock() const
Definition: EventID.h:39
Log< level::Info, false > LogInfo
RunNumber_t run() const
Definition: EventID.h:38
const EventID & eventID() const
Definition: IOVSyncValue.h:40
EventNumber_t event() const
Definition: EventID.h:40

Member Data Documentation

◆ m_currentEntry

unsigned int CTPPSOpticalFunctionsESSource::m_currentEntry
private

Definition at line 52 of file CTPPSOpticalFunctionsESSource.cc.

Referenced by produce(), and setIntervalFor().

◆ m_currentEntryValid

bool CTPPSOpticalFunctionsESSource::m_currentEntryValid
private

Definition at line 51 of file CTPPSOpticalFunctionsESSource.cc.

Referenced by produce(), and setIntervalFor().

◆ m_entries

std::vector<Entry> CTPPSOpticalFunctionsESSource::m_entries
private

◆ m_label

std::string CTPPSOpticalFunctionsESSource::m_label
private

Definition at line 31 of file CTPPSOpticalFunctionsESSource.cc.

Referenced by CTPPSOpticalFunctionsESSource().