HGCalValidator Class Reference

#include <HGCalValidator.h>

Inheritance diagram for HGCalValidator:

Public Types
using	Histograms = HGCalValidatorHistograms
Public Types inherited from edm::global::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
void	bookHistograms (DQMStore::ConcurrentBooker &, edm::Run const &, edm::EventSetup const &, Histograms &) const override
	Method called to book the DQM histograms. More...
void	cpParametersAndSelection (const Histograms &histograms, std::vector< CaloParticle > const &cPeff, std::vector< SimVertex > const &simVertices, std::vector< size_t > &selected_cPeff) const
void	dqmAnalyze (const edm::Event &, const edm::EventSetup &, const Histograms &) const override
	Method called once per event. More...
	HGCalValidator (const edm::ParameterSet &pset)
	Constructor. More...
	~HGCalValidator () override
	Destructor. More...
Public Member Functions inherited from edm::global::EDAnalyzer< edm::RunCache< HGCalValidatorHistograms >, Args... >
	EDAnalyzer ()=default
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsStreamLuminosityBlocks () const final
bool	wantsStreamRuns () const final
Public Member Functions inherited from edm::global::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzerBase ()
ModuleDescription const &	moduleDescription () 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 const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
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 const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
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)

Protected Attributes
const edm::FileInPath	cummatbudinxo_
edm::EDGetTokenT< Density >	density_
const bool	doCaloParticlePlots_
const bool	dolayerclustersPlots_
std::unique_ptr< HGVHistoProducerAlgo >	histoProducerAlgo_
std::vector< edm::InputTag >	label
edm::EDGetTokenT< std::vector< CaloParticle > >	label_cp_effic
edm::EDGetTokenT< std::vector< CaloParticle > >	label_cp_fake
std::vector< edm::EDGetTokenT< reco::CaloClusterCollection > >	labelToken
edm::EDGetTokenT< HGCRecHitCollection >	recHitsBH_
edm::EDGetTokenT< HGCRecHitCollection >	recHitsEE_
edm::EDGetTokenT< HGCRecHitCollection >	recHitsFH_
const bool	SaveGeneralInfo_
edm::EDGetTokenT< std::vector< SimVertex > >	simVertices_

Private Member Functions
void	fillHitMap (std::map< DetId, const HGCRecHit * > &, const HGCRecHitCollection &, const HGCRecHitCollection &, const HGCRecHitCollection &) const

Private Attributes
CaloParticleSelector	cpSelector
std::map< double, double >	cummatbudg
std::string	dirName_
std::vector< int >	particles_to_monitor_
std::vector< int >	thicknesses_to_monitor_
std::shared_ptr< hgcal::RecHitTools >	tools_
unsigned	totallayers_to_monitor_

Additional Inherited Members
Static Public Member Functions inherited from edm::global::EDAnalyzerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
EDGetToken	consumes (const TypeToGet &id, 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)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Class that produces histograms to validate HGCal Reconstruction performances

Author

HGCal

Definition at line 36 of file HGCalValidator.h.

Member Typedef Documentation

using HGCalValidator::Histograms = HGCalValidatorHistograms

Definition at line 38 of file HGCalValidator.h.

Constructor & Destructor Documentation

HGCalValidator::HGCalValidator

(

const edm::ParameterSet &

pset

)

Constructor.

Definition at line 9 of file HGCalValidator.cc.

