include/edm4hep/SimTrackerHit.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4HEP_SimTrackerHit_H
0004 #define EDM4HEP_SimTrackerHit_H
0005
0006 #include "edm4hep/SimTrackerHitObj.h"
0007
0008 #include "edm4hep/Vector3d.h"
0009 #include "edm4hep/Vector3f.h"
0010 #include <cmath>
0011 #include <cstdint>
0012 #include <edm4hep/MCParticle.h>
0013 #include <edm4hep/utils/bit_utils.h>
0014
0015 #include "podio/detail/OrderKey.h"
0016 #include "podio/utilities/MaybeSharedPtr.h"
0017
0018 #include <cstdint>
0019 #include <ostream>
0020
0021 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0022 #include "nlohmann/json_fwd.hpp"
0023 #endif
0024
0025 // forward declarations
0026 namespace edm4hep {
0027 class SimTrackerHitCollection;
0028 class MCParticle;
0029 class MutableMCParticle;
0030 } // namespace edm4hep
0031
0032 namespace podio::detail {
0033 // Internal function used in less comparison operators of the datatypes and interface types
0034 OrderKey getOrderKey(const edm4hep::SimTrackerHit& obj);
0035 }; // namespace podio::detail
0036
0037 namespace edm4hep {
0038
0039 class MutableSimTrackerHit;
0040 class SimTrackerHitCollection;
0041 class SimTrackerHitCollectionData;
0042
0043 /** @class SimTrackerHit
0044  *  Simulated tracker hit
0045  *  @author: EDM4hep authors
0046  */
0047 class SimTrackerHit {
0048
0049   friend class MutableSimTrackerHit;
0050   friend class SimTrackerHitCollection;
0051   friend class edm4hep::SimTrackerHitCollectionData;
0052   friend class SimTrackerHitCollectionIterator;
0053   friend podio::detail::OrderKey podio::detail::getOrderKey(const SimTrackerHit& obj);
0054
0055 public:
0056   using mutable_type = MutableSimTrackerHit;
0057   using collection_type = SimTrackerHitCollection;
0058
0059   /// default constructor
0060   SimTrackerHit() = default;
0061
0062   /// Constructor initializing all members
0063   SimTrackerHit(const std::uint64_t cellID, const float eDep, const float time, const float pathLength,
0064                 const std::int32_t quality, const edm4hep::Vector3d& position, const edm4hep::Vector3f& momentum);
0065
0066   /// copy constructor
0067   SimTrackerHit(const SimTrackerHit& other) = default;
0068
0069   /// copy-assignment operator
0070   SimTrackerHit& operator=(SimTrackerHit other) &; // Rebind this to other's internal object
0071   SimTrackerHit&
0072   operator=(SimTrackerHit other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
0073
0074   /// create a mutable deep-copy of the object with identical relations
0075   /// if cloneRelations=false, the relations are not cloned and will be empty
0076   MutableSimTrackerHit clone(bool cloneRelations = true) const;
0077
0078   /// destructor
0079   ~SimTrackerHit() = default;
0080
0081   /// converting constructor from mutable object
0082   SimTrackerHit(const MutableSimTrackerHit& other);
0083
0084   static SimTrackerHit makeEmpty();
0085
0086 public:
0087   static constexpr std::string_view typeName = "edm4hep::SimTrackerHit";
0088
0089   /// Access the ID of the sensor that created this hit
0090   std::uint64_t getCellID() const;
0091
0092   /// Access the energy deposited in the hit [GeV]
0093   float getEDep() const;
0094
0095   /// Access the proper time of the hit in the lab frame [ns]
0096   float getTime() const;
0097
0098   /// Access the path length of the particle in the sensitive material that resulted in this hit
0099   float getPathLength() const;
0100
0101   /// Access the quality bit flag
0102   std::int32_t getQuality() const;
0103
0104   /// Access the the hit position [mm]
0105   const edm4hep::Vector3d& getPosition() const;
0106
0107   /// Access the the 3-momentum of the particle at the hits position [GeV]
0108   const edm4hep::Vector3f& getMomentum() const;
0109
0110   /// Access the MCParticle that caused the hit
0111   const edm4hep::MCParticle getParticle() const;
0112
0113   static constexpr int BITOverlay = 31;
0114   static constexpr int BITProducedBySecondary = 30;
0115   bool isOverlay() const { return getQuality() & (1 << BITOverlay); }
0116   bool isProducedBySecondary() const { return getQuality() & (1 << BITProducedBySecondary); }
0117   double x() const { return getPosition()[0]; }
0118   double y() const { return getPosition()[1]; }
0119   double z() const { return getPosition()[2]; }
0120   double rho() const { return std::hypot(x(), y()); }
0121
0122   /// check whether the object is actually available
0123   bool isAvailable() const;
0124   /// disconnect from SimTrackerHitObj instance
0125   void unlink() { m_obj = podio::utils::MaybeSharedPtr<SimTrackerHitObj>{nullptr}; }
0126
0127   constexpr bool operator==(const SimTrackerHit& other) const { return m_obj == other.m_obj; }
0128   bool operator==(const MutableSimTrackerHit& other) const;
0129
0130   constexpr bool operator!=(const SimTrackerHit& other) const { return !(*this == other); }
0131   bool operator!=(const MutableSimTrackerHit& other) const { return !(*this == other); }
0132
0133   // less comparison operator, so that objects can be e.g. stored in sets.
0134   bool operator<(const SimTrackerHit& other) const {
0135     return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other);
0136   }
0137
0138   podio::ObjectID id() const { return getObjectID(); }
0139
0140   const podio::ObjectID getObjectID() const;
0141
0142   friend std::hash<SimTrackerHit>;
0143
0144   friend void swap(SimTrackerHit& a, SimTrackerHit& b) {
0145     using std::swap;
0146     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0147   }
0148
0149 private:
0150   /// constructor from existing SimTrackerHitObj
0151   explicit SimTrackerHit(podio::utils::MaybeSharedPtr<SimTrackerHitObj> obj);
0152   SimTrackerHit(SimTrackerHitObj* obj);
0153
0154   podio::utils::MaybeSharedPtr<SimTrackerHitObj> m_obj{new SimTrackerHitObj{}, podio::utils::MarkOwned};
0155 };
0156
0157 std::ostream& operator<<(std::ostream& o, const SimTrackerHit& value);
0158
0159 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0160 void to_json(nlohmann::json& j, const SimTrackerHit& value);
0161 #endif
0162
0163 } // namespace edm4hep
0164
0165 template <>
0166 struct std::hash<edm4hep::SimTrackerHit> {
0167   std::size_t operator()(const edm4hep::SimTrackerHit& obj) const {
0168     return std::hash<edm4hep::SimTrackerHitObj*>{}(obj.m_obj.get());
0169   }
0170 };
0171
0172 // This is needed to avoid triggering opening every library in LD_LIBRARY_PATH
0173 // until it's fixed in ROOT. See https://github.com/root-project/root/issues/18489
0174 // and https://github.com/AIDASoft/podio/issues/770
0175 #if defined(__clang__)
0176 #pragma clang diagnostic push
0177 #pragma clang diagnostic ignored "-Wunknown-warning-option"
0178 #pragma clang diagnostic ignored "-Wdeprecated-redundant-constexpr-static-def"
0179 #pragma clang diagnostic ignored "-Wdeprecated"
0180 constexpr std::string_view edm4hep::SimTrackerHit::typeName;
0181 #pragma clang diagnostic pop
0182 #elif defined(__GNUC__)
0183 #pragma GCC diagnostic push
0184 #pragma GCC diagnostic ignored "-Wdeprecated"
0185 constexpr std::string_view edm4hep::SimTrackerHit::typeName;
0186 #pragma GCC diagnostic pop
0187 #endif
0188
0189 #endif