Inheritance diagram for SiPhase2BadStripConfigurableFakeESSource:

Public Types
typedef std::unique_ptr< SiStripBadStrip >	ReturnType

Public Member Functions
ReturnType	produce (const SiPhase2OuterTrackerBadStripRcd &)

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

	SiPhase2BadStripConfigurableFakeESSource (const edm::ParameterSet &)

	~SiPhase2BadStripConfigurableFakeESSource () 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

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)

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 &)

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

Private Member Functions
std::map< unsigned short, unsigned short >	clusterizeBadChannels (const std::vector< Phase2TrackerDigi::PackedDigiType > &maskedChannels)

Private Attributes
float	badComponentsFraction_

std::unique_ptr< CLHEP::HepRandomEngine >	engine_

edm::ESGetToken< TrackerGeometry, TrackerDigiGeometryRecord >	geomToken_

bool	printDebug_

edm::ESGetToken< TrackerTopology, TrackerTopologyRcd >	trackTopoToken_

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

Description: "fake" SiStripBadStrip ESProducer - configurable list of bad modules

Implementation: Adapted to Phase-2 from CalibTracker/SiStripESProducers/plugins/fake/SiStripBadModuleConfigurableFakeESSource.cc

Definition at line 43 of file SiPhase2BadStripConfigurableFakeESSource.cc.

Member Typedef Documentation

◆ ReturnType

typedef std::unique_ptr<SiStripBadStrip> SiPhase2BadStripConfigurableFakeESSource::ReturnType

Definition at line 52 of file SiPhase2BadStripConfigurableFakeESSource.cc.

Constructor & Destructor Documentation

◆ SiPhase2BadStripConfigurableFakeESSource()

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

Definition at line 73 of file SiPhase2BadStripConfigurableFakeESSource.cc.

References badComponentsFraction_, Exception, geomToken_, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), printDebug_, edm::ESProducer::setWhatProduced(), and trackTopoToken_.

     : engine_(new CLHEP::HepJamesRandom(iConfig.getParameter<unsigned int>("seed"))) {
   auto cc = setWhatProduced(this);
   trackTopoToken_ = cc.consumes();
   geomToken_ = cc.consumes();
 
   printDebug_ = iConfig.getUntrackedParameter<bool>("printDebug", false);
   badComponentsFraction_ = iConfig.getParameter<double>("badComponentsFraction");
 
   if (badComponentsFraction_ > 1. || badComponentsFraction_ < 0.) {
     throw cms::Exception("Inconsistent configuration")
         << "[SiPhase2BadStripChannelBuilder::c'tor] the requested fraction of bad components is unphysical. \n";
   }
 
   findingRecord<SiPhase2OuterTrackerBadStripRcd>();
 }

◆ ~SiPhase2BadStripConfigurableFakeESSource()

SiPhase2BadStripConfigurableFakeESSource::~SiPhase2BadStripConfigurableFakeESSource ( )

overridedefault

Member Function Documentation

◆ clusterizeBadChannels()

std::map< unsigned short, unsigned short > SiPhase2BadStripConfigurableFakeESSource::clusterizeBadChannels ( const std::vector< Phase2TrackerDigi::PackedDigiType > & maskedChannels )

private

Definition at line 192 of file SiPhase2BadStripConfigurableFakeESSource.cc.

References data, HLT_2022v14_cff::distance, LogDebug, L1Scalers_cfi::maskedChannels, printDebug_, mps_fire::result, submitPVValidationJobs::text, and cond::impl::to_string().