References cpSelector, cummatbudg, cummatbudinxo_, density_, dirName_, fmb, edm::FileInPath::fullPath(), edm::ParameterSet::getParameter(), histoProducerAlgo_, label, label_cp_effic, label_cp_fake, labelToken, particles_to_monitor_, recHitsBH_, recHitsEE_, recHitsFH_, simVertices_, AlCaHLTBitMon_QueryRunRegistry::string, thicknesses_to_monitor_, tools_, and totallayers_to_monitor_.

                                                         :
  label(pset.getParameter< std::vector<edm::InputTag> >("label")),
  SaveGeneralInfo_(pset.getUntrackedParameter<bool>("SaveGeneralInfo")),
  doCaloParticlePlots_(pset.getUntrackedParameter<bool>("doCaloParticlePlots")),
  dolayerclustersPlots_(pset.getUntrackedParameter<bool>("dolayerclustersPlots")),
  cummatbudinxo_(pset.getParameter<edm::FileInPath>("cummatbudinxo"))
{

  //In this way we can easily generalize to associations between other objects also.
  const edm::InputTag& label_cp_effic_tag = pset.getParameter< edm::InputTag >("label_cp_effic");
  const edm::InputTag& label_cp_fake_tag = pset.getParameter< edm::InputTag >("label_cp_fake");

  label_cp_effic = consumes<std::vector<CaloParticle> >(label_cp_effic_tag);
  label_cp_fake = consumes<std::vector<CaloParticle> >(label_cp_fake_tag);

  simVertices_ = consumes<std::vector<SimVertex>>(pset.getParameter<edm::InputTag>("simVertices"));

  recHitsEE_ = consumes<HGCRecHitCollection>(edm::InputTag("HGCalRecHit", "HGCEERecHits"));
  recHitsFH_ = consumes<HGCRecHitCollection>(edm::InputTag("HGCalRecHit", "HGCHEFRecHits"));
  recHitsBH_ = consumes<HGCRecHitCollection>(edm::InputTag("HGCalRecHit", "HGCHEBRecHits"));

  density_ = consumes<Density>(edm::InputTag("hgcalLayerClusters"));

  for (auto& itag : label) {
    labelToken.push_back(consumes<reco::CaloClusterCollection>(itag));
  }

  cpSelector = CaloParticleSelector(pset.getParameter<double>("ptMinCP"),
                    pset.getParameter<double>("ptMaxCP"),
                    pset.getParameter<double>("minRapidityCP"),
                    pset.getParameter<double>("maxRapidityCP"),
                    pset.getParameter<int>("minHitCP"),
                    pset.getParameter<double>("tipCP"),
                    pset.getParameter<double>("lipCP"),
                    pset.getParameter<bool>("signalOnlyCP"),
                    pset.getParameter<bool>("intimeOnlyCP"),
                    pset.getParameter<bool>("chargedOnlyCP"),
                    pset.getParameter<bool>("stableOnlyCP"),
                    pset.getParameter<std::vector<int> >("pdgIdCP"));

  tools_.reset(new hgcal::RecHitTools());

  particles_to_monitor_ = pset.getParameter<std::vector<int> >("pdgIdCP");
  totallayers_to_monitor_ = pset.getParameter<int>("totallayers_to_monitor");
  thicknesses_to_monitor_ = pset.getParameter<std::vector<int> >("thicknesses_to_monitor");

  //For the material budget file here
  std::ifstream fmb(cummatbudinxo_.fullPath().c_str());
  double thelay = 0.; double mbg = 0.;
  for (unsigned ilayer = 1; ilayer <= totallayers_to_monitor_; ++ilayer) {
    fmb >> thelay >> mbg;
    cummatbudg.insert( std::pair<double, double>( thelay , mbg ) );
  }

  fmb.close();



  ParameterSet psetForHistoProducerAlgo = pset.getParameter<ParameterSet>("histoProducerAlgoBlock");
  histoProducerAlgo_ = std::make_unique<HGVHistoProducerAlgo>(psetForHistoProducerAlgo);

  dirName_ = pset.getParameter<std::string>("dirName");

}

HGCalValidator::~HGCalValidator ( )

override

Destructor.

Definition at line 75 of file HGCalValidator.cc.

{}

Member Function Documentation

void HGCalValidator::bookHistograms ( DQMStore::ConcurrentBooker &  ibook, edm::Run const &  , edm::EventSetup const &  setup, Histograms &  histograms  ) const

overridevirtual

Method called to book the DQM histograms.

Implements DQMGlobalEDAnalyzer< HGCalValidatorHistograms >.

Definition at line 78 of file HGCalValidator.cc.

