EDM4eic
EIC data model
Loading...
Searching...
No Matches
MutableCherenkovParticleID.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_MutableCherenkovParticleID_H
4#define EDM4EIC_MutableCherenkovParticleID_H
5
7// Make the immutable class available from its mutable version but not vice versa
9
12#include "podio/RelationRange.h"
13#include <vector>
14
15#include "podio/utilities/MaybeSharedPtr.h"
16
17#include <cstdint>
18
19#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
20#include "nlohmann/json_fwd.hpp"
21#endif
22
23// forward declarations
24namespace edm4eic {
25class CherenkovParticleIDCollection;
26class TrackSegment;
27class MutableTrackSegment;
28}
29
30
31namespace edm4eic {
32
33
34/** @class MutableCherenkovParticleID
35 * Cherenkov detector PID
36 * @author: A. Kiselev, C. Chatterjee, C. Dilks
37 */
39
42 friend class CherenkovParticleID;
43
44public:
47
48 /// default constructor
50
51 /// Constructor initializing all members
53
54 /// copy constructor
56
57 /// copy-assignment operator
59
60 /// create a mutable deep-copy of the object with identical relations
61 /// if cloneRelations=false, the relations are not cloned and will be empty
62 MutableCherenkovParticleID clone(bool cloneRelations=true) const;
63
64 /// destructor
66
67
68public:
69
70 /// Access the Overall photoelectron count
71 float getNpe() const;
72
73 /// Access the Average refractive index at the Cherenkov photons' vertices
74 float getRefractiveIndex() const;
75
76 /// Access the Average energy for these Cherenkov photons [GeV]
77 float getPhotonEnergy() const;
78
79
80 /// Access the reconstructed charged particle
82
83 /// Set the Overall photoelectron count
84 void setNpe(float value);
85 /// Get mutable reference to Overall photoelectron count
86 float& getNpe();
87 /// Get reference to Overall photoelectron count
88 [[deprecated("use getNpe instead")]]
89 float& npe();
90
91 /// Set the Average refractive index at the Cherenkov photons' vertices
92 void setRefractiveIndex(float value);
93 /// Get mutable reference to Average refractive index at the Cherenkov photons' vertices
94 float& getRefractiveIndex();
95 /// Get reference to Average refractive index at the Cherenkov photons' vertices
96 [[deprecated("use getRefractiveIndex instead")]]
97 float& refractiveIndex();
98
99 /// Set the Average energy for these Cherenkov photons [GeV]
100 void setPhotonEnergy(float value);
101 /// Get mutable reference to Average energy for these Cherenkov photons [GeV]
102 float& getPhotonEnergy();
103 /// Get reference to Average energy for these Cherenkov photons [GeV]
104 [[deprecated("use getPhotonEnergy instead")]]
105 float& photonEnergy();
106
107
108 /// Set the reconstructed charged particle
109 void setChargedParticle(const edm4eic::TrackSegment& value);
110
112 std::size_t rawHitAssociations_size() const;
114 std::vector<edm4eic::MCRecoTrackerHitAssociation>::const_iterator rawHitAssociations_begin() const;
115 std::vector<edm4eic::MCRecoTrackerHitAssociation>::const_iterator rawHitAssociations_end() const;
116 podio::RelationRange<edm4eic::MCRecoTrackerHitAssociation> getRawHitAssociations() const;
118 std::size_t hypotheses_size() const;
120 std::vector<edm4eic::CherenkovParticleIDHypothesis>::const_iterator hypotheses_begin() const;
121 std::vector<edm4eic::CherenkovParticleIDHypothesis>::const_iterator hypotheses_end() const;
122 podio::RelationRange<edm4eic::CherenkovParticleIDHypothesis> getHypotheses() const;
123 void addToThetaPhiPhotons(const edm4hep::Vector2f&);
124 std::size_t thetaPhiPhotons_size() const;
125 edm4hep::Vector2f getThetaPhiPhotons(std::size_t) const;
126 std::vector<edm4hep::Vector2f>::const_iterator thetaPhiPhotons_begin() const;
127 std::vector<edm4hep::Vector2f>::const_iterator thetaPhiPhotons_end() const;
128 podio::RelationRange<edm4hep::Vector2f> getThetaPhiPhotons() const;
129
130
131
132 /// check whether the object is actually available
133 bool isAvailable() const;
134 /// disconnect from CherenkovParticleIDObj instance
135 void unlink() { m_obj = podio::utils::MaybeSharedPtr<CherenkovParticleIDObj>{nullptr}; }
136
137 bool operator==(const MutableCherenkovParticleID& other) const { return m_obj == other.m_obj; }
138 bool operator==(const CherenkovParticleID& other) const;
139
140 bool operator!=(const MutableCherenkovParticleID& other) const { return !(*this == other); }
141 bool operator!=(const CherenkovParticleID& other) const { return !(*this == other); }
142
143 // less comparison operator, so that objects can be e.g. stored in sets.
145
146 podio::ObjectID id() const { return getObjectID(); }
147
148 const podio::ObjectID getObjectID() const;
149
151 using std::swap;
152 swap(a.m_obj, b.m_obj); // swap out the internal pointers
153 }
154
155private:
156 /// constructor from existing CherenkovParticleIDObj
157 explicit MutableCherenkovParticleID(podio::utils::MaybeSharedPtr<CherenkovParticleIDObj> obj);
158
159 podio::utils::MaybeSharedPtr<CherenkovParticleIDObj> m_obj{nullptr};
160};
161
162#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
163void to_json(nlohmann::json& j, const MutableCherenkovParticleID& value);
164#endif
165
166
167} // namespace edm4eic
168
169
170#endif
Definition CherenkovParticleIDCollection.h:91
Definition CherenkovParticleID.h:46
Definition CherenkovParticleIDHypothesis.h:19
Definition CherenkovParticleIDCollection.h:62
Definition MCRecoTrackerHitAssociation.h:46
Definition MutableCherenkovParticleID.h:38
std::vector< edm4eic::CherenkovParticleIDHypothesis >::const_iterator hypotheses_begin() const
Definition MutableCherenkovParticleID.cc:121
bool operator!=(const MutableCherenkovParticleID &other) const
Definition MutableCherenkovParticleID.h:140
std::vector< edm4hep::Vector2f >::const_iterator thetaPhiPhotons_begin() const
Definition MutableCherenkovParticleID.cc:157
const podio::ObjectID getObjectID() const
Definition MutableCherenkovParticleID.cc:197
float getPhotonEnergy() const
Access the Average energy for these Cherenkov photons [GeV].
Definition MutableCherenkovParticleID.cc:55
float & photonEnergy()
Get reference to Average energy for these Cherenkov photons [GeV].
Definition MutableCherenkovParticleID.cc:73
bool operator<(const MutableCherenkovParticleID &other) const
Definition MutableCherenkovParticleID.h:144
void setChargedParticle(const edm4eic::TrackSegment &value)
Set the reconstructed charged particle.
Definition MutableCherenkovParticleID.cc:75
friend class CherenkovParticleID
Definition MutableCherenkovParticleID.h:42
float getRefractiveIndex() const
Access the Average refractive index at the Cherenkov photons' vertices.
Definition MutableCherenkovParticleID.cc:54
~MutableCherenkovParticleID()=default
destructor
podio::RelationRange< edm4hep::Vector2f > getThetaPhiPhotons() const
Definition MutableCherenkovParticleID.cc:180
std::vector< edm4eic::CherenkovParticleIDHypothesis >::const_iterator hypotheses_end() const
Definition MutableCherenkovParticleID.cc:127
void addToThetaPhiPhotons(const edm4hep::Vector2f &)
Definition MutableCherenkovParticleID.cc:152
void setPhotonEnergy(float value)
Set the Average energy for these Cherenkov photons [GeV].
Definition MutableCherenkovParticleID.cc:71
MutableCherenkovParticleID(const MutableCherenkovParticleID &other)=default
copy constructor
std::size_t thetaPhiPhotons_size() const
Definition MutableCherenkovParticleID.cc:169
const edm4eic::TrackSegment getChargedParticle() const
Access the reconstructed charged particle.
Definition MutableCherenkovParticleID.cc:57
bool isAvailable() const
check whether the object is actually available
Definition MutableCherenkovParticleID.cc:193
float & refractiveIndex()
Get reference to Average refractive index at the Cherenkov photons' vertices.
Definition MutableCherenkovParticleID.cc:70
bool operator!=(const CherenkovParticleID &other) const
Definition MutableCherenkovParticleID.h:141
podio::RelationRange< edm4eic::CherenkovParticleIDHypothesis > getHypotheses() const
Definition MutableCherenkovParticleID.cc:144
friend void swap(MutableCherenkovParticleID &a, MutableCherenkovParticleID &b)
Definition MutableCherenkovParticleID.h:150
void addToHypotheses(const edm4eic::CherenkovParticleIDHypothesis &)
Definition MutableCherenkovParticleID.cc:116
MutableCherenkovParticleID clone(bool cloneRelations=true) const
Definition MutableCherenkovParticleID.cc:34
void unlink()
disconnect from CherenkovParticleIDObj instance
Definition MutableCherenkovParticleID.h:135
void addToRawHitAssociations(const edm4eic::MCRecoTrackerHitAssociation &)
Definition MutableCherenkovParticleID.cc:80
std::size_t rawHitAssociations_size() const
Definition MutableCherenkovParticleID.cc:97
friend class CherenkovParticleIDCollection
Definition MutableCherenkovParticleID.h:40
std::vector< edm4eic::MCRecoTrackerHitAssociation >::const_iterator rawHitAssociations_end() const
Definition MutableCherenkovParticleID.cc:91
float getNpe() const
Access the Overall photoelectron count.
Definition MutableCherenkovParticleID.cc:53
float & npe()
Get reference to Overall photoelectron count.
Definition MutableCherenkovParticleID.cc:67
std::size_t hypotheses_size() const
Definition MutableCherenkovParticleID.cc:133
MutableCherenkovParticleID & operator=(MutableCherenkovParticleID other)
copy-assignment operator
Definition MutableCherenkovParticleID.cc:29
podio::ObjectID id() const
Definition MutableCherenkovParticleID.h:146
void setRefractiveIndex(float value)
Set the Average refractive index at the Cherenkov photons' vertices.
Definition MutableCherenkovParticleID.cc:68
podio::RelationRange< edm4eic::MCRecoTrackerHitAssociation > getRawHitAssociations() const
Definition MutableCherenkovParticleID.cc:108
void setNpe(float value)
Set the Overall photoelectron count.
Definition MutableCherenkovParticleID.cc:65
std::vector< edm4hep::Vector2f >::const_iterator thetaPhiPhotons_end() const
Definition MutableCherenkovParticleID.cc:163
MutableCherenkovParticleID()
default constructor
Definition MutableCherenkovParticleID.cc:19
std::vector< edm4eic::MCRecoTrackerHitAssociation >::const_iterator rawHitAssociations_begin() const
Definition MutableCherenkovParticleID.cc:85
bool operator==(const MutableCherenkovParticleID &other) const
Definition MutableCherenkovParticleID.h:137
Definition TrackSegment.h:45
Definition CalorimeterHit.cc:17
OrderKey getOrderKey(const edm4eic::CalorimeterHit &obj)
Definition CalorimeterHit.cc:150