SiStripChannelGainFromDBMiscalibrator Class Reference

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

Inheritance diagram for SiStripChannelGainFromDBMiscalibrator:

Public Member Functions
	SiStripChannelGainFromDBMiscalibrator (const edm::ParameterSet &)
	~SiStripChannelGainFromDBMiscalibrator () 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
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
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< SiStripApvGain >	getNewObject (const std::map< std::pair< uint32_t, int >, float > &theMap)

Private Attributes
const uint32_t	m_gainType
const std::vector< edm::ParameterSet >	m_parameters
const std::string	m_Record
const bool	m_saveMaps
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>
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<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
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 Channel Gain payload from Database

Implementation: Read a SiStrip Channel Gain 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 50 of file SiStripChannelGainFromDBMiscalibrator.cc.

Constructor & Destructor Documentation

SiStripChannelGainFromDBMiscalibrator()

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

explicit

Definition at line 79 of file SiStripChannelGainFromDBMiscalibrator.cc.

    : m_Record{iConfig.getUntrackedParameter<std::string>("record", "SiStripApvGainRcd")},
      m_gainType{iConfig.getUntrackedParameter<uint32_t>("gainType", 1)},
      m_saveMaps{iConfig.getUntrackedParameter<bool>("saveMaps", true)},
      m_parameters{iConfig.getParameter<std::vector<edm::ParameterSet> >("params")} {
  //now do what ever initialization is needed
 
  std::string ss_gain = (m_gainType > 0) ? "G2" : "G1";
 
  scale_map = std::unique_ptr<TrackerMap>(new TrackerMap("scale"));
  scale_map->setTitle("Scale factor averaged by module");
  scale_map->setPalette(1);
 
  smear_map = std::unique_ptr<TrackerMap>(new TrackerMap("smear"));
  smear_map->setTitle("Smear factor averaged by module");
  smear_map->setPalette(1);
 
  ratio_map = std::unique_ptr<TrackerMap>(new TrackerMap("ratio"));
  ratio_map->setTitle("Average by module of the " + ss_gain + " Gain payload ratio (new/old)");
  ratio_map->setPalette(1);
 
  new_payload_map = std::unique_ptr<TrackerMap>(new TrackerMap("new_payload"));
  new_payload_map->setTitle("Tracker Map of Modified " + ss_gain + " Gain payload averaged by module");
  new_payload_map->setPalette(1);
 
  old_payload_map = std::unique_ptr<TrackerMap>(new TrackerMap("old_payload"));
  old_payload_map->setTitle("Tracker Map of Starting " + ss_gain + " Gain Payload averaged by module");
  old_payload_map->setPalette(1);
}

References edm::ParameterSet::getUntrackedParameter(), and AlCaHLTBitMon_QueryRunRegistry::string.

~SiStripChannelGainFromDBMiscalibrator()

SiStripChannelGainFromDBMiscalibrator::~SiStripChannelGainFromDBMiscalibrator ( )

override

Definition at line 109 of file SiStripChannelGainFromDBMiscalibrator.cc.

{}

Member Function Documentation

analyze()

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

overrideprivatevirtual

Implements edm::one::EDAnalyzerBase.

