plugin parses the module/cell locator files to produce the indexer records More...

Inheritance diagram for HGCalMappingESProducer:

Public Member Functions
	HGCalMappingESProducer (const edm::ParameterSet &iConfig)

std::shared_ptr< HGCalMappingCellIndexer >	produceCellMapIndexer (const HGCalElectronicsMappingRcd &)

std::shared_ptr< HGCalMappingModuleIndexer >	produceModuleMapIndexer (const HGCalElectronicsMappingRcd &)

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

	ESProducer (const ESProducer &)=delete

	ESProducer (ESProducer &&)=delete

ESResolverIndex 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 &	operator= (const ESProducer &)=delete

ESProducer &	operator= (ESProducer &&)=delete

SerialTaskQueueChain &	queue ()

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

void	updateLookup (eventsetup::ESRecordsToProductResolverIndices const &) final

	~ESProducer () noexcept(false) override

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

	ESProductResolverFactoryProducer (const ESProductResolverFactoryProducer &)=delete

const ESProductResolverFactoryProducer &	operator= (const ESProductResolverFactoryProducer &)=delete

	~ESProductResolverFactoryProducer () noexcept(false) override

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

const ComponentDescription &	description () const

	ESProductResolverProvider ()

	ESProductResolverProvider (const ESProductResolverProvider &)=delete

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

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

bool	isUsingRecord (const EventSetupRecordKey &key) const

KeyedResolvers &	keyedResolvers (const EventSetupRecordKey &iRecordKey, unsigned int iovIndex=0)

const ESProductResolverProvider &	operator= (const ESProductResolverProvider &)=delete

void	setAppendToDataLabel (const edm::ParameterSet &)

void	setDescription (const ComponentDescription &iDescription)

std::set< EventSetupRecordKey >	usingRecords () const

virtual	~ESProductResolverProvider () noexcept(false)

Public Member Functions inherited from edm::EventSetupRecordIntervalFinder
bool	concurrentFinder () const

const eventsetup::ComponentDescription &	descriptionForFinder () const

	EventSetupRecordIntervalFinder ()

	EventSetupRecordIntervalFinder (const EventSetupRecordIntervalFinder &)=delete

std::set< eventsetup::EventSetupRecordKey >	findingForRecords () const

const ValidityInterval &	findIntervalFor (const eventsetup::EventSetupRecordKey &, const IOVSyncValue &)

bool	nonconcurrentAndIOVNeedsUpdate (const eventsetup::EventSetupRecordKey &key, const IOVSyncValue &syncValue) const

const EventSetupRecordIntervalFinder &	operator= (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 &descriptions)

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

Private Member Functions
void	prepareCellMapperIndexer ()

void	prepareModuleMapperIndexer ()

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

Private Attributes
HGCalMappingCellIndexer	cellIndexer_

HGCalMappingModuleIndexer	modIndexer_

std::map< std::string, hgcal::mappingtools::HGCalEntityList >	parsedMaps_

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

Protected Types inherited from edm::eventsetup::ESProductResolverProvider
using	KeyedResolversVector = std::vector< std::pair< DataKey, std::shared_ptr< ESProductResolver > >>

Protected Member Functions inherited from edm::ESProducer
ESConsumesInfo *	consumesInfoPushBackNew ()

unsigned int	consumesInfoSize () const

template<typename CallbackT , typename TList , typename TRecord >
void	registerProducts (std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>> iCallback, const TList , const TRecord iRecord, const es::Label &iLabel)

template<typename CallbackT , typename TRecord >
void	registerProducts (std::shared_ptr< std::pair< unsigned int, std::shared_ptr< CallbackT >>>, const eventsetup::produce::Null , const TRecord , const es::Label &)

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 TDecorator >
auto	setWhatProduced (T iThis, TReturn(T ::iMethod)(const TRecord &), const TDecorator &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::ESProductResolverFactoryProducer
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::ESProductResolverFactoryBase > iFactory, const std::string &iLabel=std::string())

KeyedResolversVector	registerResolvers (const EventSetupRecordKey &, unsigned int iovIndex) override

Protected Member Functions inherited from edm::eventsetup::ESProductResolverProvider
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

plugin parses the module/cell locator files to produce the indexer records

Definition at line 22 of file HGCalMappingESProducer.cc.

Constructor & Destructor Documentation

