#include <CondTools/SiStrip/plugins/SiStripNoisesFromDBMiscalibrator.cc>

Inheritance diagram for SiStripNoisesFromDBMiscalibrator:

Public Member Functions
	SiStripNoisesFromDBMiscalibrator (const edm::ParameterSet &)

	~SiStripNoisesFromDBMiscalibrator () override

Public Member Functions inherited from edm::one::EDAnalyzer<>
	EDAnalyzer ()=default

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

Public Member Functions inherited from edm::one::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~EDAnalyzerBase () override

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase &&)=default

	EDConsumerBase (EDConsumerBase const &)=delete

ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const

ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

EDConsumerBase &	operator= (EDConsumerBase &&)=default

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::one::EDAnalyzerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	analyze (const edm::Event &, const edm::EventSetup &) override

void	beginJob () override

void	endJob () override

std::unique_ptr< SiStripNoises >	getNewObject (const std::map< std::pair< uint32_t, int >, float > &theMap)

std::unique_ptr< SiStripNoises >	getNewObject_withDefaults (const std::map< std::pair< uint32_t, int >, float > &theMap, const float theDefault)

Private Attributes
edm::FileInPath	fp_

const bool	m_fillDefaults

edm::ESGetToken< SiStripNoises, SiStripNoisesRcd >	m_noiseToken

const std::vector< edm::ParameterSet >	m_parameters

const bool	m_saveMaps

edm::ESGetToken< TrackerTopology, TrackerTopologyRcd >	m_tTopoToken

std::unique_ptr< TrackerMap >	missing_map

std::unique_ptr< TrackerMap >	new_payload_map

std::unique_ptr< TrackerMap >	old_payload_map

std::unique_ptr< TrackerMap >	ratio_map

std::unique_ptr< TrackerMap >	scale_map

std::unique_ptr< TrackerMap >	smear_map

Additional Inherited Members
Public Types inherited from edm::one::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

Description: Class to miscalibrate a SiStrip Noise payload from Database

Implementation: Read a SiStrip Noise payload from DB (either central DB or sqlite file) and apply a miscalibration (either an offset / gaussian smearing or both) returns a local sqlite file with the same since of the original payload

Definition at line 51 of file SiStripNoisesFromDBMiscalibrator.cc.

Constructor & Destructor Documentation

◆ SiStripNoisesFromDBMiscalibrator()

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

explicit

Definition at line 85 of file SiStripNoisesFromDBMiscalibrator.cc.

     : m_fillDefaults{iConfig.getUntrackedParameter<bool>("fillDefaults", false)},
       m_saveMaps{iConfig.getUntrackedParameter<bool>("saveMaps", true)},
       m_parameters{iConfig.getParameter<std::vector<edm::ParameterSet> >("params")},
       fp_{iConfig.getUntrackedParameter<edm::FileInPath>(
           "file", edm::FileInPath("CalibTracker/SiStripCommon/data/SiStripDetInfo.dat"))},
       m_tTopoToken(esConsumes()),
       m_noiseToken(esConsumes()) {
   //now do what ever initialization is needed
  
   scale_map = std::make_unique<TrackerMap>("scale");
   scale_map->setTitle("Tracker Map of Scale factor averaged by module");
   scale_map->setPalette(1);
  
   smear_map = std::make_unique<TrackerMap>("smear");
   smear_map->setTitle("Tracker Map of Smear factor averaged by module");
   smear_map->setPalette(1);
  
   old_payload_map = std::make_unique<TrackerMap>("old_payload");
   old_payload_map->setTitle("Tracker Map of Starting Noise Payload averaged by module");
   old_payload_map->setPalette(1);
  
   new_payload_map = std::make_unique<TrackerMap>("new_payload");
   new_payload_map->setTitle("Tracker Map of Modified Noise Payload averaged by module");
   new_payload_map->setPalette(1);
  
   ratio_map = std::make_unique<TrackerMap>("ratio");
   ratio_map->setTitle("Tracker Map of Average by module of the payload ratio (new/old)");
   ratio_map->setPalette(1);
  
   if (m_fillDefaults) {
     missing_map = std::make_unique<TrackerMap>("uncabled");
     missing_map->setTitle("Tracker Map of uncabled modules");
     missing_map->setPalette(1);
   }
 }

References edm::ParameterSet::getUntrackedParameter().

◆ ~SiStripNoisesFromDBMiscalibrator()