Definition at line 116 of file SiStripChannelGainFromDBMiscalibrator.cc.

                                                                                                       {
  using namespace edm;
 
  edm::ESHandle<TrackerTopology> tTopoHandle;
  iSetup.get<TrackerTopologyRcd>().get(tTopoHandle);
  const auto* const tTopo = tTopoHandle.product();
 
  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;
  }
 
  edm::ESHandle<SiStripGain> SiStripApvGain_;
  iSetup.get<SiStripGainRcd>().get(SiStripApvGain_);
 
  std::map<std::pair<uint32_t, int>, float> theMap, oldPayloadMap;
 
  std::vector<uint32_t> detid;
  SiStripApvGain_->getDetIds(detid);
  for (const auto& d : detid) {
    SiStripApvGain::Range range = SiStripApvGain_->getRange(d, m_gainType);
    float nAPV = 0;
 
    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);
 
    for (int it = 0; it < range.second - range.first; it++) {
      nAPV += 1;
      float Gain = SiStripApvGain_->getApvGain(it, range);
      std::pair<uint32_t, int> index = std::make_pair(d, nAPV);
 
      oldPayloadMap[index] = Gain;
 
      if (params.m_doScale) {
        Gain *= params.m_scaleFactor;
      }
 
      if (params.m_doSmear) {
        float smearedGain = CLHEP::RandGauss::shoot(Gain, params.m_smearFactor);
        Gain = smearedGain;
      }
 
      theMap[index] = Gain;
 
    }  // loop over APVs
  }    // loop over DetIds
 
  std::unique_ptr<SiStripApvGain> theAPVGains = this->getNewObject(theMap);
 
  // make the payload ratio map
  uint32_t cachedId(0);
  SiStripMiscalibrate::Entry gain_ratio;
  SiStripMiscalibrate::Entry o_gain;
  SiStripMiscalibrate::Entry n_gain;
  for (const auto& element : theMap) {
    uint32_t DetId = element.first.first;
    int nAPV = element.first.second;
    float new_gain = element.second;
    float old_gain = oldPayloadMap[std::make_pair(DetId, nAPV)];
 
    // flush the counters
    if (cachedId != 0 && DetId != cachedId) {
      ratio_map->fill(cachedId, gain_ratio.mean());
      old_payload_map->fill(cachedId, o_gain.mean());
      new_payload_map->fill(cachedId, n_gain.mean());
 
      //auto test = new_payload_map.get()->smoduleMap;
 
      gain_ratio.reset();
      o_gain.reset();
      n_gain.reset();
    }
 
    cachedId = DetId;
    gain_ratio.add(new_gain / old_gain);
    o_gain.add(old_gain);
    n_gain.add(new_gain);
  }
 
  // write out the APVGains record
  edm::Service<cond::service::PoolDBOutputService> poolDbService;
 
  if (poolDbService.isAvailable())
    poolDbService->writeOne(theAPVGains.get(), poolDbService->currentTime(), m_Record);
  else
    throw std::runtime_error("PoolDBService required.");
}

References SiStripMiscalibrate::Entry::add(), cond::service::PoolDBOutputService::currentTime(), ztail::d, spr::find(), IntegrityClient_cfi::Gain, edm::EventSetup::get(), get, SiStripGain::getApvGain(), SiStripGain::getDetIds(), getNewObject(), SiStripGain::getRange(), SiStripMiscalibrate::getRegionFromString(), SiStripMiscalibrate::getRegionsFromDetId(), edm::Service< T >::isAvailable(), dqmiolumiharvest::j, m_gainType, m_parameters, m_Record, SiStripMiscalibrate::Entry::mean(), new_payload_map, old_payload_map, CalibrationSummaryClient_cfi::params, edm::ESHandle< T >::product(), FastTimerService_cff::range, ratio_map, HLT_2018_cff::region, SiStripMiscalibrate::Entry::reset(), scale_map, smear_map, AlCaHLTBitMon_QueryRunRegistry::string, and cond::service::PoolDBOutputService::writeOne().

beginJob()

void SiStripChannelGainFromDBMiscalibrator::beginJob ( void  )

overrideprivatevirtual

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 247 of file SiStripChannelGainFromDBMiscalibrator.cc.

{}

endJob()

void SiStripChannelGainFromDBMiscalibrator::endJob ( void  )

overrideprivatevirtual

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 250 of file SiStripChannelGainFromDBMiscalibrator.cc.

                                                   {
  if (m_saveMaps) {
    std::string ss_gain = (m_gainType > 0) ? "G2" : "G1";
 
    scale_map->save(true, 0, 0, ss_gain + "_gain_scale_map.pdf");
    scale_map->save(true, 0, 0, ss_gain + "_gain_scale_map.png");
 
    smear_map->save(true, 0, 0, ss_gain + "_gain_smear_map.pdf");
    smear_map->save(true, 0, 0, ss_gain + "_gain_smear_map.png");
 
    ratio_map->save(true, 0, 0, ss_gain + "_gain_ratio_map.pdf");
    ratio_map->save(true, 0, 0, ss_gain + "_gain_ratio_map.png");
 
    auto range = SiStripMiscalibrate::getTruncatedRange(old_payload_map.get());
 
    old_payload_map->save(true, range.first, range.second, "starting_" + ss_gain + "_gain_payload_map.pdf");
    old_payload_map->save(true, range.first, range.second, "starting_" + ss_gain + "_gain_payload_map.png");
 
    range = SiStripMiscalibrate::getTruncatedRange(new_payload_map.get());
 
    new_payload_map->save(true, range.first, range.second, "new_" + ss_gain + "_gain_payload_map.pdf");
    new_payload_map->save(true, range.first, range.second, "new_" + ss_gain + "_gain_payload_map.png");
  }
}