References patPFMETCorrections_cff::algo, DQMStore::IBooker::cd(), cummatbudinxo_, TrackerOfflineValidation_Dqm_cff::dirName, dirName_, doCaloParticlePlots_, dolayerclustersPlots_, edm::FileInPath::fullPath(), HGCalValidatorHistograms::histoProducerAlgo, histoProducerAlgo_, edm::InputTag::instance(), edm::InputTag::label(), label, LogDebug, particles_to_monitor_, edm::InputTag::process(), SaveGeneralInfo_, DQMStore::IBooker::setCurrentFolder(), thicknesses_to_monitor_, and totallayers_to_monitor_.

                                                                                                                                            {

  if (SaveGeneralInfo_){
    ibook.cd();
    ibook.setCurrentFolder(dirName_ + "GeneralInfo");
    histoProducerAlgo_->bookInfo(ibook, histograms.histoProducerAlgo);
  }

  if(doCaloParticlePlots_) {
    ibook.cd();

    for (auto const particle : particles_to_monitor_) {
      ibook.setCurrentFolder(dirName_ + "SelectedCaloParticles/" + std::to_string(particle));
      histoProducerAlgo_->bookCaloParticleHistos(ibook, histograms.histoProducerAlgo, particle);
    }
    ibook.cd();
    ibook.setCurrentFolder(dirName_);
  }

  for (unsigned int www=0;www<label.size();www++){
    ibook.cd();
    InputTag algo = label[www];
    string dirName=dirName_;
    if (!algo.process().empty())
      dirName+=algo.process()+"_";
    LogDebug("HGCalValidator") << dirName << "\n";
    if(!algo.label().empty())
      dirName+=algo.label()+"_";
    LogDebug("HGCalValidator") << dirName << "\n";
    if(!algo.instance().empty())
      dirName+=algo.instance()+"_";
    LogDebug("HGCalValidator") << dirName << "\n";

    if (!dirName.empty()){dirName.resize(dirName.size() - 1);}

    LogDebug("HGCalValidator") << dirName << "\n";

    ibook.setCurrentFolder(dirName);

    //Booking histograms concerning with hgcal layer clusters
    if(dolayerclustersPlots_) {
      histoProducerAlgo_->bookClusterHistos(ibook, histograms.histoProducerAlgo, totallayers_to_monitor_, thicknesses_to_monitor_, cummatbudinxo_.fullPath() );
    }

  }//end loop www
}

void HGCalValidator::cpParametersAndSelection	(	const Histograms &	histograms,
		std::vector< CaloParticle > const &	cPeff,
		std::vector< SimVertex > const &	simVertices,
		std::vector< size_t > &	selected_cPeff
	)		const

Definition at line 125 of file HGCalValidator.cc.

References cpSelector, doCaloParticlePlots_, HGCalValidatorHistograms::histoProducerAlgo, and histoProducerAlgo_.

Referenced by dqmAnalyze().

                                                                   {
  selected_cPeff.reserve(cPeff.size());

  size_t j=0;
  for (auto const caloParticle : cPeff) {
    int id = caloParticle.pdgId();

    if(cpSelector(caloParticle,simVertices)) {
      selected_cPeff.push_back(j);
      if(doCaloParticlePlots_) {
    histoProducerAlgo_->fill_caloparticle_histos(histograms.histoProducerAlgo,id,caloParticle,simVertices);
      }
    }
    ++j;
  }//end of loop over caloparticles

}

void HGCalValidator::dqmAnalyze ( const edm::Event &  event, const edm::EventSetup &  setup, const Histograms &  histograms  ) const

override

Method called once per event.

Definition at line 146 of file HGCalValidator.cc.