Referenced by produce().

                                                                       {
   // Here we will store the result
   std::map<unsigned short, unsigned short> result{};
   std::map<int, std::string> printresult{};
 
   // Sort and remove duplicates.
   std::set data(maskedChannels.begin(), maskedChannels.end());
 
   // We will start the evaluation at the beginning of our data
   auto startOfSequence = data.begin();
 
   // Find all sequences
   while (startOfSequence != data.end()) {
     // Find first value that is not greater than one
     auto endOfSequence =
         std::adjacent_find(startOfSequence, data.end(), [](const auto& v1, const auto& v2) { return v2 != v1 + 1; });
     if (endOfSequence != data.end())
       std::advance(endOfSequence, 1);
 
     auto consecutiveStrips = std::distance(startOfSequence, endOfSequence);
     result[*startOfSequence] = consecutiveStrips;
 
     if (printDebug_) {
       // Build resulting string
       std::ostringstream oss{};
       bool writeDash = false;
       for (auto it = startOfSequence; it != endOfSequence; ++it) {
         oss << (writeDash ? "-" : "") << std::to_string(*it);
         writeDash = true;
       }
 
       // Copy result to map
       for (auto it = startOfSequence; it != endOfSequence; ++it)
         printresult[*it] = oss.str();
     }
 
     // Continue to search for the next sequence
     startOfSequence = endOfSequence;
   }
 
   if (printDebug_) {
     // Show result on the screen. Or use the map in whichever way you want.
     for (const auto& [value, text] : printresult)
       LogDebug("SiPhase2BadStripConfigurableFakeESSource")
           << std::left << std::setw(2) << value << " -> " << text << "\n";
   }
   return result;
 }

◆ fillDescriptions()

void SiPhase2BadStripConfigurableFakeESSource::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 242 of file SiPhase2BadStripConfigurableFakeESSource.cc.

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

                                                                                                           {
   edm::ParameterSetDescription desc;
   desc.setComment("Configurable Fake Phase-2 Outer Tracker Bad Strip ESSource");
   desc.add<unsigned int>("seed", 1)->setComment("random seed");
   desc.addUntracked<bool>("printDebug", false)->setComment("maximum amount of print-outs");
   desc.add<double>("badComponentsFraction", 0.01)->setComment("fraction of bad components to populate the ES");
   descriptions.addWithDefaultLabel(desc);
 }

◆ produce()

SiPhase2BadStripConfigurableFakeESSource::ReturnType SiPhase2BadStripConfigurableFakeESSource::produce ( const SiPhase2OuterTrackerBadStripRcd & iRecord )

Definition at line 97 of file SiPhase2BadStripConfigurableFakeESSource.cc.