SiStripNoisesFromDBMiscalibrator::~SiStripNoisesFromDBMiscalibrator ( )

override

Definition at line 122 of file SiStripNoisesFromDBMiscalibrator.cc.

122 {}

Member Function Documentation

◆ analyze()

void SiStripNoisesFromDBMiscalibrator::analyze	(	const edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overrideprivatevirtual

Implements edm::one::EDAnalyzerBase.

Definition at line 129 of file SiStripNoisesFromDBMiscalibrator.cc.

                                                                                                   {
   using namespace edm;
  
   const auto tTopo = &iSetup.getData(m_tTopoToken);
  
   std::vector<std::string> partitions;
  
   // fill the list of partitions
   for (auto& thePSet : m_parameters) {
     const std::string partition(thePSet.getParameter<std::string>("partition"));
     // only if it is not yet in the list
     if (std::find(partitions.begin(), partitions.end(), partition) == partitions.end()) {
       partitions.push_back(partition);
     }
   }
  
   std::map<sistripsummary::TrackerRegion, SiStripMiscalibrate::Smearings> mapOfSmearings;
  
   for (auto& thePSet : m_parameters) {
     const std::string partition(thePSet.getParameter<std::string>("partition"));
     sistripsummary::TrackerRegion region = SiStripMiscalibrate::getRegionFromString(partition);
  
     bool m_doScale(thePSet.getParameter<bool>("doScale"));
     bool m_doSmear(thePSet.getParameter<bool>("doSmear"));
     double m_scaleFactor(thePSet.getParameter<double>("scaleFactor"));
     double m_smearFactor(thePSet.getParameter<double>("smearFactor"));
  
     SiStripMiscalibrate::Smearings params = SiStripMiscalibrate::Smearings();
     params.setSmearing(m_doScale, m_doSmear, m_scaleFactor, m_smearFactor);
     mapOfSmearings[region] = params;
   }
  
   const auto& stripNoises = iSetup.getData(m_noiseToken);
  
   std::map<std::pair<uint32_t, int>, float> theMap, oldPayloadMap;
  
   std::vector<uint32_t> detid;
   stripNoises.getDetIds(detid);
   for (const auto& d : detid) {
     SiStripNoises::Range range = stripNoises.getRange(d);
  
     auto regions = SiStripMiscalibrate::getRegionsFromDetId(tTopo, d);
  
     // sort by largest to smallest
     std::sort(regions.rbegin(), regions.rend());
  
     SiStripMiscalibrate::Smearings params = SiStripMiscalibrate::Smearings();
  
     for (unsigned int j = 0; j < regions.size(); j++) {
       bool checkRegion = (mapOfSmearings.count(regions[j]) != 0);
  
       if (!checkRegion) {
         // if the subdetector is not in the list and there's no indication for the whole tracker, just use the default
         // i.e. no change
         continue;
       } else {
         params = mapOfSmearings[regions[j]];
         break;
       }
     }
  
     scale_map->fill(d, params.m_scaleFactor);
     smear_map->fill(d, params.m_smearFactor);
  
     int nStrips = 0;
     for (int it = 0; it < (range.second - range.first) * 8 / 9; ++it) {
       auto noise = stripNoises.getNoise(it, range);
       std::pair<uint32_t, int> index = std::make_pair(d, nStrips);
  
       oldPayloadMap[index] = noise;
  
       if (params.m_doScale) {
         noise *= params.m_scaleFactor;
       }
  
       if (params.m_doSmear) {
         float smearedNoise = CLHEP::RandGauss::shoot(noise, params.m_smearFactor);
         noise = smearedNoise;
       }
  
       theMap[index] = noise;
  
       nStrips += 1;
  
     }  // loop over APVs
   }    // loop over DetIds
  
   std::unique_ptr<SiStripNoises> theSiStripNoises;
   if (!m_fillDefaults) {
     theSiStripNoises = this->getNewObject(theMap);
   } else {
     theSiStripNoises = this->getNewObject_withDefaults(theMap, -1.);
   }
  
   // make the payload ratio map
   uint32_t cachedId(0);
   SiStripMiscalibrate::Entry noise_ratio;
   SiStripMiscalibrate::Entry o_noise;
   SiStripMiscalibrate::Entry n_noise;
   for (const auto& element : theMap) {
     uint32_t DetId = element.first.first;
     int nstrip = element.first.second;
     float new_noise = element.second;
     float old_noise = oldPayloadMap[std::make_pair(DetId, nstrip)];
  
     // flush the counters
     if (cachedId != 0 && DetId != cachedId) {
       ratio_map->fill(cachedId, noise_ratio.mean());
       old_payload_map->fill(cachedId, o_noise.mean());
       new_payload_map->fill(cachedId, n_noise.mean());
  
       //auto test = new_payload_map.get()->smoduleMap;
  
       noise_ratio.reset();
       o_noise.reset();
       n_noise.reset();
     }
  
     cachedId = DetId;
     noise_ratio.add(new_noise / old_noise);
     o_noise.add(old_noise);
     n_noise.add(new_noise);
   }
  
   // write out the SiStripNoises record
   edm::Service<cond::service::PoolDBOutputService> poolDbService;
  
   if (poolDbService.isAvailable())
     poolDbService->writeOne(theSiStripNoises.get(), poolDbService->currentTime(), "SiStripNoisesRcd");
   else
     throw std::runtime_error("PoolDBService required.");
 }

References SiStripMiscalibrate::Entry::add(), cond::service::PoolDBOutputService::currentTime(), ztail::d, spr::find(), edm::EventSetup::getData(), getNewObject(), getNewObject_withDefaults(), SiStripMiscalibrate::getRegionFromString(), SiStripMiscalibrate::getRegionsFromDetId(), edm::Service< T >::isAvailable(), dqmiolumiharvest::j, m_fillDefaults, m_noiseToken, m_parameters, m_tTopoToken, SiStripMiscalibrate::Entry::mean(), new_payload_map, hgcalDigitizer_cfi::noise, me0TriggerPseudoDigis_cff::nStrips, old_payload_map, CalibrationSummaryClient_cfi::params, FastTimerService_cff::range, ratio_map, HLT_FULL_cff::region, SiStripMiscalibrate::Entry::reset(), scale_map, smear_map, AlCaHLTBitMon_QueryRunRegistry::string, and cond::service::PoolDBOutputService::writeOne().

◆ beginJob()

void SiStripNoisesFromDBMiscalibrator::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 263 of file SiStripNoisesFromDBMiscalibrator.cc.

263 {}

◆ endJob()

void SiStripNoisesFromDBMiscalibrator::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 266 of file SiStripNoisesFromDBMiscalibrator.cc.

                                               {
   if (m_saveMaps) {
     scale_map->save(true, 0, 0, "noise_scale_map.pdf");
     scale_map->save(true, 0, 0, "noise_scale_map.png");
  
     smear_map->save(true, 0, 0, "noise_smear_map.pdf");
     smear_map->save(true, 0, 0, "noise_smear_map.png");
  
     ratio_map->save(true, 0, 0, "noise_ratio_map.pdf");
     ratio_map->save(true, 0, 0, "noise_ratio_map.png");
  
     auto range = SiStripMiscalibrate::getTruncatedRange(old_payload_map.get());
  
     old_payload_map->save(true, range.first, range.second, "starting_noise_payload_map.pdf");
     old_payload_map->save(true, range.first, range.second, "starting_noise_payload_map.png");
  
     range = SiStripMiscalibrate::getTruncatedRange(new_payload_map.get());
  
     new_payload_map->save(true, range.first, range.second, "new_noise_payload_map.pdf");
     new_payload_map->save(true, range.first, range.second, "new_noise_payload_map.png");
  
     if (m_fillDefaults) {
       missing_map->save(true, 0, 0, "missing_map.pdf");
       missing_map->save(true, 0, 0, "missing_map.png");
     }
   }
 }

References SiStripMiscalibrate::getTruncatedRange(), m_fillDefaults, m_saveMaps, missing_map, new_payload_map, old_payload_map, FastTimerService_cff::range, ratio_map, scale_map, and smear_map.

◆ fillDescriptions()

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

static

Definition at line 384 of file SiStripNoisesFromDBMiscalibrator.cc.

                                                                                                   {
   edm::ParameterSetDescription desc;
  
   desc.setComment(
       "Creates rescaled / smeared SiStrip Noise payload."
       "PoolDBOutputService must be set up for 'SiSiStripNoisesRcd'.");
  
   edm::ParameterSetDescription descScaler;
   descScaler.setComment(
       "ParameterSet specifying the Strip tracker partition to be scaled / smeared "
       "by a given factor.");
  
   descScaler.add<std::string>("partition", "Tracker");
   descScaler.add<bool>("doScale", true);
   descScaler.add<bool>("doSmear", true);
   descScaler.add<double>("scaleFactor", 1.0);
   descScaler.add<double>("smearFactor", 1.0);
   desc.addVPSet("params", descScaler, std::vector<edm::ParameterSet>(1));
  
   desc.addUntracked<bool>("fillDefaults", false);
   desc.addUntracked<bool>("saveMaps", true);
  
   descriptions.add("scaleAndSmearSiStripNoises", desc);
 }

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), submitPVResolutionJobs::desc, edm::ParameterSetDescription::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

