Produce a summary table of some candidate collections. More...

Inheritance diagram for pat::CandidateSummaryTable:

Public Member Functions
void	analyze (const edm::Event &iEvent, const edm::EventSetup &iSetup) override

	CandidateSummaryTable (const edm::ParameterSet &iConfig, const pathelpers::RecordCache *)

	~CandidateSummaryTable () override

Public Member Functions inherited from edm::stream::EDAnalyzer< edm::GlobalCache< pathelpers::RecordCache > >
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzer ()=default

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

	EDAnalyzerBase ()

	EDAnalyzerBase (const EDAnalyzerBase &)=delete

ModuleDescription const &	moduleDescription () const

const EDAnalyzerBase &	operator= (const EDAnalyzerBase &)=delete

	~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	globalEndJob (const pathelpers::RecordCache *)

static std::unique_ptr< pathelpers::RecordCache >	initializeGlobalCache (edm::ParameterSet const &conf)

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Attributes
std::vector< std::pair< edm::InputTag, edm::EDGetTokenT< edm::View< reco::Candidate > > > >	srcTokens

Additional Inherited Members
Public Types inherited from edm::stream::EDAnalyzer< edm::GlobalCache< pathelpers::RecordCache > >
typedef CacheContexts< T... >	CacheTypes

typedef CacheTypes::GlobalCache	GlobalCache

typedef AbilityChecker< T... >	HasAbility

typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache

typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext

typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache

typedef CacheTypes::RunCache	RunCache

typedef RunContextT< RunCache, GlobalCache >	RunContext

typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Types inherited from edm::stream::EDAnalyzerBase
typedef EDAnalyzerAdaptorBase	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

Produce a summary table of some candidate collections.

FIXME FIXME Move to CandAlgos

Author: Giovanni Petrucciani

Version

Id: CandidateSummaryTable.cc,v 1.4 2010/02/20 21:00:15 wmtan Exp

Definition at line 78 of file CandidateSummaryTable.cc.

Constructor & Destructor Documentation

◆ CandidateSummaryTable()

pat::CandidateSummaryTable::CandidateSummaryTable	(	const edm::ParameterSet &	iConfig,
		const pathelpers::RecordCache *
	)

explicit

Definition at line 96 of file CandidateSummaryTable.cc.

                                                                                                             {
   const std::vector<edm::InputTag>& inputs = iConfig.getParameter<std::vector<edm::InputTag> >("candidates");
   for (std::vector<edm::InputTag>::const_iterator it = inputs.begin(); it != inputs.end(); ++it) {
     srcTokens.emplace_back(*it, consumes<edm::View<reco::Candidate> >(*it));
   }
 }

References edm::EDConsumerBase::consumes(), edm::ParameterSet::getParameter(), PixelMapPlotter::inputs, and srcTokens.

◆ ~CandidateSummaryTable()

pat::CandidateSummaryTable::~CandidateSummaryTable ( )

override

Definition at line 103 of file CandidateSummaryTable.cc.

103 {}

Member Function Documentation

◆ analyze()

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

overridevirtual

Implements edm::stream::EDAnalyzerBase.

Definition at line 105 of file CandidateSummaryTable.cc.

                                                                                           {
   using namespace edm;
   using std::left;
   using std::right;
   using std::setprecision;
   using std::setw;
  
   Handle<View<reco::Candidate> > candidates;
   if (globalCache()->perEvent_) {
     LogInfo(globalCache()->logName_) << "Per Event Table " << globalCache()->logName_ << " (" << globalCache()->self_
                                      << ", run:event " << iEvent.id().run() << ":" << iEvent.id().event() << ")";
   }
   ++(globalCache()->totalEvents_);
   auto& collections = globalCache()->collections_;
   auto tags = srcTokens.cbegin();
   for (auto it = collections.begin(), ed = collections.end(); it != ed; ++it, ++tags) {
     iEvent.getByToken(tags->second, candidates);
     if (!candidates.failedToGet())
       it->update(*candidates);
     if (globalCache()->perEvent_) {
       LogVerbatim(globalCache()->logName_) << "    " << setw(30) << left << it->src.encode() << right;
       if (globalCache()->dumpItems_) {
         size_t i = 0;
         std::ostringstream oss;
         for (View<reco::Candidate>::const_iterator cand = candidates->begin(), endc = candidates->end(); cand != endc;
              ++cand, ++i) {
           oss << "      [" << setw(3) << i << "]"
               << "  pt " << setw(7) << setprecision(5) << cand->pt() << "  eta " << setw(7) << setprecision(5)
               << cand->eta() << "  phi " << setw(7) << setprecision(5) << cand->phi() << "  et " << setw(7)
               << setprecision(5) << cand->et() << "  phi " << setw(7) << setprecision(5) << cand->phi() << "  charge "
               << setw(2) << cand->charge() << "  id " << setw(7) << cand->pdgId() << "  st " << setw(7)
               << cand->status() << "\n";
         }
         LogVerbatim(globalCache()->logName_) << oss.str();
       }
     }
   }
   if (globalCache()->perEvent_)
     LogInfo(globalCache()->logName_) << "";  // add an empty line
 }

References HLT_FULL_cff::candidates, oniaPATMuonsWithTrigger_cff::collections, mps_fire::i, iEvent, and triggerMatcherToHLTDebug_cfi::tags.

◆ globalEndJob()

void pat::CandidateSummaryTable::globalEndJob ( const pathelpers::RecordCache * rcd )

static

Definition at line 146 of file CandidateSummaryTable.cc.

                                                                             {
   using std::left;
   using std::right;
   using std::setprecision;
   using std::setw;
   if (rcd->perJob_) {
     std::ostringstream oss;
     oss << "Summary Table " << rcd->logName_ << " (" << rcd->self_ << ", events total " << rcd->totalEvents_ << ")\n";
     for (auto it = rcd->collections_.cbegin(), ed = rcd->collections_.cend(); it != ed; ++it) {
       oss << "    " << setw(30) << left << it->src.encode() << right << "  present " << setw(7) << it->present << " ("
           << setw(4) << setprecision(3) << (it->present * 100.0 / rcd->totalEvents_) << "%)"
           << "  empty " << setw(7) << it->empty << " (" << setw(4) << setprecision(3)
           << (it->empty * 100.0 / rcd->totalEvents_) << "%)"
           << "  min " << setw(7) << it->min << "  max " << setw(7) << it->max << "  total " << setw(7) << it->total
           << "  avg " << setw(5) << setprecision(3) << (it->total / double(rcd->totalEvents_)) << "\n";
     }
     oss << "\n";
     edm::LogVerbatim(rcd->logName_) << oss.str();
   }
 }

References pathelpers::RecordCache::collections_, pathelpers::RecordCache::logName_, pathelpers::RecordCache::perJob_, pathelpers::RecordCache::self_, and pathelpers::RecordCache::totalEvents_.

◆ initializeGlobalCache()

static std::unique_ptr<pathelpers::RecordCache> pat::CandidateSummaryTable::initializeGlobalCache ( edm::ParameterSet const & conf )

inlinestatic

Definition at line 83 of file CandidateSummaryTable.cc.

                                                                                                    {
       return std::make_unique<pathelpers::RecordCache>(conf);
     }

Member Data Documentation

◆ srcTokens

std::vector<std::pair<edm::InputTag, edm::EDGetTokenT<edm::View<reco::Candidate> > > > pat::CandidateSummaryTable::srcTokens

private

Definition at line 92 of file CandidateSummaryTable.cc.

Referenced by CandidateSummaryTable().

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members