References caloTruthProducer_cfi::caloParticles, fastPrimaryVertexProducer_cfi::clusters, cpParametersAndSelection(), cummatbudg, density_, dolayerclustersPlots_, fillHitMap(), HGCalValidatorHistograms::histoProducerAlgo, histoProducerAlgo_, label, label_cp_effic, labelToken, LogDebug, LogTrace, recHitsBH_, recHitsEE_, recHitsFH_, SaveGeneralInfo_, HGCalValidator_cfi::simVertices, simVertices_, thicknesses_to_monitor_, tools_, totallayers_to_monitor_, and w.

                                                                                                                     {
  using namespace reco;

  LogDebug("HGCalValidator") << "\n====================================================" << "\n"
                             << "Analyzing new event" << "\n"
                             << "====================================================\n" << "\n";

  edm::Handle<std::vector<SimVertex>> simVerticesHandle;
  event.getByToken(simVertices_, simVerticesHandle);
  std::vector<SimVertex> const & simVertices = *simVerticesHandle;

  edm::Handle<std::vector<CaloParticle> > caloParticleHandle;
  event.getByToken(label_cp_effic, caloParticleHandle);
  std::vector<CaloParticle> const & caloParticles = *caloParticleHandle;

  tools_->getEventSetup(setup);
  histoProducerAlgo_->setRecHitTools(tools_);

  edm::Handle<HGCRecHitCollection> recHitHandleEE;
  event.getByToken(recHitsEE_, recHitHandleEE);
  edm::Handle<HGCRecHitCollection> recHitHandleFH;
  event.getByToken(recHitsFH_, recHitHandleFH);
  edm::Handle<HGCRecHitCollection> recHitHandleBH;
  event.getByToken(recHitsBH_, recHitHandleBH);

  std::map<DetId, const HGCRecHit* > hitMap;
  fillHitMap(hitMap, *recHitHandleEE,*recHitHandleFH,*recHitHandleBH);
  
  //Some general info on layers etc. 
  if (SaveGeneralInfo_){
    histoProducerAlgo_->fill_info_histos(histograms.histoProducerAlgo,totallayers_to_monitor_);
  }

  // ##############################################
  // fill caloparticles histograms
  // ##############################################
  LogTrace("HGCalValidator") << "\n# of CaloParticles: " << caloParticles.size() << "\n";
  std::vector<size_t> selected_cPeff;
  cpParametersAndSelection(histograms, caloParticles, simVertices, selected_cPeff);

  int w=0; //counter counting the number of sets of histograms
  for (unsigned int www=0;www<label.size();www++, w++){ // need to increment w here, since there will be many continues in the loop body

    //get collections from the event
    edm::Handle<reco::CaloClusterCollection> clusterHandle;
    event.getByToken(labelToken[www],clusterHandle);
    const reco::CaloClusterCollection &clusters = *clusterHandle;

    //Density
    edm::Handle<Density> densityHandle;
    event.getByToken( density_, densityHandle);
    const Density &densities = *densityHandle;
  
    // ##############################################
    // fill cluster histograms (LOOP OVER CLUSTERS)
    // ##############################################
    if(!dolayerclustersPlots_){continue;}

    histoProducerAlgo_->fill_generic_cluster_histos(histograms.histoProducerAlgo,
                            w,clusters,densities,caloParticles,
                            hitMap,
                            cummatbudg,totallayers_to_monitor_, 
                            thicknesses_to_monitor_);

    for (unsigned int layerclusterIndex = 0; layerclusterIndex < clusters.size(); layerclusterIndex++) {
      histoProducerAlgo_->fill_cluster_histos(histograms.histoProducerAlgo,w,clusters[layerclusterIndex]);
    }

    LogTrace("HGCalValidator") << "\n# of layer clusters with "
                   << label[www].process()<<":"
                   << label[www].label()<<":"
                   << label[www].instance()
                   << ": " << clusters.size() << "\n";

  } // End of  for (unsigned int www=0;www<label.size();www++){
}

void HGCalValidator::fillHitMap ( std::map< DetId, const HGCRecHit * > &  hitMap, const HGCRecHitCollection &  rechitsEE, const HGCRecHitCollection &  rechitsFH, const HGCRecHitCollection &  rechitsBH  ) const

private

Definition at line 223 of file HGCalValidator.cc.

Referenced by dqmAnalyze().

                                                 {
  hitMap.clear();
  for (const auto& hit : rechitsEE) {
    hitMap.emplace(hit.detid(), &hit);
  }

  for (const auto& hit : rechitsFH) {
    hitMap.emplace(hit.detid(), &hit);
  }

  for (const auto& hit : rechitsBH) {
    hitMap.emplace(hit.detid(), &hit);
  }
}