◆ HGCalMappingESProducer()

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

inlineexplicit

Definition at line 24 of file HGCalMappingESProducer.cc.

References hgcal::mappingtools::HGCalEntityList::buildFrom(), edm::FileInPath::fullPath(), edm::ParameterSet::getParameter(), parsedMaps_, prepareCellMapperIndexer(), prepareModuleMapperIndexer(), produceCellMapIndexer(), produceModuleMapIndexer(), edm::ESProducer::setWhatProduced(), and findQualityFiles::v.

                                                                   {
     //parse the files and hold the list of entities in memory
     for (auto v : {"modules", "si", "sipm"}) {
       edm::FileInPath fip = iConfig.getParameter<edm::FileInPath>(v);
       hgcal::mappingtools::HGCalEntityList pmap;
       pmap.buildFrom(fip.fullPath());
       parsedMaps_[v] = pmap;
     }
 
     setWhatProduced(this, &HGCalMappingESProducer::produceCellMapIndexer);
     setWhatProduced(this, &HGCalMappingESProducer::produceModuleMapIndexer);
 
     findingRecord<HGCalElectronicsMappingRcd>();
 
     prepareCellMapperIndexer();
     prepareModuleMapperIndexer();
   }

Member Function Documentation

◆ fillDescriptions()

static void HGCalMappingESProducer::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

inlinestatic

Definition at line 50 of file HGCalMappingESProducer.cc.

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

                                                                            {
     edm::ParameterSetDescription desc;
     desc.add<edm::FileInPath>("modules")->setComment("module locator file");
     desc.add<edm::FileInPath>("si")->setComment("file containing the mapping of the readout cells in Si modules");
     desc.add<edm::FileInPath>("sipm")->setComment(
         "file containing the mapping of the readout cells in SiPM-on-tile modules");
     descriptions.addWithDefaultLabel(desc);
   }

◆ prepareCellMapperIndexer()

void HGCalMappingESProducer::prepareCellMapperIndexer ( )

private

Definition at line 75 of file HGCalMappingESProducer.cc.

References cellIndexer_, parsedMaps_, HGCalMappingCellIndexer::processNewCell(), AlCaHLTBitMon_QueryRunRegistry::string, HGCalMappingCellIndexer::update(), and findQualityFiles::v.

Referenced by HGCalMappingESProducer().

                                                       {
   for (auto v : {"si", "sipm"}) {
     auto& pmap = parsedMaps_[v];
     const auto& entities = pmap.getEntries();
     for (auto row : entities) {
       std::string typecode = pmap.getAttr("Typecode", row);
       int chip = pmap.getIntAttr("ROC", row);
       int half = pmap.getIntAttr("HalfROC", row);
       cellIndexer_.processNewCell(typecode, chip, half);
     }
   }
 
   // all {hex,tile}board types are loaded finalize the mapping indexer
   cellIndexer_.update();
 }

◆ prepareModuleMapperIndexer()

void HGCalMappingESProducer::prepareModuleMapperIndexer ( )

private

Definition at line 92 of file HGCalMappingESProducer.cc.

References cellIndexer_, MillePedeFileConverter_cfg::e, PixelSLinkDataInputSource_cfi::fedid, HGCalMappingModuleIndexer::finalize(), HGCalMappingCellIndexer::getEnumFromTypecode(), HGCalMappingCellIndexer::getNErxExpectedFor(), HGCalMappingCellIndexer::getNWordsExpectedFor(), modIndexer_, parsedMaps_, HGCalMappingModuleIndexer::processNewModule(), AlCaHLTBitMon_QueryRunRegistry::string, and findQualityFiles::v.

