MutableCluster.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableCluster_H
#define EDM4EIC_MutableCluster_H
 
#include "edm4eic/ClusterObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/Cluster.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 <array>
#include <cstdint>
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class ClusterCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableCluster
 *  EIC hit cluster, reworked to more closely resemble EDM4hep
 *  @author: W. Armstrong, S. Joosten, C.Peng
 */
class MutableCluster {
 
  friend class ClusterCollection;
  friend class ClusterMutableCollectionIterator;
  friend class Cluster;
 
public:
  using object_type = Cluster;
  using collection_type = ClusterCollection;
 
  /// default constructor
  MutableCluster() = default;
 
  /// Constructor initializing all members
  MutableCluster(const std::int32_t type, const float energy, const float energyError, const float time, const float timeError, const std::uint32_t nhits, const edm4hep::Vector3f& position, const edm4eic::Cov3f& positionError, const float radius, const float dispersion, const std::array<float, 3>& principalAxesLengthsXYZ, const std::array<float, 2>& principalAxesLengthsThetaPhi, const float intrinsicTheta, const float intrinsicPhi, const edm4eic::Cov2f& intrinsicDirectionError);
 
  /// copy constructor
  MutableCluster(const MutableCluster& other) = default;
 
  /// copy-assignment operator
  MutableCluster& operator=(MutableCluster other) &; // Rebind this to other's internal object
  MutableCluster& operator=(MutableCluster other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
 
  /// 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
  ~MutableCluster() = default;
 
 
public:
 
  /// 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 Cluster radius [mm].
  float getRadius() const;
 
  /// Access the Cluster dispersion [mm].
  float getDispersion() const;
 
  /// Access the Lengths along the cluster's principal axes [mm], sorted in descending order (equivalent to sqrt of eigenvalues of the position covariance). For an XY planar detector one can expect this to be [sigma_max, sigma_min, 0].
  const std::array<float, 3>& getPrincipalAxesLengthsXYZ() const;
  /// Access item i of the Lengths along the cluster's principal axes [mm], sorted in descending order (equivalent to sqrt of eigenvalues of the position covariance). For an XY planar detector one can expect this to be [sigma_max, sigma_min, 0].
  float getPrincipalAxesLengthsXYZ(size_t i) const;
  /// Access the Lengths along the cluster's principal axes [rad], sorted in descending order.
  const std::array<float, 2>& getPrincipalAxesLengthsThetaPhi() const;
  /// Access item i of the Lengths along the cluster's principal axes [rad], sorted in descending order.
  float getPrincipalAxesLengthsThetaPhi(size_t i) const;
  /// Access the Intrinsic cluster propagation direction polar angle [rad].
  float getIntrinsicTheta() const;
 
  /// Access the Intrinsic cluster propagation direction azimuthal angle [rad]. For an XY planar detector one can expect this to be the tilt of "sigma_max" axis.
  float getIntrinsicPhi() const;
 
  /// Access the Error on the intrinsic cluster propagation direction
  const edm4eic::Cov2f& getIntrinsicDirectionError() const;
 
 
 
  /// Set the Flag-word that defines the type of the cluster
  void setType(const std::int32_t type);
  /// Get mutable reference to Flag-word that defines the type of the cluster
  std::int32_t& getType();
  /// Get reference to Flag-word that defines the type of the cluster
  [[deprecated("use getType instead")]]
  std::int32_t& type();
 
  /// Set the Reconstructed energy of the cluster [GeV].
  void setEnergy(const float energy);
  /// Get mutable reference to Reconstructed energy of the cluster [GeV].
  float& getEnergy();
  /// Get reference to Reconstructed energy of the cluster [GeV].
  [[deprecated("use getEnergy instead")]]
  float& energy();
 
  /// Set the Error on the cluster energy [GeV]
  void setEnergyError(const float energyError);
  /// Get mutable reference to Error on the cluster energy [GeV]
  float& getEnergyError();
  /// Get reference to Error on the cluster energy [GeV]
  [[deprecated("use getEnergyError instead")]]
  float& energyError();
 
  /// Set the [ns]
  void setTime(const float time);
  /// Get mutable reference to [ns]
  float& getTime();
  /// Get reference to [ns]
  [[deprecated("use getTime instead")]]
  float& time();
 
  /// Set the Error on the cluster time
  void setTimeError(const float timeError);
  /// Get mutable reference to Error on the cluster time
  float& getTimeError();
  /// Get reference to Error on the cluster time
  [[deprecated("use getTimeError instead")]]
  float& timeError();
 
  /// Set the Number of hits in the cluster.
  void setNhits(const std::uint32_t nhits);
  /// Get mutable reference to Number of hits in the cluster.
  std::uint32_t& getNhits();
  /// Get reference to Number of hits in the cluster.
  [[deprecated("use getNhits instead")]]
  std::uint32_t& nhits();
 
  /// Set the Global position of the cluster [mm].
  void setPosition(const edm4hep::Vector3f& position);
  /// Get mutable reference to Global position of the cluster [mm].
  edm4hep::Vector3f& getPosition();
  /// Get reference to Global position of the cluster [mm].
  [[deprecated("use getPosition instead")]]
  edm4hep::Vector3f& position();
 
  /// Set the Covariance matrix of the position (6 Parameters).
  void setPositionError(const edm4eic::Cov3f& positionError);
  /// Get mutable reference to Covariance matrix of the position (6 Parameters).
  edm4eic::Cov3f& getPositionError();
  /// Get reference to Covariance matrix of the position (6 Parameters).
  [[deprecated("use getPositionError instead")]]
  edm4eic::Cov3f& positionError();
 
  /// Set the Cluster radius [mm].
  void setRadius(const float radius);
  /// Get mutable reference to Cluster radius [mm].
  float& getRadius();
  /// Get reference to Cluster radius [mm].
  [[deprecated("use getRadius instead")]]
  float& radius();
 
  /// Set the Cluster dispersion [mm].
  void setDispersion(const float dispersion);
  /// Get mutable reference to Cluster dispersion [mm].
  float& getDispersion();
  /// Get reference to Cluster dispersion [mm].
  [[deprecated("use getDispersion instead")]]
  float& dispersion();
 
  /// Set the Lengths along the cluster's principal axes [mm], sorted in descending order (equivalent to sqrt of eigenvalues of the position covariance). For an XY planar detector one can expect this to be [sigma_max, sigma_min, 0].
  void setPrincipalAxesLengthsXYZ(const std::array<float, 3>& principalAxesLengthsXYZ);
  void setPrincipalAxesLengthsXYZ(size_t i, float value);
  /// Get mutable reference to Lengths along the cluster's principal axes [mm], sorted in descending order (equivalent to sqrt of eigenvalues of the position covariance). For an XY planar detector one can expect this to be [sigma_max, sigma_min, 0].
  std::array<float, 3>& getPrincipalAxesLengthsXYZ();
  /// Get reference to Lengths along the cluster's principal axes [mm], sorted in descending order (equivalent to sqrt of eigenvalues of the position covariance). For an XY planar detector one can expect this to be [sigma_max, sigma_min, 0].
  [[deprecated("use getPrincipalAxesLengthsXYZ instead")]]
  std::array<float, 3>& principalAxesLengthsXYZ();
 
  /// Set the Lengths along the cluster's principal axes [rad], sorted in descending order.
  void setPrincipalAxesLengthsThetaPhi(const std::array<float, 2>& principalAxesLengthsThetaPhi);
  void setPrincipalAxesLengthsThetaPhi(size_t i, float value);
  /// Get mutable reference to Lengths along the cluster's principal axes [rad], sorted in descending order.
  std::array<float, 2>& getPrincipalAxesLengthsThetaPhi();
  /// Get reference to Lengths along the cluster's principal axes [rad], sorted in descending order.
  [[deprecated("use getPrincipalAxesLengthsThetaPhi instead")]]
  std::array<float, 2>& principalAxesLengthsThetaPhi();
 
  /// Set the Intrinsic cluster propagation direction polar angle [rad].
  void setIntrinsicTheta(const float intrinsicTheta);
  /// Get mutable reference to Intrinsic cluster propagation direction polar angle [rad].
  float& getIntrinsicTheta();
  /// Get reference to Intrinsic cluster propagation direction polar angle [rad].
  [[deprecated("use getIntrinsicTheta instead")]]
  float& intrinsicTheta();
 
  /// Set the Intrinsic cluster propagation direction azimuthal angle [rad]. For an XY planar detector one can expect this to be the tilt of "sigma_max" axis.
  void setIntrinsicPhi(const float intrinsicPhi);
  /// Get mutable reference to Intrinsic cluster propagation direction azimuthal angle [rad]. For an XY planar detector one can expect this to be the tilt of "sigma_max" axis.
  float& getIntrinsicPhi();
  /// Get reference to Intrinsic cluster propagation direction azimuthal angle [rad]. For an XY planar detector one can expect this to be the tilt of "sigma_max" axis.
  [[deprecated("use getIntrinsicPhi instead")]]
  float& intrinsicPhi();
 
  /// Set the Error on the intrinsic cluster propagation direction
  void setIntrinsicDirectionError(const edm4eic::Cov2f& intrinsicDirectionError);
  /// Get mutable reference to Error on the intrinsic cluster propagation direction
  edm4eic::Cov2f& getIntrinsicDirectionError();
  /// Get reference to Error on the intrinsic cluster propagation direction
  [[deprecated("use getIntrinsicDirectionError instead")]]
  edm4eic::Cov2f& intrinsicDirectionError();
 
 
 
  void addToClusters(const edm4eic::Cluster&);
  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;
  void addToHits(const edm4eic::CalorimeterHit&);
  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;
  void addToParticleIDs(const edm4hep::ParticleID&);
  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;
  void addToShapeParameters(const float&);
  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;
  void addToHitContributions(const float&);
  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;
  void addToSubdetectorEnergies(const float&);
  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 MutableCluster& other) const { return m_obj == other.m_obj; }
  bool operator==(const Cluster& other) const;
 
  bool operator!=(const MutableCluster& other) const { return !(*this == other); }
  bool operator!=(const Cluster& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableCluster& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend std::hash<MutableCluster>;
 
  friend void swap(MutableCluster& a, MutableCluster& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing ClusterObj
  explicit MutableCluster(podio::utils::MaybeSharedPtr<ClusterObj> obj);
 
  podio::utils::MaybeSharedPtr<ClusterObj> m_obj{new ClusterObj{}, podio::utils::MarkOwned};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableCluster& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableCluster> {
  std::size_t operator()(const edm4eic::MutableCluster& obj) const {
    return std::hash<edm4eic::ClusterObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif