perftools::EdmEventSize Class Reference

#include <EdmEventSize.h>

Classes
struct	BranchRecord
	the information for each branch More...
struct	Error
	generic exception More...

Public Types
typedef std::vector< BranchRecord >	Branches

Public Member Functions
void	dump (std::ostream &co, bool header=true) const
	dump the ascii table on "co" More...
	EdmEventSize ()
	Constructor. More...
	EdmEventSize (std::string const &fileName, std::string const &treeName="Events")
	Constructor and parse. More...
void	formatNames ()
	transform Branch names in "formatted" prodcut identifiers More...
void	parseFile (std::string const &fileName, std::string const &treeName="Events")
	read file, compute branch size, sort by size More...
void	produceHistos (std::string const &plot, std::string const &file, int top=0) const
	produce histograms and optionally write them in "file" or as "plot" More...
void	sortAlpha ()
	sort by name More...

Private Attributes
Branches	m_branches
std::string	m_fileName
int	m_nEvents

Detailed Description

Measure the size of each product in an edm::event Provides the output as an ascii table or root histograms

Based on the original implementation by Luca Lista

Algorithm: Measure the size of each branch in a tree as the sum of the sizes of all its baskets Estimate the "size in memory" multipling the actual branch size by its compression factor

Author

Vincenzo Innocente

Definition at line 24 of file EdmEventSize.h.

Member Typedef Documentation

Branches

typedef std::vector<BranchRecord> perftools::EdmEventSize::Branches

Definition at line 44 of file EdmEventSize.h.

Constructor & Destructor Documentation

EdmEventSize() [1/2]

perftools::EdmEventSize::EdmEventSize

(

)

Constructor.

Definition at line 72 of file EdmEventSize.cc.

: m_nEvents(0) {}

EdmEventSize() [2/2]

perftools::EdmEventSize::EdmEventSize ( std::string const &  fileName, std::string const &  treeName = "Events"  )

explicit

Constructor and parse.

Definition at line 74 of file EdmEventSize.cc.

                                                                                 : m_nEvents(0) {
    parseFile(fileName);
  }

References MillePedeFileConverter_cfg::fileName, and parseFile().

Member Function Documentation

dump()

void perftools::EdmEventSize::dump	(	std::ostream &	co,
		bool	header = true
	)		const

dump the ascii table on "co"

Definition at line 160 of file EdmEventSize.cc.

                                                           {
    if (header) {
      co << "File " << m_fileName << " Events " << m_nEvents << "\n";
      co << "Branch Name | Average Uncompressed Size (Bytes/Event) | Average Compressed Size (Bytes/Event) \n";
    }
    std::for_each(m_branches.begin(), m_branches.end(), std::bind(detail::dump, std::ref(co), std::placeholders::_1));
  }

References cms::cuda::co, perftools::detail::dump(), RecoTauValidation_cfi::header, m_branches, m_fileName, and m_nEvents.

formatNames()

void perftools::EdmEventSize::formatNames

(

)

transform Branch names in "formatted" prodcut identifiers

Definition at line 151 of file EdmEventSize.cc.

{ std::for_each(m_branches.begin(), m_branches.end(), &detail::shorterName); }

References m_branches, and perftools::detail::shorterName().

parseFile()

void perftools::EdmEventSize::parseFile	(	std::string const &	fileName,
		std::string const &	treeName = "Events"
	)

read file, compute branch size, sort by size