Referenced by HGCalMappingESProducer().

                                                         {
   //default values to assign in case module type has not yet been mapped
   //a high density module (max possible) will be assigned so that the mapping doesn't block
   auto defaultTypeCodeIdx = cellIndexer_.getEnumFromTypecode("MH-F");
   auto typecodeidx = defaultTypeCodeIdx;
   auto defaultNerx = cellIndexer_.getNErxExpectedFor(defaultTypeCodeIdx);
   auto nerx = defaultNerx;
   auto defaultTypeNWords = cellIndexer_.getNWordsExpectedFor(defaultTypeCodeIdx);
   auto nwords = defaultTypeNWords;
 
   auto& pmap = parsedMaps_["modules"];
   auto& entities = pmap.getEntries();
   for (auto row : entities) {
     std::string typecode = pmap.getAttr("typecode", row);
 
     if (typecode.find('M') == 0 && typecode.size() > 4)
       typecode = typecode.substr(0, 4);
 
     try {
       typecodeidx = cellIndexer_.getEnumFromTypecode(typecode);
       nwords = cellIndexer_.getNWordsExpectedFor(typecode);
       nerx = cellIndexer_.getNErxExpectedFor(typecode);
     } catch (cms::Exception& e) {
       int plane = pmap.getIntAttr("plane", row);
       int u = pmap.getIntAttr("u", row);
       int v = pmap.getIntAttr("v", row);
       edm::LogWarning("HGCalMappingESProducer") << "Exception caught decoding index for typecode=" << typecode
                                                 << " @ plane=" << plane << " u=" << u << " v=" << v << "\n"
                                                 << e.what() << "\n"
                                                 << "===> will assign default (MH-F) which may be inefficient";
       typecodeidx = defaultTypeCodeIdx;
       nwords = defaultTypeNWords;
       nerx = defaultNerx;
     }
 
     int fedid = pmap.getIntAttr("fedid", row);
     int captureblockidx = pmap.getIntAttr("captureblockidx", row);
     int econdidx = pmap.getIntAttr("econdidx", row);
     modIndexer_.processNewModule(fedid, captureblockidx, econdidx, typecodeidx, nerx, nwords);
   }
 
   modIndexer_.finalize();
 }

◆ produceCellMapIndexer()

std::shared_ptr<HGCalMappingCellIndexer> HGCalMappingESProducer::produceCellMapIndexer ( const HGCalElectronicsMappingRcd & )

inline

Definition at line 46 of file HGCalMappingESProducer.cc.

References cellIndexer_.

Referenced by HGCalMappingESProducer().

                                                                                                   {
     return std::shared_ptr<HGCalMappingCellIndexer>(&cellIndexer_, edm::do_nothing_deleter());
   }

◆ produceModuleMapIndexer()

std::shared_ptr<HGCalMappingModuleIndexer> HGCalMappingESProducer::produceModuleMapIndexer ( const HGCalElectronicsMappingRcd & )

inline

Definition at line 42 of file HGCalMappingESProducer.cc.

References modIndexer_.

Referenced by HGCalMappingESProducer().

                                                                                                       {
     return std::shared_ptr<HGCalMappingModuleIndexer>(&modIndexer_, edm::do_nothing_deleter());
   }

◆ setIntervalFor()

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

inlineoverrideprivatevirtual

Implements edm::EventSetupRecordIntervalFinder.

Definition at line 60 of file HGCalMappingESProducer.cc.

References edm::IOVSyncValue::beginOfTime(), and edm::IOVSyncValue::endOfTime().

                                                                {
     oValidity = edm::ValidityInterval(edm::IOVSyncValue::beginOfTime(), edm::IOVSyncValue::endOfTime());
   }

Member Data Documentation

◆ cellIndexer_

HGCalMappingCellIndexer HGCalMappingESProducer::cellIndexer_

private

Definition at line 70 of file HGCalMappingESProducer.cc.

Referenced by prepareCellMapperIndexer(), prepareModuleMapperIndexer(), and produceCellMapIndexer().

◆ modIndexer_

HGCalMappingModuleIndexer HGCalMappingESProducer::modIndexer_

private

Definition at line 71 of file HGCalMappingESProducer.cc.

Referenced by prepareModuleMapperIndexer(), and produceModuleMapIndexer().

◆ parsedMaps_

std::map<std::string, hgcal::mappingtools::HGCalEntityList> HGCalMappingESProducer::parsedMaps_

private

Definition at line 69 of file HGCalMappingESProducer.cc.

Referenced by HGCalMappingESProducer(), prepareCellMapperIndexer(), and prepareModuleMapperIndexer().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HGCalMappingESProducer()

Member Function Documentation

◆ fillDescriptions()

◆ prepareCellMapperIndexer()

◆ prepareModuleMapperIndexer()

◆ produceCellMapIndexer()

◆ produceModuleMapIndexer()

◆ setIntervalFor()

Member Data Documentation

◆ cellIndexer_

◆ modIndexer_

◆ parsedMaps_