◆ getNewObject()

std::unique_ptr< SiStripNoises > SiStripNoisesFromDBMiscalibrator::getNewObject ( const std::map< std::pair< uint32_t, int >, float > & theMap )

private

Definition at line 357 of file SiStripNoisesFromDBMiscalibrator.cc.

                                                          {
   std::unique_ptr<SiStripNoises> obj = std::make_unique<SiStripNoises>();
  
   uint32_t PreviousDetId = 0;
   SiStripNoises::InputVector theSiStripVector;
   for (const auto& element : theMap) {
     uint32_t DetId = element.first.first;
     float noise = element.second;
  
     if (DetId != PreviousDetId) {
       if (!theSiStripVector.empty()) {
         if (!obj->put(PreviousDetId, theSiStripVector)) {
           edm::LogError("SiStripNoisesFromDBMiscalibrator")
               << "[SiStripNoisesFromDBMiscalibrator::analyze] detid already exists" << std::endl;
         }
       }
  
       theSiStripVector.clear();
       PreviousDetId = DetId;
     }
     obj->setData(noise, theSiStripVector);
   }
   return obj;
 }

References hgcalDigitizer_cfi::noise, and getGTfromDQMFile::obj.

Referenced by analyze().

◆ getNewObject_withDefaults()

std::unique_ptr< SiStripNoises > SiStripNoisesFromDBMiscalibrator::getNewObject_withDefaults	(	const std::map< std::pair< uint32_t, int >, float > &	theMap,
		const float	theDefault
	)

