Cluster.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_Cluster_H
#define EICD_Cluster_H
 
#include "eicd/ClusterObj.h"
 
#include "eicd/CalorimeterHit.h"
#include "eicd/Cov2f.h"
#include "eicd/Cov3f.h"
#include "edm4hep/ParticleID.h"
#include "edm4hep/Vector3f.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
 
 
namespace eicd {
 
class MutableCluster;
 
/** @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 ClusterCollectionIterator;
 
public:
  /// default constructor
  Cluster();
  Cluster(std::int32_t type, float energy, float energyError, float time, float timeError, std::uint32_t nhits, edm4hep::Vector3f position, eicd::Cov3f positionError, float intrinsicTheta, float intrinsicPhi, eicd::Cov2f intrinsicDirectionError);
 
  /// constructor from existing ClusterObj
  Cluster(ClusterObj* obj);
 
  /// copy constructor
  Cluster(const Cluster& other);
 
  /// copy-assignment operator
  Cluster& operator=(Cluster other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableCluster clone() const;
 
  /// destructor
  ~Cluster();
 
 
public:
 
  /// Access the Flagword that defines the type of the cluster
  const std::int32_t& getType() const;
 
  /// Access the Reconstructed energy of the cluster [GeV].
  const float& getEnergy() const;
 
  /// Access the Error on the cluster energy [GeV]
  const float& getEnergyError() const;
 
  /// Access the [ns]
  const float& getTime() const;
 
  /// Access the Error on the cluster time
  const float& getTimeError() const;
 
  /// Access the Number of hits in the cluster.
  const 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 eicd::Cov3f& getPositionError() const;
 
  /// Access the Intrinsic cluster propagation direction polar angle [rad]
  const float& getIntrinsicTheta() const;
 
  /// Access the Intrinsic cluster propagation direction azimuthal angle [rad]
  const float& getIntrinsicPhi() const;
 
  /// Access the Error on the intrinsic cluster propagation direction
  const eicd::Cov2f& getIntrinsicDirectionError() const;
 
 
 
  unsigned int clusters_size() const;
  eicd::Cluster getClusters(unsigned int) const;
  std::vector<eicd::Cluster>::const_iterator clusters_begin() const;
  std::vector<eicd::Cluster>::const_iterator clusters_end() const;
  podio::RelationRange<eicd::Cluster> getClusters() const;
  unsigned int hits_size() const;
  eicd::CalorimeterHit getHits(unsigned int) const;
  std::vector<eicd::CalorimeterHit>::const_iterator hits_begin() const;
  std::vector<eicd::CalorimeterHit>::const_iterator hits_end() const;
  podio::RelationRange<eicd::CalorimeterHit> getHits() const;
  unsigned int particleIDs_size() const;
  edm4hep::ParticleID getParticleIDs(unsigned int) 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;
  unsigned int shapeParameters_size() const;
  float getShapeParameters(unsigned int) const;
  std::vector<float>::const_iterator shapeParameters_begin() const;
  std::vector<float>::const_iterator shapeParameters_end() const;
  podio::RelationRange<float> getShapeParameters() const;
  unsigned int hitContributions_size() const;
  float getHitContributions(unsigned int) const;
  std::vector<float>::const_iterator hitContributions_begin() const;
  std::vector<float>::const_iterator hitContributions_end() const;
  podio::RelationRange<float> getHitContributions() const;
  unsigned int subdetectorEnergies_size() const;
  float getSubdetectorEnergies(unsigned int) 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 = nullptr; }
 
  bool operator==(const Cluster& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableCluster& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Cluster& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  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:
  ClusterObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const Cluster& value);
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const Cluster& value);
#endif
 
 
} // namespace eicd
 
 
#endif