Cluster.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_Cluster_H
#define EDM4EIC_Cluster_H
 
#include "edm4eic/ClusterObj.h"
 
#include "edm4eic/CalorimeterHit.h"
#include "edm4eic/Cov2f.h"
#include "edm4eic/Cov3f.h"
#include "edm4hep/ParticleID.h"
#include "edm4hep/Vector3f.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
#include "podio/detail/OrderKey.h"
 
#include <ostream>
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class ClusterCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::Cluster& obj);
};
 
namespace edm4eic {
 
class MutableCluster;
class ClusterCollection;
class ClusterCollectionData;
 
/** @class Cluster
 *  EIC hit cluster, reworked to more closely resemble EDM4hep
 *  @author: W. Armstrong, S. Joosten, C.Peng
 */
class Cluster {
 
  friend class MutableCluster;
  friend class ClusterCollection;
  friend class edm4eic::ClusterCollectionData;
  friend class ClusterCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const Cluster & obj);
 
public:
  using mutable_type = MutableCluster;
  using collection_type = ClusterCollection;
 
  /// default constructor
  Cluster();
 
  /// Constructor initializing all members
  Cluster(std::int32_t type, float energy, float energyError, float time, float timeError, std::uint32_t nhits, edm4hep::Vector3f position, edm4eic::Cov3f positionError, float intrinsicTheta, float intrinsicPhi, edm4eic::Cov2f intrinsicDirectionError);
 
  /// copy constructor
  Cluster(const Cluster& other) = default;
 
  /// copy-assignment operator
  Cluster& operator=(Cluster other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableCluster clone(bool cloneRelations=true) const;
 
  /// destructor
  ~Cluster() = default;
 
  /// converting constructor from mutable object
  Cluster(const MutableCluster& other);
 
  static Cluster makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::Cluster";
 
  /// Access the Flag-word that defines the type of the cluster
  std::int32_t getType() const;
 
  /// Access the Reconstructed energy of the cluster [GeV].
  float getEnergy() const;
 
  /// Access the Error on the cluster energy [GeV]
  float getEnergyError() const;
 
  /// Access the [ns]
  float getTime() const;
 
  /// Access the Error on the cluster time
  float getTimeError() const;
 
  /// Access the Number of hits in the cluster.
  std::uint32_t getNhits() const;
 
  /// Access the Global position of the cluster [mm].
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the Covariance matrix of the position (6 Parameters).
  const edm4eic::Cov3f& getPositionError() const;
 
  /// Access the Intrinsic cluster propagation direction polar angle [rad]
  float getIntrinsicTheta() const;
 
  /// Access the Intrinsic cluster propagation direction azimuthal angle [rad]
  float getIntrinsicPhi() const;
 
  /// Access the Error on the intrinsic cluster propagation direction
  const edm4eic::Cov2f& getIntrinsicDirectionError() const;
 
 
 
  std::size_t clusters_size() const;
  edm4eic::Cluster getClusters(std::size_t) const;
  std::vector<edm4eic::Cluster>::const_iterator clusters_begin() const;
  std::vector<edm4eic::Cluster>::const_iterator clusters_end() const;
  podio::RelationRange<edm4eic::Cluster> getClusters() const;
  std::size_t hits_size() const;
  edm4eic::CalorimeterHit getHits(std::size_t) const;
  std::vector<edm4eic::CalorimeterHit>::const_iterator hits_begin() const;
  std::vector<edm4eic::CalorimeterHit>::const_iterator hits_end() const;
  podio::RelationRange<edm4eic::CalorimeterHit> getHits() const;
  std::size_t particleIDs_size() const;
  edm4hep::ParticleID getParticleIDs(std::size_t) const;
  std::vector<edm4hep::ParticleID>::const_iterator particleIDs_begin() const;
  std::vector<edm4hep::ParticleID>::const_iterator particleIDs_end() const;
  podio::RelationRange<edm4hep::ParticleID> getParticleIDs() const;
  std::size_t shapeParameters_size() const;
  float getShapeParameters(std::size_t) const;
  std::vector<float>::const_iterator shapeParameters_begin() const;
  std::vector<float>::const_iterator shapeParameters_end() const;
  podio::RelationRange<float> getShapeParameters() const;
  std::size_t hitContributions_size() const;
  float getHitContributions(std::size_t) const;
  std::vector<float>::const_iterator hitContributions_begin() const;
  std::vector<float>::const_iterator hitContributions_end() const;
  podio::RelationRange<float> getHitContributions() const;
  std::size_t subdetectorEnergies_size() const;
  float getSubdetectorEnergies(std::size_t) const;
  std::vector<float>::const_iterator subdetectorEnergies_begin() const;
  std::vector<float>::const_iterator subdetectorEnergies_end() const;
  podio::RelationRange<float> getSubdetectorEnergies() const;
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from ClusterObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<ClusterObj>{nullptr}; }
 
  bool operator==(const Cluster& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableCluster& other) const;
 
  bool operator!=(const Cluster& other) const { return !(*this == other); }
  bool operator!=(const MutableCluster& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Cluster& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(Cluster& a, Cluster& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing ClusterObj
  explicit Cluster(podio::utils::MaybeSharedPtr<ClusterObj> obj);
  Cluster(ClusterObj* obj);
 
  podio::utils::MaybeSharedPtr<ClusterObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const Cluster& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const Cluster& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif