TableOutputBranches Class Reference

#include <TableOutputBranches.h>

Classes
struct	NamedBranchPtr

Public Member Functions
void	branch (TTree &tree)
void	defineBranchesFromFirstEvent (const nanoaod::FlatTable &tab)
void	fill (const edm::OccurrenceForOutput &iWhatever, TTree &tree, bool extensions)
	TableOutputBranches (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 = nullptr
std::string	m_doc
std::vector< NamedBranchPtr >	m_doubleBranches
enum TableOutputBranches:: { ... }	m_extension
std::vector< NamedBranchPtr >	m_floatBranches
std::vector< NamedBranchPtr >	m_int16Branches
std::vector< NamedBranchPtr >	m_int32Branches
std::vector< NamedBranchPtr >	m_int8Branches
bool	m_singleton = false
edm::EDGetToken	m_token
std::vector< NamedBranchPtr >	m_uint16Branches
std::vector< NamedBranchPtr >	m_uint32Branches
std::vector< NamedBranchPtr >	m_uint8Branches

Detailed Description

Definition at line 12 of file TableOutputBranches.h.

Member Typedef Documentation

CounterType

typedef Int_t TableOutputBranches::CounterType

private

Definition at line 33 of file TableOutputBranches.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
IsMain
IsExtension
DontKnowYetIfMainOrExtension

Definition at line 31 of file TableOutputBranches.h.

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

Constructor & Destructor Documentation

TableOutputBranches()

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

inline

Definition at line 14 of file TableOutputBranches.h.

References submitPVResolutionJobs::desc.

      : m_token(token), m_extension(DontKnowYetIfMainOrExtension), 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 TableOutputBranches::branch

(

TTree &

tree

)

Definition at line 50 of file TableOutputBranches.cc.

References electrons_cff::branchName, Exception, IsExtension, m_baseName, m_counter, m_counterBranch, m_doc, m_doubleBranches, m_extension, m_floatBranches, m_int16Branches, m_int32Branches, m_int8Branches, m_singleton, m_uint16Branches, m_uint32Branches, 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_int8Branches,
                                                &m_uint8Branches,
                                                &m_int16Branches,
                                                &m_uint16Branches,
                                                &m_int32Branches,
                                                &m_uint32Branches,
                                                &m_floatBranches,
                                                &m_doubleBranches}) {
    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 TableOutputBranches::defineBranchesFromFirstEvent

(

const nanoaod::FlatTable &

tab

)

Definition at line 12 of file TableOutputBranches.cc.

References nanoaod::FlatTable::Bool, nanoaod::FlatTable::columnDoc(), nanoaod::FlatTable::columnName(), nanoaod::FlatTable::columnType(), nanoaod::FlatTable::Double, Exception, nanoaod::FlatTable::Float, mps_fire::i, nanoaod::FlatTable::Int16, nanoaod::FlatTable::Int32, nanoaod::FlatTable::Int8, m_baseName, m_doubleBranches, m_floatBranches, m_int16Branches, m_int32Branches, m_int8Branches, m_uint16Branches, m_uint32Branches, m_uint8Branches, nanoaod::FlatTable::name(), nanoaod::FlatTable::nColumns(), AlCaHLTBitMon_QueryRunRegistry::string, nanoaod::FlatTable::UInt16, nanoaod::FlatTable::UInt32, 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::Int8:
        m_int8Branches.emplace_back(var, tab.columnDoc(i), "B");
        break;
      case nanoaod::FlatTable::ColumnType::UInt8:
        m_uint8Branches.emplace_back(var, tab.columnDoc(i), "b");
        break;
      case nanoaod::FlatTable::ColumnType::Int16:
        m_int16Branches.emplace_back(var, tab.columnDoc(i), "S");
        break;
      case nanoaod::FlatTable::ColumnType::UInt16:
        m_uint16Branches.emplace_back(var, tab.columnDoc(i), "s");
        break;
      case nanoaod::FlatTable::ColumnType::Int32:
        m_int32Branches.emplace_back(var, tab.columnDoc(i), "I");
        break;
      case nanoaod::FlatTable::ColumnType::UInt32:
        m_uint32Branches.emplace_back(var, tab.columnDoc(i), "i");
        break;
      case nanoaod::FlatTable::ColumnType::Bool:
        m_uint8Branches.emplace_back(var, tab.columnDoc(i), "O");
        break;
      case nanoaod::FlatTable::ColumnType::Float:
        m_floatBranches.emplace_back(var, tab.columnDoc(i), "F");
        break;
      case nanoaod::FlatTable::ColumnType::Double:
        m_doubleBranches.emplace_back(var, tab.columnDoc(i), "D");
        break;
      default:
        throw cms::Exception("LogicError", "Unsupported type");
    }
  }
}