private

Definition at line 295 of file SiStripNoisesFromDBMiscalibrator.cc.

                                                                                  {
   std::unique_ptr<SiStripNoises> obj = std::make_unique<SiStripNoises>();
  
   SiStripDetInfoFileReader reader(fp_.fullPath());
   const std::map<uint32_t, SiStripDetInfoFileReader::DetInfo>& DetInfos = reader.getAllData();
  
   std::vector<uint32_t> missingDetIds;
  
   for (std::map<uint32_t, SiStripDetInfoFileReader::DetInfo>::const_iterator it = DetInfos.begin();
        it != DetInfos.end();
        it++) {
     //Generate Noise for det detid
     bool isMissing(false);
     SiStripNoises::InputVector theSiStripVector;
     for (int t_strip = 0; t_strip < 128 * it->second.nApvs; ++t_strip) {
       std::pair<uint32_t, int> index = std::make_pair(it->first, t_strip);
  
       if (theMap.find(index) == theMap.end()) {
         LogDebug("SiStripNoisesFromDBMiscalibrator") << "detid " << it->first << " \t"
                                                      << " strip " << t_strip << " \t"
                                                      << " not found" << std::endl;
  
         isMissing = true;
         obj->setData(theDefault, theSiStripVector);
  
       } else {
         float noise = theMap.at(index);
         obj->setData(noise, theSiStripVector);
       }
     }
  
     if (isMissing)
       missingDetIds.push_back(it->first);
  
     if (!obj->put(it->first, theSiStripVector)) {
       edm::LogError("SiStripNoisesFromDBMiscalibrator")
           << "[SiStripNoisesFromDBMiscalibrator::analyze] detid already exists" << std::endl;
     }
   }
  
   if (!missingDetIds.empty()) {
     // open output file
     std::stringstream name;
     name << "missing_modules.txt";
     std::ofstream* ofile = new std::ofstream(name.str(), std::ofstream::trunc);
     if (!ofile->is_open())
       throw "cannot open output file!";
     for (const auto& missing : missingDetIds) {
       edm::LogVerbatim("SiStripNoisesFromDBMiscalibrator") << missing << "  " << 1 << std::endl;
       (*ofile) << missing << " " << 1 << std::endl;
       missing_map->fill(missing, 1);
     }
  
     ofile->close();
     delete ofile;
   }
  
   return obj;
 }