LumiOutputBranches Class Reference

#include <LumiOutputBranches.h>

Classes
struct	NamedBranchPtr

Public Member Functions
void	branch (TTree &tree)
void	defineBranchesFromFirstEvent (const nanoaod::FlatTable &tab)
void	fill (const edm::LuminosityBlockForOutput &iLumi, TTree &tree, bool extensions)
	LumiOutputBranches (const edm::BranchDescription *desc, const edm::EDGetToken &token)

Private Types
enum	{ IsMain = 0, IsExtension = 1, DontKnowYetIfMainOrExtension = 2 }
typedef Int_t	CounterType

Private Member Functions
template<typename T >
void	fillColumn (NamedBranchPtr &pair, const nanoaod::FlatTable &tab)

Private Attributes
std::string	m_baseName
bool	m_branchesBooked
CounterType	m_counter
TBranch *	m_counterBranch
std::string	m_doc
enum LumiOutputBranches:: { ... }	m_extension
std::vector< NamedBranchPtr >	m_floatBranches
std::vector< NamedBranchPtr >	m_intBranches
bool	m_singleton
edm::EDGetToken	m_token
std::vector< NamedBranchPtr >	m_uint8Branches

Detailed Description

Definition at line 12 of file LumiOutputBranches.h.

Member Typedef Documentation

CounterType

typedef Int_t LumiOutputBranches::CounterType

private

Definition at line 38 of file LumiOutputBranches.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
IsMain
IsExtension
DontKnowYetIfMainOrExtension

Definition at line 36 of file LumiOutputBranches.h.

{ IsMain = 0, IsExtension = 1, DontKnowYetIfMainOrExtension = 2 } m_extension;

Constructor & Destructor Documentation

LumiOutputBranches()

LumiOutputBranches::LumiOutputBranches ( const edm::BranchDescription *  desc, const edm::EDGetToken &  token  )

inline

Definition at line 14 of file LumiOutputBranches.h.

References submitPVResolutionJobs::desc.

      : m_token(token),
        m_singleton(false),
        m_extension(DontKnowYetIfMainOrExtension),
        m_counter(0),
        m_counterBranch(nullptr),
        m_branchesBooked(false) {
    if (desc->className() != "nanoaod::FlatTable")
      throw cms::Exception("Configuration", "NanoAODOutputModule can only write out nanoaod::FlatTable objects");
  }

Member Function Documentation

branch()

void LumiOutputBranches::branch

(

TTree &

tree

)

Definition at line 34 of file LumiOutputBranches.cc.

References electrons_cff::branchName, Exception, IsExtension, m_baseName, m_counter, m_counterBranch, m_doc, m_extension, m_floatBranches, m_intBranches, m_singleton, m_uint8Branches, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by python.cmstools.EventTree::__getattr__(), and fill().

                                           {
  if (!m_singleton) {
    if (m_extension == IsExtension) {
      m_counterBranch = tree.FindBranch(("n" + m_baseName).c_str());
      if (!m_counterBranch) {
        throw cms::Exception("LogicError",
                             "Trying to save an extension table for " + m_baseName +
                                 " before having saved the corresponding main table\n");
      }
    } else {
      if (tree.FindBranch(("n" + m_baseName).c_str()) != nullptr) {
        throw cms::Exception("LogicError", "Trying to save multiple main tables for " + m_baseName + "\n");
      }
      m_counterBranch = tree.Branch(("n" + m_baseName).c_str(), &m_counter, ("n" + m_baseName + "/I").c_str());
      m_counterBranch->SetTitle(m_doc.c_str());
    }
  }
  std::string varsize = m_singleton ? "" : "[n" + m_baseName + "]";
  for (std::vector<NamedBranchPtr> *branches : {&m_floatBranches, &m_intBranches, &m_uint8Branches}) {
    for (auto &pair : *branches) {
      std::string branchName = makeBranchName(m_baseName, pair.name);
      pair.branch =
          tree.Branch(branchName.c_str(), (void *)nullptr, (branchName + varsize + "/" + pair.rootTypeCode).c_str());
      pair.branch->SetTitle(pair.title.c_str());
    }
  }
}

defineBranchesFromFirstEvent()

void LumiOutputBranches::defineBranchesFromFirstEvent

(

const nanoaod::FlatTable &

tab

)

Definition at line 11 of file LumiOutputBranches.cc.

References nanoaod::FlatTable::Bool, nanoaod::FlatTable::columnDoc(), nanoaod::FlatTable::columnName(), nanoaod::FlatTable::columnType(), Exception, nanoaod::FlatTable::Float, mps_fire::i, nanoaod::FlatTable::Int32, m_baseName, m_floatBranches, m_intBranches, m_uint8Branches, nanoaod::FlatTable::name(), nanoaod::FlatTable::nColumns(), AlCaHLTBitMon_QueryRunRegistry::string, nanoaod::FlatTable::UInt8, and trigObjTnPSource_cfi::var.

Referenced by fill().

                                                                                 {
  m_baseName = tab.name();
  for (size_t i = 0; i < tab.nColumns(); i++) {
    const std::string &var = tab.columnName(i);
    switch (tab.columnType(i)) {
      case nanoaod::FlatTable::ColumnType::Float:
        m_floatBranches.emplace_back(var, tab.columnDoc(i), "F");
        break;
      case nanoaod::FlatTable::ColumnType::Int32:
        m_intBranches.emplace_back(var, tab.columnDoc(i), "I");
        break;
      case nanoaod::FlatTable::ColumnType::UInt8:
        m_uint8Branches.emplace_back(var, tab.columnDoc(i), "b");
        break;
      case nanoaod::FlatTable::ColumnType::Bool:
        m_uint8Branches.emplace_back(var, tab.columnDoc(i), "O");
        break;
      default:
        throw cms::Exception("LogicError", "Unsupported type");
    }
  }
}

