podio::root_utils Namespace Reference

Classes
struct	CollectionBranches

Typedefs
using	CollectionInfoT = std::tuple< int, std::string, bool >

Functions
std::string	idTableName (const std::string &category)
std::string	collInfoName (const std::string &category)
template<class Tree >
TBranch *	getBranch (Tree *chain, const char *name)
template<typename Tree >
TBranch *	getBranch (Tree *chain, const std::string &name)
std::string	refBranch (const std::string &name, size_t index)
std::string	vecBranch (const std::string &name, size_t index)
template<typename BufferT >
void	setCollectionAddresses (const BufferT &collBuffers, const CollectionBranches &branches)
void	readBranchesData (const CollectionBranches &branches, Long64_t entry)
auto	reconstructCollectionInfo (TTree *eventTree, podio::CollectionIDTable const &idTable)

Typedef Documentation

CollectionInfoT

using podio::root_utils::CollectionInfoT = typedef std::tuple<int, std::string, bool>

Definition at line 106 of file rootUtils.h.

Function Documentation

collInfoName()

std::string podio::root_utils::collInfoName ( const std::string &  category )

inline

Name of the branch for storing the collection info for a given category in the meta data tree

Definition at line 58 of file rootUtils.h.

                                                         {
  constexpr static auto suffix = "___CollectionTypeInfo";
  return category + suffix;
}

Referenced by podio::ROOTFrameWriter::finish().

getBranch() [1/2]

template<class Tree >

TBranch * podio::root_utils::getBranch	(	Tree *	chain,
		const char *	name
	)

Definition at line 66 of file rootUtils.h.

                                                  {
  return static_cast<TBranch*>(chain->GetListOfBranches()->FindObject(name));
}

Referenced by podio::createCollectionBranches(), getBranch(), podio::ROOTFrameReader::openFiles(), podio::ROOTLegacyReader::openFiles(), podio::ROOTReader::openFiles(), and reconstructCollectionInfo().

getBranch() [2/2]

template<typename Tree >

TBranch * podio::root_utils::getBranch	(	Tree *	chain,
		const std::string &	name
	)

Definition at line 71 of file rootUtils.h.

                                                       {
  return getBranch(chain, name.c_str());
}

idTableName()

std::string podio::root_utils::idTableName ( const std::string &  category )

inline

Name of the branch for storing the idTable for a given category in the meta data tree

Definition at line 49 of file rootUtils.h.

                                                        {
  constexpr static auto suffix = "___idTable";
  return category + suffix;
}

Referenced by podio::ROOTFrameWriter::finish().

readBranchesData()

void podio::root_utils::readBranchesData ( const CollectionBranches &  branches, Long64_t  entry  )

inline

Definition at line 108 of file rootUtils.h.

                                                                                 {
  // Read all data
  if (branches.data) {
    branches.data->GetEntry(entry);
  }
  for (auto* br : branches.refs) {
    br->GetEntry(entry);
  }
  for (auto* br : branches.vecs) {
    br->GetEntry(entry);
  }
}

reconstructCollectionInfo()

auto podio::root_utils::reconstructCollectionInfo ( TTree *  eventTree, podio::CollectionIDTable const &  idTable  )

inline

reconstruct the collection info from information that is available from other trees in the file.

NOTE: This function is only supposed to be called if there is no "CollectionTypeInfo" branch in the metadata tree, as it assumes that the file has been written with podio previous to #197 where there were no subset collections

Definition at line 130 of file rootUtils.h.

                                                                                               {
  std::vector<CollectionInfoT> collInfo;
 
  for (size_t iColl = 0; iColl < idTable.names().size(); ++iColl) {
    const auto collID = idTable.ids()[iColl];
    const auto& name = idTable.names()[iColl];
 
    if (auto branch = getBranch(eventTree, name.c_str())) {
      const std::string_view bufferClassName = branch->GetClassName();
      // this comes with vector<...Data>, where we only care about the ...
      std::string_view dataClass = bufferClassName;
      dataClass.remove_suffix(5);
      const auto collClass = std::string(dataClass.substr(7)) + "Collection";
      // Assume that there are no subset collections in "old files"
      collInfo.emplace_back(collID, std::move(collClass), false);
    } else {
      std::cerr << "Problems reconstructing collection info for collection: \'" << name << "\'\n";
    }
  }
 
  return collInfo;
}

Referenced by podio::ROOTLegacyReader::openFiles(), and podio::ROOTReader::openFiles().

refBranch()

std::string podio::root_utils::refBranch ( const std::string &  name, size_t  index  )

inline

Definition at line 75 of file rootUtils.h.

                                                                {
  return name + "#" + std::to_string(index);
}

Referenced by podio::createCollectionBranches().

setCollectionAddresses()

template<typename BufferT >

void podio::root_utils::setCollectionAddresses ( const BufferT &  collBuffers, const CollectionBranches &  branches  )

inline

Definition at line 84 of file rootUtils.h.

                                                                                                   {
 
  if (auto buffer = collBuffers.data) {
    branches.data->SetAddress(buffer);
  }
 
  if (auto refCollections = collBuffers.references) {
    for (size_t i = 0; i < refCollections->size(); ++i) {
      branches.refs[i]->SetAddress(&(*refCollections)[i]);
    }
  }
 
  if (auto vecMembers = collBuffers.vectorMembers) {
    for (size_t i = 0; i < vecMembers->size(); ++i) {
      branches.vecs[i]->SetAddress((*vecMembers)[i].second);
    }
  }
}

vecBranch()

std::string podio::root_utils::vecBranch ( const std::string &  name, size_t  index  )

inline

Definition at line 79 of file rootUtils.h.

                                                                {
  return name + "_" + std::to_string(index);
}

Referenced by podio::createCollectionBranches().