pat::CandidateSummaryTable Class Reference

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

Inheritance diagram for pat::CandidateSummaryTable:

Classes
struct	Record

Public Member Functions
virtual void	analyze (const edm::Event &iEvent, const edm::EventSetup &iSetup) override
	CandidateSummaryTable (const edm::ParameterSet &iConfig)
virtual void	endJob () override
	~CandidateSummaryTable ()
Public Member Functions inherited from edm::EDAnalyzer
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzer ()
ModuleDescription const &	moduleDescription () const
std::string	workerType () const
virtual	~EDAnalyzer ()
Public Member Functions inherited from edm::EDConsumerBase
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Private Attributes
std::vector< Record >	collections_
bool	dumpItems_
std::string	logName_
bool	perEvent_
bool	perJob_
std::string	self_
size_t	totalEvents_

Additional Inherited Members
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType
Static Public Member Functions inherited from edm::EDAnalyzer
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
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 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

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 27 of file CandidateSummaryTable.cc.

Constructor & Destructor Documentation

pat::CandidateSummaryTable::CandidateSummaryTable ( const edm::ParameterSet &  iConfig )

explicit

Definition at line 63 of file CandidateSummaryTable.cc.

References collections_, edm::EDConsumerBase::consumesCollector(), edm::ParameterSet::getParameter(), SiPixelRawToDigiRegional_cfi::inputs, and SiStripGain_Fake_cff::Record.

                                                                               :
    totalEvents_(0),
    perEvent_(iConfig.getUntrackedParameter<bool>("perEvent", false)),
    perJob_(iConfig.getUntrackedParameter<bool>("perJob", true)),
    self_(iConfig.getParameter<std::string>("@module_label")),
    logName_(iConfig.getUntrackedParameter<std::string>("logName")),
    dumpItems_(iConfig.getUntrackedParameter<bool>("dumpItems", false))
{
    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) {
        collections_.push_back(Record(*it, consumesCollector()));
    }
}

pat::CandidateSummaryTable::~CandidateSummaryTable

(

)

Definition at line 77 of file CandidateSummaryTable.cc.

                                                 {
}

Member Function Documentation

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

overridevirtual

Implements edm::EDAnalyzer.

Definition at line 81 of file CandidateSummaryTable.cc.

References edm::View< T >::begin(), edm::EventID::event(), edm::Event::getByToken(), i, edm::EventBase::id(), and edm::EventID::run().

                                                                                       {
  using namespace edm;
  using std::setw; using std::left; using std::right; using std::setprecision;

  Handle<View<reco::Candidate> > candidates;
  if (perEvent_) {
        LogInfo(logName_) << "Per Event Table " << logName_ <<
                             " (" << self_ << ", run:event " << iEvent.id().run() << ":" << iEvent.id().event() << ")";
  }
  totalEvents_++;
  for (std::vector<Record>::iterator it = collections_.begin(), ed = collections_.end(); it != ed; ++it) {
    iEvent.getByToken(it->srcToken, candidates);
    if (!candidates.failedToGet()) it->update(*candidates);
    if (perEvent_) {
        LogVerbatim(logName_) << "    " << setw(30) << left  << it->src.encode() << right;
        if (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(logName_) << oss.str();
        }
    }
  }
  if (perEvent_) LogInfo(logName_) << "" ;  // add an empty line
}

void pat::CandidateSummaryTable::endJob ( void  )

overridevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 119 of file CandidateSummaryTable.cc.

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

Member Data Documentation

std::vector<Record> pat::CandidateSummaryTable::collections_

private

Definition at line 54 of file CandidateSummaryTable.cc.

Referenced by CandidateSummaryTable().

bool pat::CandidateSummaryTable::dumpItems_

private

Definition at line 58 of file CandidateSummaryTable.cc.

std::string pat::CandidateSummaryTable::logName_

private

Definition at line 57 of file CandidateSummaryTable.cc.

bool pat::CandidateSummaryTable::perEvent_

private

Definition at line 56 of file CandidateSummaryTable.cc.

bool pat::CandidateSummaryTable::perJob_

private

Definition at line 56 of file CandidateSummaryTable.cc.

std::string pat::CandidateSummaryTable::self_

private

Definition at line 57 of file CandidateSummaryTable.cc.

size_t pat::CandidateSummaryTable::totalEvents_

private

Definition at line 55 of file CandidateSummaryTable.cc.