Definition at line 78 of file EdmEventSize.cc.

                                                                                   {
    m_fileName = fileName;
    m_branches.clear();
 
    TFile* file = TFile::Open(fileName.c_str());
    if (file == nullptr || (!(*file).IsOpen()))
      throw Error("unable to open data file " + fileName, 7002);
 
    TObject* o = file->Get(treeName.c_str());
    if (o == nullptr)
      throw Error("no object \"" + treeName + "\" found in file: " + fileName, 7003);
 
    TTree* events = dynamic_cast<TTree*>(o);
    if (events == nullptr)
      throw Error("object \"" + treeName + "\" is not a TTree in file: " + fileName, 7004);
 
    m_nEvents = events->GetEntries();
    if (m_nEvents == 0)
      throw Error("tree \"" + treeName + "\" in file " + fileName + " contains no Events", 7005);
 
    TObjArray* branches = events->GetListOfBranches();
    if (branches == nullptr)
      throw Error("tree \"" + treeName + "\" in file " + fileName + " contains no branches", 7006);
 
    const size_t n = branches->GetEntries();
    m_branches.reserve(n);
    for (size_t i = 0; i < n; ++i) {
      TBranch* b = dynamic_cast<TBranch*>(branches->At(i));
      if (b == nullptr)
        continue;
      std::string const name(b->GetName());
      if (name == "EventAux")
        continue;
      size_type s = getTotalSize(b);
      m_branches.push_back(
          BranchRecord(name, double(s[kCompressed]) / double(m_nEvents), double(s[kUncompressed]) / double(m_nEvents)));
    }
    std::sort(m_branches.begin(),
              m_branches.end(),
              std::bind(std::greater<double>(),
                        std::bind(&BranchRecord::compr_size, std::placeholders::_1),
                        std::bind(&BranchRecord::compr_size, std::placeholders::_2)));
  }

References b, perftools::EdmEventSize::BranchRecord::compr_size, patZpeak::events, geometryDiff::file, MillePedeFileConverter_cfg::fileName, mps_fire::i, m_branches, m_fileName, m_nEvents, dqmiodumpmetadata::n, Skims_PA_cff::name, EcalTangentSkim_cfg::o, alignCSCRings::s, jetUpdater_cfi::sort, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by EdmEventSize().

produceHistos()

void perftools::EdmEventSize::produceHistos	(	std::string const &	plot,
		std::string const &	file,
		int	top = 0
	)		const

produce histograms and optionally write them in "file" or as "plot"

Definition at line 230 of file EdmEventSize.cc.

                                                                                              {
    if (top == 0)
      top = m_branches.size();
    detail::Hist h(top);
    std::for_each(
        m_branches.begin(), m_branches.end(), std::bind(&detail::Hist::fill, std::ref(h), std::placeholders::_1));
    h.finalize();
    if (!plot.empty()) {
      gROOT->SetStyle("Plain");
      gStyle->SetOptStat(kFALSE);
      gStyle->SetOptLogy();
      TCanvas c;
      h.uncompressed.Draw();
      h.compressed.Draw("same");
      c.SaveAs(plot.c_str());
    }
    if (!file.empty()) {
      TFile f(file.c_str(), "RECREATE");
      h.compressed.Write();
      h.uncompressed.Write();
      f.Close();
    }
  }

References c, f, geometryDiff::file, perftools::detail::Hist::fill(), h, m_branches, and plotFactory::plot.

sortAlpha()

void perftools::EdmEventSize::sortAlpha

(

)

sort by name

Definition at line 122 of file EdmEventSize.cc.

                               {
    std::sort(m_branches.begin(),
              m_branches.end(),
              std::bind(std::less<std::string>(),
                        std::bind(&BranchRecord::name, std::placeholders::_1),
                        std::bind(&BranchRecord::name, std::placeholders::_2)));
  }

References m_branches, perftools::EdmEventSize::BranchRecord::name, and jetUpdater_cfi::sort.

Member Data Documentation

m_branches

Branches perftools::EdmEventSize::m_branches

private

Definition at line 69 of file EdmEventSize.h.

Referenced by dump(), formatNames(), parseFile(), produceHistos(), and sortAlpha().

m_fileName

std::string perftools::EdmEventSize::m_fileName

private

Definition at line 67 of file EdmEventSize.h.

Referenced by dump(), and parseFile().

m_nEvents

int perftools::EdmEventSize::m_nEvents

private

Definition at line 68 of file EdmEventSize.h.

Referenced by dump(), and parseFile().