References SiStripMiscalibrate::getTruncatedRange(), m_gainType, m_saveMaps, new_payload_map, old_payload_map, FastTimerService_cff::range, ratio_map, scale_map, smear_map, and AlCaHLTBitMon_QueryRunRegistry::string.

fillDescriptions()

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

static

Definition at line 309 of file SiStripChannelGainFromDBMiscalibrator.cc.

                                                                                                       {
  edm::ParameterSetDescription desc;
 
  desc.setComment(
      "Creates rescaled / smeared SiStrip Gain payload. Can be used for both G1 and G2."
      "PoolDBOutputService must be set up for 'SiStripApvGainRcd'.");
 
  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<std::string>("record", "SiStripApvGainRcd");
  desc.addUntracked<unsigned int>("gainType", 1);
  desc.addUntracked<bool>("saveMaps", true);
 
  descriptions.add("scaleAndSmearSiStripGains", desc);
}

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), edm::ParameterSetDescription::addUntracked(), edm::ParameterSetDescription::addVPSet(), edm::ParameterSetDescription::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

getNewObject()

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

private

Definition at line 276 of file SiStripChannelGainFromDBMiscalibrator.cc.

                                                         {
  std::unique_ptr<SiStripApvGain> obj = std::unique_ptr<SiStripApvGain>(new SiStripApvGain());
 
  std::vector<float> theSiStripVector;
  uint32_t PreviousDetId = 0;
  for (const auto& element : theMap) {
    uint32_t DetId = element.first.first;
    if (DetId != PreviousDetId) {
      if (!theSiStripVector.empty()) {
        SiStripApvGain::Range range(theSiStripVector.begin(), theSiStripVector.end());
        if (!obj->put(PreviousDetId, range))
          printf("Bug to put detId = %i\n", PreviousDetId);
      }
      theSiStripVector.clear();
      PreviousDetId = DetId;
    }
    theSiStripVector.push_back(element.second);
 
    edm::LogInfo("SiStripChannelGainFromDBMiscalibrator")
        << " DetId: " << DetId << " APV:   " << element.first.second << " Gain:  " << element.second << std::endl;
  }
 
  if (!theSiStripVector.empty()) {
    SiStripApvGain::Range range(theSiStripVector.begin(), theSiStripVector.end());
    if (!obj->put(PreviousDetId, range))
      printf("Bug to put detId = %i\n", PreviousDetId);
  }
 
  return obj;
}

References getGTfromDQMFile::obj, and FastTimerService_cff::range.

Referenced by analyze().

Member Data Documentation

m_gainType

const uint32_t SiStripChannelGainFromDBMiscalibrator::m_gainType

private

Definition at line 65 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by analyze(), and endJob().

m_parameters

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

private

Definition at line 67 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by analyze().

m_Record

const std::string SiStripChannelGainFromDBMiscalibrator::m_Record

private

Definition at line 64 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by analyze().

m_saveMaps

const bool SiStripChannelGainFromDBMiscalibrator::m_saveMaps

private

Definition at line 66 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by endJob().

new_payload_map

std::unique_ptr<TrackerMap> SiStripChannelGainFromDBMiscalibrator::new_payload_map

private

Definition at line 73 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by analyze(), and endJob().

old_payload_map

std::unique_ptr<TrackerMap> SiStripChannelGainFromDBMiscalibrator::old_payload_map

private

Definition at line 72 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by analyze(), and endJob().

ratio_map

std::unique_ptr<TrackerMap> SiStripChannelGainFromDBMiscalibrator::ratio_map

private

Definition at line 71 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by analyze(), and endJob().

scale_map

std::unique_ptr<TrackerMap> SiStripChannelGainFromDBMiscalibrator::scale_map

private

Definition at line 69 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by analyze(), and endJob().

smear_map

std::unique_ptr<TrackerMap> SiStripChannelGainFromDBMiscalibrator::smear_map

private

Definition at line 70 of file SiStripChannelGainFromDBMiscalibrator.cc.

Referenced by analyze(), and endJob().