HepMC3 event record library
ReaderRootTree.cc
Go to the documentation of this file.
1// -*- C++ -*-
2//
3// This file is part of HepMC
4// Copyright (C) 2014-2023 The HepMC collaboration (see AUTHORS for details)
5//
6/**
7 * @file ReaderRootTree.cc
8 * @brief Implementation of \b class ReaderRootTree
9 *
10 */
12#include "HepMC3/Units.h"
13#include "HepMC3/Version.h"
14namespace HepMC3
15{
16HEPMC3_DECLARE_READER_FILE(ReaderRootTree)
17
18ReaderRootTree::ReaderRootTree(const std::string &filename):
19 m_tree(nullptr), m_events_count(0), m_tree_name("hepmc3_tree"), m_branch_name("hepmc3_event")
20{
21 m_file = TFile::Open(filename.c_str());
22 if (!init()) return;
23}
24
25
26ReaderRootTree::ReaderRootTree(const std::string &filename, const std::string &treename, const std::string &branchname):
27 m_tree(nullptr), m_events_count(0), m_tree_name(treename), m_branch_name(branchname)
28{
29 m_file = TFile::Open(filename.c_str());
30 if (!init()) return;
31}
32
34{
35 if ( !m_file->IsOpen() )
36 {
37 HEPMC3_ERROR("ReaderRootTree: problem opening file: " << m_file->GetName())
38 return false;
39 }
40
41
42 m_tree = reinterpret_cast<TTree*>(m_file->Get(m_tree_name.c_str()));
43 if (!m_tree)
44 {
45 HEPMC3_ERROR("ReaderRootTree: problem opening tree: " << m_tree_name)
46 return false;
47 }
49 int result = m_tree->SetBranchAddress(m_branch_name.c_str(), &m_event_data);
50 if (result < 0)
51 {
52 HEPMC3_ERROR("ReaderRootTree: problem reading branch tree: " << m_tree_name)
53 return false;
54 }
56 result = m_tree->SetBranchAddress("GenRunInfo", &m_run_info_data);
57 if (result < 0)
58 {
59 HEPMC3_WARNING("ReaderRootTree: problem reading branch tree: GenRunInfo. Will attempt to read GenRunInfoData object.")
60 std::shared_ptr<GenRunInfo> ri = std::make_shared<GenRunInfo>();
61 auto *run = reinterpret_cast<GenRunInfoData*>(m_file->Get("GenRunInfoData"));
62 if (run) {
63 ri->read_data(*run);
64 delete run;
65 set_run_info(ri);
66 HEPMC3_WARNING("ReaderRootTree::init The object was written with HepMC3 version 3.0")
67 } else {
68 HEPMC3_ERROR("ReaderRootTree: problem reading object GenRunInfoData")
69 return false;
70 }
71 }
72 set_run_info(std::make_shared<GenRunInfo>());
73 return true;
74}
75
76bool ReaderRootTree::skip(const int n)
77{
79 return m_events_count <= m_tree->GetEntries();
80}
81
82
83
85{
86 if (m_events_count > m_tree->GetEntries()) return false;
87 m_event_data->particles.clear();
88 m_event_data->vertices.clear();
89 m_event_data->links1.clear();
90 m_event_data->links2.clear();
94
95
102
103
104 m_tree->GetEntry(m_events_count);
106 run_info()->read_data(*m_run_info_data);
107 evt.set_run_info(run_info());
109 return true;
110}
111
113{
114 m_file->Close();
115}
116
118{
119 if ( !m_file->IsOpen() ) return true;
120 if (m_events_count > m_tree->GetEntries()) return true;
121 return false;
122}
123
124} // namespace HepMC3
#define HEPMC3_WARNING(MESSAGE)
Macro for printing HEPMC3_HEPMC3_WARNING messages.
Definition Errors.h:27
#define HEPMC3_ERROR(MESSAGE)
Macro for printing error messages.
Definition Errors.h:24
Definition of class ReaderRootTree.
Definition of class Units.
Stores event-related information.
Definition GenEvent.h:41
void set_run_info(std::shared_ptr< GenRunInfo > run)
Set the GenRunInfo object by smart pointer.
Definition GenEvent.h:141
void read_data(const GenEventData &data)
Fill GenEvent based on GenEventData.
Definition GenEvent.cc:688
GenEvent I/O parsing and serialization for root files based on root TTree.
bool read_event(GenEvent &evt) override
Read event from file.
TTree * m_tree
Tree handler. Public to allow simple access, e.g. custom branches.
ReaderRootTree(const std::string &filename)
Default constructor.
bool failed() override
Get file error state.
bool skip(const int) override
skip events
GenEventData * m_event_data
Pointer to structure that holds event data.
int m_events_count
Events count. Needed to read the tree.
void close() override
Close file.
std::string m_tree_name
Name of TTree.
std::string m_branch_name
Name of TBranch in TTree.
TFile * m_file
File handler.
GenRunInfoData * m_run_info_data
Pointer to structure that holds run info data.
bool init()
init routine
virtual void set_run_info(std::shared_ptr< GenRunInfo > run)
Set the global GenRunInfo object.
Definition Reader.h:56
virtual std::shared_ptr< GenRunInfo > run_info() const
Get the global GenRunInfo object.
Definition Reader.h:44
HepMC3 main namespace.
Stores serializable event information.
std::vector< GenVertexData > vertices
Vertices.
std::vector< int > links2
Second id of the vertex links.
std::vector< std::string > attribute_string
Attribute serialized as string.
std::vector< GenParticleData > particles
Particles.
std::vector< int > links1
First id of the vertex links.
std::vector< std::string > attribute_name
Attribute name.
std::vector< int > attribute_id
Attribute owner id.
Stores serializable run information.
std::vector< std::string > tool_name
Tool names.
std::vector< std::string > tool_version
Tool versions.
std::vector< std::string > attribute_string
Attribute serialized as string.
std::vector< std::string > attribute_name
Attribute name.
std::vector< std::string > tool_description
Tool descriptions.
std::vector< std::string > weight_names
Weight names.