EDM4eic
EIC data model
Loading...
Searching...
No Matches
ReconstructedParticle.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_ReconstructedParticle_H
4#define EDM4EIC_ReconstructedParticle_H
5
7
8#include "edm4eic/Cluster.h"
9#include "edm4eic/Cov4f.h"
10#include "edm4eic/Track.h"
11#include "edm4hep/ParticleID.h"
12#include "edm4hep/Vector3f.h"
13#include "podio/RelationRange.h"
14#include <cstdint>
15#include <vector>
16
17#include "podio/utilities/MaybeSharedPtr.h"
18#include "podio/detail/OrderKey.h"
19
20#include <ostream>
21#include <cstdint>
22
23#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
24#include "nlohmann/json_fwd.hpp"
25#endif
26
27// forward declarations
28namespace edm4eic {
30class Vertex;
31class MutableVertex;
32}
33namespace edm4hep {
34class ParticleID;
35class MutableParticleID;
36}
37
38
39namespace podio::detail {
40// Internal function used in less comparison operators of the datatypes and interface types
41OrderKey getOrderKey(const edm4eic::ReconstructedParticle& obj);
42};
43
44namespace edm4eic {
45
49
50/** @class ReconstructedParticle
51 * EIC Reconstructed Particle
52 * @author: W. Armstrong, S. Joosten, F. Gaede
53 */
55
60 friend podio::detail::OrderKey podio::detail::getOrderKey(const ReconstructedParticle & obj);
61
62public:
65
66 /// default constructor
68
69 /// Constructor initializing all members
70 ReconstructedParticle(const std::int32_t type, const float energy, const edm4hep::Vector3f& momentum, const edm4hep::Vector3f& referencePoint, const float charge, const float mass, const float goodnessOfPID, const edm4eic::Cov4f& covMatrix, const std::int32_t PDG);
71
72 /// copy constructor
74
75 /// copy-assignment operator
76 ReconstructedParticle& operator=(ReconstructedParticle other) &; // Rebind this to other's internal object
77 ReconstructedParticle& operator=(ReconstructedParticle other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
78
79 /// create a mutable deep-copy of the object with identical relations
80 /// if cloneRelations=false, the relations are not cloned and will be empty
81 MutableReconstructedParticle clone(bool cloneRelations=true) const;
82
83 /// destructor
85
86 /// converting constructor from mutable object
88
90
91public:
92
93 static constexpr std::string_view typeName = "edm4eic::ReconstructedParticle";
94
95 /// Access the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
96 std::int32_t getType() const;
97
98 /// Access the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
99 float getEnergy() const;
100
101 /// Access the [GeV] particle momentum. Four momentum state is not kept consistent internally.
102 const edm4hep::Vector3f& getMomentum() const;
103
104 /// Access the [mm] reference, i.e. where the particle has been measured
105 const edm4hep::Vector3f& getReferencePoint() const;
106
107 /// Access the charge of the reconstructed particle.
108 float getCharge() const;
109
110 /// Access the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
111 float getMass() const;
112
113 /// Access the overall goodness of the PID on a scale of [0;1]
114 float getGoodnessOfPID() const;
115
116 /// Access the covariance matrix of the reconstructed particle 4vector (10 parameters).
117 const edm4eic::Cov4f& getCovMatrix() const;
118
119 /// Access the PDG code for this particle
120 std::int32_t getPDG() const;
121
122
123 /// Access the Start vertex associated to this particle
124 const edm4eic::Vertex getStartVertex() const;
125 /// Access the particle ID used for the kinematics of this particle
126 const edm4hep::ParticleID getParticleIDUsed() const;
127
128 std::size_t clusters_size() const;
129 edm4eic::Cluster getClusters(std::size_t) const;
130 std::vector<edm4eic::Cluster>::const_iterator clusters_begin() const;
131 std::vector<edm4eic::Cluster>::const_iterator clusters_end() const;
132 podio::RelationRange<edm4eic::Cluster> getClusters() const;
133 std::size_t tracks_size() const;
134 edm4eic::Track getTracks(std::size_t) const;
135 std::vector<edm4eic::Track>::const_iterator tracks_begin() const;
136 std::vector<edm4eic::Track>::const_iterator tracks_end() const;
137 podio::RelationRange<edm4eic::Track> getTracks() const;
138 std::size_t particles_size() const;
140 std::vector<edm4eic::ReconstructedParticle>::const_iterator particles_begin() const;
141 std::vector<edm4eic::ReconstructedParticle>::const_iterator particles_end() const;
142 podio::RelationRange<edm4eic::ReconstructedParticle> getParticles() const;
143 std::size_t particleIDs_size() const;
144 edm4hep::ParticleID getParticleIDs(std::size_t) const;
145 std::vector<edm4hep::ParticleID>::const_iterator particleIDs_begin() const;
146 std::vector<edm4hep::ParticleID>::const_iterator particleIDs_end() const;
147 podio::RelationRange<edm4hep::ParticleID> getParticleIDs() const;
148
149 bool isCompound() const {return particles_size() > 0;}
150
151
152 /// check whether the object is actually available
153 bool isAvailable() const;
154 /// disconnect from ReconstructedParticleObj instance
155 void unlink() { m_obj = podio::utils::MaybeSharedPtr<ReconstructedParticleObj>{nullptr}; }
156
157 bool operator==(const ReconstructedParticle& other) const { return m_obj == other.m_obj; }
158 bool operator==(const MutableReconstructedParticle& other) const;
159
160 bool operator!=(const ReconstructedParticle& other) const { return !(*this == other); }
161 bool operator!=(const MutableReconstructedParticle& other) const { return !(*this == other); }
162
163 // less comparison operator, so that objects can be e.g. stored in sets.
165
166 podio::ObjectID id() const { return getObjectID(); }
167
168 const podio::ObjectID getObjectID() const;
169
170 friend std::hash<ReconstructedParticle>;
171
173 using std::swap;
174 swap(a.m_obj, b.m_obj); // swap out the internal pointers
175 }
176
177private:
178 /// constructor from existing ReconstructedParticleObj
179 explicit ReconstructedParticle(podio::utils::MaybeSharedPtr<ReconstructedParticleObj> obj);
181
182 podio::utils::MaybeSharedPtr<ReconstructedParticleObj> m_obj{nullptr};
183};
184
185std::ostream& operator<<(std::ostream& o, const ReconstructedParticle& value);
186
187#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
188void to_json(nlohmann::json& j, const ReconstructedParticle& value);
189#endif
190
191
192} // namespace edm4eic
193
194
195
196template<>
197struct std::hash<edm4eic::ReconstructedParticle> {
198 std::size_t operator()(const edm4eic::ReconstructedParticle& obj) const {
199 return std::hash<edm4eic::ReconstructedParticleObj*>{}(obj.m_obj.get());
200 }
201};
202
203
204// This is needed to avoid triggering opening every library in LD_LIBRARY_PATH
205// until it's fixed in ROOT. See https://github.com/root-project/root/issues/18489
206// and https://github.com/AIDASoft/podio/issues/770
207#if defined(__clang__)
208#pragma clang diagnostic push
209#pragma clang diagnostic ignored "-Wunknown-warning-option"
210#pragma clang diagnostic ignored "-Wdeprecated-redundant-constexpr-static-def"
211#pragma clang diagnostic ignored "-Wdeprecated"
212constexpr std::string_view edm4eic::ReconstructedParticle::typeName;
213#pragma clang diagnostic pop
214#elif defined(__GNUC__)
215#pragma GCC diagnostic push
216#pragma GCC diagnostic ignored "-Wdeprecated"
217constexpr std::string_view edm4eic::ReconstructedParticle::typeName;
218#pragma GCC diagnostic pop
219#endif
220
221#endif
Definition Cluster.h:48
Definition Cov4f.h:18
Definition MutableReconstructedParticle.h:46
Definition MutableVertex.h:38
Definition ReconstructedParticleCollectionData.h:34
Definition ReconstructedParticleCollection.h:137
Definition ReconstructedParticle.h:54
bool operator!=(const ReconstructedParticle &other) const
Definition ReconstructedParticle.h:160
std::size_t particleIDs_size() const
Definition ReconstructedParticle.cc:246
ReconstructedParticle()
default constructor
Definition ReconstructedParticle.cc:22
std::vector< edm4hep::ParticleID >::const_iterator particleIDs_end() const
Definition ReconstructedParticle.cc:240
friend class ReconstructedParticleCollection
Definition ReconstructedParticle.h:57
const edm4eic::Cov4f & getCovMatrix() const
Access the covariance matrix of the reconstructed particle 4vector (10 parameters).
Definition ReconstructedParticle.cc:119
std::size_t clusters_size() const
Definition ReconstructedParticle.cc:150
ReconstructedParticle(const ReconstructedParticle &other)=default
copy constructor
std::size_t tracks_size() const
Definition ReconstructedParticle.cc:182
std::vector< edm4eic::Cluster >::const_iterator clusters_begin() const
Definition ReconstructedParticle.cc:138
std::int32_t getType() const
Access the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeN...
Definition ReconstructedParticle.cc:112
float getGoodnessOfPID() const
Access the overall goodness of the PID on a scale of [0;1].
Definition ReconstructedParticle.cc:118
podio::RelationRange< edm4eic::Cluster > getClusters() const
Definition ReconstructedParticle.cc:161
std::vector< edm4hep::ParticleID >::const_iterator particleIDs_begin() const
Definition ReconstructedParticle.cc:234
podio::ObjectID id() const
Definition ReconstructedParticle.h:166
std::vector< edm4eic::Track >::const_iterator tracks_end() const
Definition ReconstructedParticle.cc:176
friend class MutableReconstructedParticle
Definition ReconstructedParticle.h:56
const edm4hep::Vector3f & getReferencePoint() const
Access the [mm] reference, i.e. where the particle has been measured.
Definition ReconstructedParticle.cc:115
std::int32_t getPDG() const
Access the PDG code for this particle.
Definition ReconstructedParticle.cc:120
MutableReconstructedParticle clone(bool cloneRelations=true) const
Definition ReconstructedParticle.cc:43
ReconstructedParticleCollection collection_type
Definition ReconstructedParticle.h:64
std::vector< edm4eic::Track >::const_iterator tracks_begin() const
Definition ReconstructedParticle.cc:170
const edm4hep::Vector3f & getMomentum() const
Access the [GeV] particle momentum. Four momentum state is not kept consistent internally.
Definition ReconstructedParticle.cc:114
friend void swap(ReconstructedParticle &a, ReconstructedParticle &b)
Definition ReconstructedParticle.h:172
ReconstructedParticle & operator=(ReconstructedParticle other) &
copy-assignment operator
Definition ReconstructedParticle.cc:38
std::vector< edm4eic::ReconstructedParticle >::const_iterator particles_end() const
Definition ReconstructedParticle.cc:208
bool isCompound() const
Definition ReconstructedParticle.h:149
const edm4eic::Vertex getStartVertex() const
Access the Start vertex associated to this particle.
Definition ReconstructedParticle.cc:122
bool operator==(const ReconstructedParticle &other) const
Definition ReconstructedParticle.h:157
friend class ReconstructedParticleCollectionIterator
Definition ReconstructedParticle.h:59
~ReconstructedParticle()=default
destructor
const podio::ObjectID getObjectID() const
Definition ReconstructedParticle.cc:273
bool isAvailable() const
check whether the object is actually available
Definition ReconstructedParticle.cc:269
ReconstructedParticle & operator=(ReconstructedParticle other) &&=delete
float getMass() const
Access the [GeV] mass of the reconstructed particle, set independently from four vector....
Definition ReconstructedParticle.cc:117
float getCharge() const
Access the charge of the reconstructed particle.
Definition ReconstructedParticle.cc:116
float getEnergy() const
Access the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent int...
Definition ReconstructedParticle.cc:113
const edm4hep::ParticleID getParticleIDUsed() const
Access the particle ID used for the kinematics of this particle.
Definition ReconstructedParticle.cc:129
podio::RelationRange< edm4eic::Track > getTracks() const
Definition ReconstructedParticle.cc:193
static constexpr std::string_view typeName
Definition ReconstructedParticle.h:93
std::vector< edm4eic::Cluster >::const_iterator clusters_end() const
Definition ReconstructedParticle.cc:144
std::size_t particles_size() const
Definition ReconstructedParticle.cc:214
std::vector< edm4eic::ReconstructedParticle >::const_iterator particles_begin() const
Definition ReconstructedParticle.cc:202
static ReconstructedParticle makeEmpty()
Definition ReconstructedParticle.cc:108
bool operator<(const ReconstructedParticle &other) const
Definition ReconstructedParticle.h:164
bool operator!=(const MutableReconstructedParticle &other) const
Definition ReconstructedParticle.h:161
MutableReconstructedParticle mutable_type
Definition ReconstructedParticle.h:63
podio::RelationRange< edm4eic::ReconstructedParticle > getParticles() const
Definition ReconstructedParticle.cc:225
void unlink()
disconnect from ReconstructedParticleObj instance
Definition ReconstructedParticle.h:155
podio::RelationRange< edm4hep::ParticleID > getParticleIDs() const
Definition ReconstructedParticle.cc:257
Definition ReconstructedParticleObj.h:29
Definition Track.h:48
Definition Vertex.h:46
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
Definition CalorimeterHit.h:25
Definition CalorimeterHit.h:31
OrderKey getOrderKey(const edm4eic::CalorimeterHit &obj)
Definition CalorimeterHit.cc:150
std::size_t operator()(const edm4eic::ReconstructedParticle &obj) const
Definition ReconstructedParticle.h:198