Member Data Documentation

CaloParticleSelector HGCalValidator::cpSelector

private

Definition at line 81 of file HGCalValidator.h.

Referenced by cpParametersAndSelection(), and HGCalValidator().

std::map<double, double> HGCalValidator::cummatbudg

private

Definition at line 83 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

const edm::FileInPath HGCalValidator::cummatbudinxo_

protected

Definition at line 61 of file HGCalValidator.h.

Referenced by bookHistograms(), and HGCalValidator().

edm::EDGetTokenT<Density> HGCalValidator::density_

protected

Definition at line 70 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

std::string HGCalValidator::dirName_

private

Definition at line 87 of file HGCalValidator.h.

Referenced by bookHistograms(), and HGCalValidator().

const bool HGCalValidator::doCaloParticlePlots_

protected

Definition at line 59 of file HGCalValidator.h.

Referenced by bookHistograms(), and cpParametersAndSelection().

const bool HGCalValidator::dolayerclustersPlots_

protected

Definition at line 60 of file HGCalValidator.h.

Referenced by bookHistograms(), and dqmAnalyze().

std::unique_ptr<HGVHistoProducerAlgo> HGCalValidator::histoProducerAlgo_

protected

Definition at line 71 of file HGCalValidator.h.

Referenced by bookHistograms(), cpParametersAndSelection(), dqmAnalyze(), and HGCalValidator().

std::vector<edm::InputTag> HGCalValidator::label

protected

Definition at line 57 of file HGCalValidator.h.

Referenced by Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::_sort_list(), bookHistograms(), dqmAnalyze(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::foundIn(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::fullFilename(), HGCalValidator(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::inputEventContent(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputEventContent(), Vispa.Plugins.ConfigEditor.ToolDataAccessor.ToolDataAccessor::properties(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::properties(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::properties(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::readConnections(), Vispa.Plugins.ConfigEditor.ToolDataAccessor.ToolDataAccessor::updateProcess(), and Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::usedBy().

edm::EDGetTokenT<std::vector<CaloParticle> > HGCalValidator::label_cp_effic

protected

Definition at line 64 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

edm::EDGetTokenT<std::vector<CaloParticle> > HGCalValidator::label_cp_fake

protected

Definition at line 65 of file HGCalValidator.h.

Referenced by HGCalValidator().

std::vector<edm::EDGetTokenT<reco::CaloClusterCollection> > HGCalValidator::labelToken

protected

Definition at line 63 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

std::vector<int> HGCalValidator::particles_to_monitor_

private

Definition at line 84 of file HGCalValidator.h.

Referenced by bookHistograms(), and HGCalValidator().

edm::EDGetTokenT<HGCRecHitCollection> HGCalValidator::recHitsBH_

protected

Definition at line 69 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

edm::EDGetTokenT<HGCRecHitCollection> HGCalValidator::recHitsEE_

protected

Definition at line 67 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

edm::EDGetTokenT<HGCRecHitCollection> HGCalValidator::recHitsFH_

protected

Definition at line 68 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

const bool HGCalValidator::SaveGeneralInfo_

protected

Definition at line 58 of file HGCalValidator.h.

Referenced by bookHistograms(), and dqmAnalyze().

edm::EDGetTokenT<std::vector<SimVertex> > HGCalValidator::simVertices_

protected

Definition at line 66 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

std::vector<int> HGCalValidator::thicknesses_to_monitor_

private

Definition at line 86 of file HGCalValidator.h.

Referenced by bookHistograms(), dqmAnalyze(), and HGCalValidator().

std::shared_ptr<hgcal::RecHitTools> HGCalValidator::tools_

private

Definition at line 82 of file HGCalValidator.h.

Referenced by dqmAnalyze(), and HGCalValidator().

unsigned HGCalValidator::totallayers_to_monitor_

private

Definition at line 85 of file HGCalValidator.h.

Referenced by bookHistograms(), dqmAnalyze(), and HGCalValidator().