fill()

void TableOutputBranches::fill	(	const edm::OccurrenceForOutput &	iWhatever,
		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 85 of file TableOutputBranches.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_doubleBranches, m_extension, m_floatBranches, m_int16Branches, m_int32Branches, m_int8Branches, m_singleton, m_token, m_uint16Branches, m_uint32Branches, 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;
  iWhatever.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_int8Branches)
    fillColumn<int8_t>(pair, tab);
  for (auto &pair : m_uint8Branches)
    fillColumn<uint8_t>(pair, tab);
  for (auto &pair : m_int16Branches)
    fillColumn<int16_t>(pair, tab);
  for (auto &pair : m_uint16Branches)
    fillColumn<uint16_t>(pair, tab);
  for (auto &pair : m_int32Branches)
    fillColumn<int32_t>(pair, tab);
  for (auto &pair : m_uint32Branches)
    fillColumn<uint32_t>(pair, tab);
  for (auto &pair : m_floatBranches)
    fillColumn<float>(pair, tab);
  for (auto &pair : m_doubleBranches)
    fillColumn<double>(pair, tab);
}

fillColumn()

template<typename T >

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

inlineprivate

Definition at line 56 of file TableOutputBranches.h.

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

                                                                     {
    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(
        tab.size() == 0 ? static_cast<T *>(nullptr)
                        : const_cast<T *>(&tab.columnData<T>(idx).front()));  // SetAddress should take a const * !
  }

Member Data Documentation

m_baseName

std::string TableOutputBranches::m_baseName

private

Definition at line 29 of file TableOutputBranches.h.

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

m_branchesBooked

bool TableOutputBranches::m_branchesBooked

private

Definition at line 53 of file TableOutputBranches.h.

Referenced by fill().

m_counter

CounterType TableOutputBranches::m_counter

private

Definition at line 34 of file TableOutputBranches.h.

Referenced by branch(), and fill().

m_counterBranch

TBranch* TableOutputBranches::m_counterBranch = nullptr

private

Definition at line 44 of file TableOutputBranches.h.

Referenced by branch(), and fill().

m_doc

std::string TableOutputBranches::m_doc

private

Definition at line 32 of file TableOutputBranches.h.

Referenced by branch(), and fill().

m_doubleBranches

std::vector<NamedBranchPtr> TableOutputBranches::m_doubleBranches

private

Definition at line 52 of file TableOutputBranches.h.

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

m_extension

enum { ... } TableOutputBranches::m_extension

Referenced by branch(), and fill().

m_floatBranches

std::vector<NamedBranchPtr> TableOutputBranches::m_floatBranches

private

Definition at line 51 of file TableOutputBranches.h.

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

m_int16Branches

std::vector<NamedBranchPtr> TableOutputBranches::m_int16Branches

private

Definition at line 47 of file TableOutputBranches.h.

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

m_int32Branches

std::vector<NamedBranchPtr> TableOutputBranches::m_int32Branches

private

Definition at line 49 of file TableOutputBranches.h.

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

m_int8Branches

std::vector<NamedBranchPtr> TableOutputBranches::m_int8Branches

private

Definition at line 45 of file TableOutputBranches.h.

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

m_singleton

bool TableOutputBranches::m_singleton = false

private

Definition at line 30 of file TableOutputBranches.h.

Referenced by branch(), and fill().

m_token

edm::EDGetToken TableOutputBranches::m_token

private

Definition at line 28 of file TableOutputBranches.h.

Referenced by fill().

m_uint16Branches

std::vector<NamedBranchPtr> TableOutputBranches::m_uint16Branches

private

Definition at line 48 of file TableOutputBranches.h.

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

m_uint32Branches

std::vector<NamedBranchPtr> TableOutputBranches::m_uint32Branches

private

Definition at line 50 of file TableOutputBranches.h.

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

m_uint8Branches

std::vector<NamedBranchPtr> TableOutputBranches::m_uint8Branches

private

Definition at line 46 of file TableOutputBranches.h.

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