fill()

void LumiOutputBranches::fill	(	const edm::LuminosityBlockForOutput &	iLumi,
		TTree &	tree,
		bool	extensions
	)

Fill the current table, if extensions == table.extension(). This parameter is used so that the fill is called first for non-extensions and then for extensions

Definition at line 62 of file LumiOutputBranches.cc.

References branch(), defineBranchesFromFirstEvent(), nanoaod::FlatTable::doc(), DontKnowYetIfMainOrExtension, Exception, nanoaod::FlatTable::extension(), edm::OccurrenceForOutput::getByToken(), patZpeak::handle, IsExtension, IsMain, m_branchesBooked, m_counter, m_counterBranch, m_doc, m_extension, m_floatBranches, m_intBranches, m_singleton, m_token, m_uint8Branches, SiStripPI::max, nanoaod::FlatTable::name(), nanoaod::FlatTable::singleton(), nanoaod::FlatTable::size(), findQualityFiles::size, and to_string().

                                                                                                    {
  if (m_extension != DontKnowYetIfMainOrExtension) {
    if (extensions != m_extension)
      return;  // do nothing, wait to be called with the proper flag
  }

  edm::Handle<nanoaod::FlatTable> handle;
  iLumi.getByToken(m_token, handle);
  const nanoaod::FlatTable &tab = *handle;
  auto size = tab.size();
  // ROOT native array size branches may only be signed integers,
  // until this is changed we need to make sure the vector sizes do not exceed that
  if (size > std::numeric_limits<CounterType>::max()) {
    throw cms::Exception("Table " + tab.name() + " size is " + std::to_string(size) +
                         ", is too large for ROOT native array branch");
  }
  m_counter = size;
  m_singleton = tab.singleton();
  if (!m_branchesBooked) {
    m_extension = tab.extension() ? IsExtension : IsMain;
    if (extensions != m_extension)
      return;  // do nothing, wait to be called with the proper flag
    defineBranchesFromFirstEvent(tab);
    m_doc = tab.doc();
    m_branchesBooked = true;
    branch(tree);
  }
  if (!m_singleton && m_extension == IsExtension) {
    if (m_counter != *reinterpret_cast<CounterType *>(m_counterBranch->GetAddress())) {
      throw cms::Exception("LogicError",
                           "Mismatch in number of entries between extension and main table for " + tab.name());
    }
  }
  for (auto &pair : m_floatBranches)
    fillColumn<float>(pair, tab);
  for (auto &pair : m_intBranches)
    fillColumn<int>(pair, tab);
  for (auto &pair : m_uint8Branches)
    fillColumn<uint8_t>(pair, tab);
}

fillColumn()

template<typename T >

void LumiOutputBranches::fillColumn ( NamedBranchPtr &  pair, const nanoaod::FlatTable &  tab  )

inlineprivate

Definition at line 56 of file LumiOutputBranches.h.

References LumiOutputBranches::NamedBranchPtr::branch, nanoaod::FlatTable::columnData(), nanoaod::FlatTable::columnIndex(), Exception, heavyIonCSV_trainingSettings::idx, m_baseName, and LumiOutputBranches::NamedBranchPtr::name.

                                                                     {
    int idx = tab.columnIndex(pair.name);
    if (idx == -1)
      throw cms::Exception("LogicError", "Missing column in input for " + m_baseName + "_" + pair.name);
    pair.branch->SetAddress(const_cast<T *>(&tab.columnData<T>(idx).front()));  // SetAddress should take a const * !
  }

Member Data Documentation

m_baseName

std::string LumiOutputBranches::m_baseName

private

Definition at line 34 of file LumiOutputBranches.h.

Referenced by branch(), defineBranchesFromFirstEvent(), and fillColumn().

m_branchesBooked

bool LumiOutputBranches::m_branchesBooked

private

Definition at line 53 of file LumiOutputBranches.h.

Referenced by fill().

m_counter

CounterType LumiOutputBranches::m_counter

private

Definition at line 39 of file LumiOutputBranches.h.

Referenced by branch(), and fill().

m_counterBranch

TBranch* LumiOutputBranches::m_counterBranch

private

Definition at line 49 of file LumiOutputBranches.h.

Referenced by branch(), and fill().

m_doc

std::string LumiOutputBranches::m_doc

private

Definition at line 37 of file LumiOutputBranches.h.

Referenced by branch(), and fill().

m_extension

enum { ... } LumiOutputBranches::m_extension

Referenced by branch(), and fill().

m_floatBranches

std::vector<NamedBranchPtr> LumiOutputBranches::m_floatBranches

private

Definition at line 50 of file LumiOutputBranches.h.

Referenced by branch(), defineBranchesFromFirstEvent(), and fill().

m_intBranches

std::vector<NamedBranchPtr> LumiOutputBranches::m_intBranches

private

Definition at line 51 of file LumiOutputBranches.h.

Referenced by branch(), defineBranchesFromFirstEvent(), and fill().

m_singleton

bool LumiOutputBranches::m_singleton

private

Definition at line 35 of file LumiOutputBranches.h.

Referenced by branch(), and fill().

m_token

edm::EDGetToken LumiOutputBranches::m_token

private

Definition at line 33 of file LumiOutputBranches.h.

Referenced by fill().

m_uint8Branches

std::vector<NamedBranchPtr> LumiOutputBranches::m_uint8Branches

private

Definition at line 52 of file LumiOutputBranches.h.

Referenced by branch(), defineBranchesFromFirstEvent(), and fill().