References cms::cuda::assert(), badComponentsFraction_, clusterizeBadChannels(), TauDecayModes::dec, DetId::det(), TrackerGeometry::detUnits(), engine_, f, spr::find(), first, geomToken_, edm::eventsetup::DependentRecordImplementation< RecordT, ListT >::get(), TrackerGeometry::getDetectorType(), LogDebug, hgcalPlots::ncols, PixelTopology::nrows(), TrackerGeometry::Ph2PSS, TrackerGeometry::Ph2SS, Phase2TrackerDigi::pixelToChannel(), printDebug_, FastTimerService_cff::range, DetId::rawId(), PixelGeomDetUnit::specificTopology(), DetId::subdetId(), StripSubdetector::TID, StripSubdetector::TOB, and align::Tracker.

                                                     {
   using namespace edm::es;
   using Phase2TrackerGeomDetUnit = PixelGeomDetUnit;
 
   //TrackerTopology const& tTopo = iRecord.get(trackTopoToken_);
   TrackerGeometry const& tGeom = iRecord.get(geomToken_);
 
   auto badStrips = std::make_unique<SiStripBadStrip>();
 
   // early return with nullptr if fraction is == 0.f
   if (badComponentsFraction_ == 0.f) {
     return badStrips;
   }
 
   LogDebug("SiPhase2BadStripConfigurableFakeESSource")
       << " There are " << tGeom.detUnits().size() << " modules in this geometry.";
 
   int counter{0};
   for (auto const& det_u : tGeom.detUnits()) {
     const DetId detid = det_u->geographicalId();
     uint32_t rawId = detid.rawId();
     int subid = detid.subdetId();
     if (detid.det() == DetId::Detector::Tracker) {
       const Phase2TrackerGeomDetUnit* pixdet = dynamic_cast<const Phase2TrackerGeomDetUnit*>(det_u);
       assert(pixdet);
       if (subid == StripSubdetector::TOB || subid == StripSubdetector::TID) {
         if (tGeom.getDetectorType(rawId) == TrackerGeometry::ModuleType::Ph2PSS ||
             tGeom.getDetectorType(rawId) == TrackerGeometry::ModuleType::Ph2SS) {
           const PixelTopology& topol(pixdet->specificTopology());
 
           const int nrows = topol.nrows();
           const int ncols = topol.ncolumns();
 
           LogDebug("SiPhase2BadStripConfigurableFakeESSource")
               << "DetId: " << rawId << " subdet: " << subid << " nrows: " << nrows << " ncols: " << ncols;
 
           // auxilliary vector to check if the channels were already used
           std::vector<Phase2TrackerDigi::PackedDigiType> usedChannels;
 
           size_t nmaxBadStrips = std::floor(nrows * ncols * badComponentsFraction_);
 
           while (usedChannels.size() < nmaxBadStrips) {
             unsigned short badStripRow = std::floor(CLHEP::RandFlat::shoot(engine_.get(), 0, nrows));
             unsigned short badStripCol = std::floor(CLHEP::RandFlat::shoot(engine_.get(), 0, ncols));
             const auto& badChannel = Phase2TrackerDigi::pixelToChannel(badStripRow, badStripCol);
             if (std::find(usedChannels.begin(), usedChannels.end(), badChannel) == usedChannels.end()) {
               usedChannels.push_back(badChannel);
             }
           }
 
           //usedChannels.push_back(Phase2TrackerDigi::pixelToChannel(0,1)); // useful for testing
 
           const auto badChannelsGroups = this->clusterizeBadChannels(usedChannels);
 
           LogDebug("SiPhase2BadStripConfigurableFakeESSource")
               << rawId << " (" << counter << ") "
               << " masking " << nmaxBadStrips << " strips, used channels size: " << usedChannels.size()
               << ", clusters size: " << badChannelsGroups.size();
 
           std::vector<unsigned int> theSiStripVector;
 
           // loop over the groups of bad strips
           for (const auto& [first, consec] : badChannelsGroups) {
             unsigned int theBadChannelsRange;
             theBadChannelsRange = badStrips->encodePhase2(first, consec);
 
             if (printDebug_) {
               edm::LogInfo("SiPhase2BadStripConfigurableFakeESSource")
                   << "detid " << rawId << " \t"
                   << " firstBadStrip " << first << "\t "
                   << " NconsecutiveBadStrips " << consec << "\t "
                   << " packed integer " << std::hex << theBadChannelsRange << std::dec;
             }
             theSiStripVector.push_back(theBadChannelsRange);
           }
 
           SiStripBadStrip::Range range(theSiStripVector.begin(), theSiStripVector.end());
           if (!badStrips->put(rawId, range))
             edm::LogError("SiPhase2BadStripConfigurableFakeESSource")
                 << "[SiPhase2BadStripConfigurableFakeESSource::produce] detid already exists";
 
           counter++;
 
         }  // if it's a strip module
       }    // if it's OT
     }      // if it's Tracker
   }        // loop on DetIds
 
   LogDebug("SiPhase2BadStripConfigurableFakeESSource") << "end of the detId loops";
 
   return badStrips;
 }

◆ setIntervalFor()

void SiPhase2BadStripConfigurableFakeESSource::setIntervalFor	(	const edm::eventsetup::EventSetupRecordKey &	,
		const edm::IOVSyncValue &	iov,
		edm::ValidityInterval &	iValidity
	)

overridevirtual

Implements edm::EventSetupRecordIntervalFinder.

Definition at line 90 of file SiPhase2BadStripConfigurableFakeESSource.cc.

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

                                                                                               {
   iValidity = edm::ValidityInterval{iov.beginOfTime(), iov.endOfTime()};
 }