CherenkovParticleID.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_CherenkovParticleID_H
#define EDM4EIC_CherenkovParticleID_H
 
#include "edm4eic/CherenkovParticleIDObj.h"
 
#include "edm4eic/CherenkovParticleIDHypothesis.h"
#include "edm4eic/MCRecoTrackerHitAssociation.h"
#include "podio/RelationRange.h"
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <ostream>
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class TrackSegment;
class MutableTrackSegment;
}
 
 
namespace edm4eic {
 
class MutableCherenkovParticleID;
class CherenkovParticleIDCollection;
class CherenkovParticleIDCollectionData;
 
/** @class CherenkovParticleID
 *  Cherenkov detector PID
 *  @author: A. Kiselev, C. Chatterjee, C. Dilks
 */
class CherenkovParticleID {
 
  friend class MutableCherenkovParticleID;
  friend class CherenkovParticleIDCollection;
  friend class edm4eic::CherenkovParticleIDCollectionData;
  friend class CherenkovParticleIDCollectionIterator;
 
public:
  using mutable_type = MutableCherenkovParticleID;
  using collection_type = CherenkovParticleIDCollection;
 
  /// default constructor
  CherenkovParticleID();
 
  /// Constructor initializing all members
  CherenkovParticleID(float npe, float refractiveIndex, float photonEnergy);
 
  /// copy constructor
  CherenkovParticleID(const CherenkovParticleID& other) = default;
 
  /// copy-assignment operator
  CherenkovParticleID& operator=(CherenkovParticleID other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableCherenkovParticleID clone(bool cloneRelations=true) const;
 
  /// destructor
  ~CherenkovParticleID() = default;
 
  /// converting constructor from mutable object
  CherenkovParticleID(const MutableCherenkovParticleID& other);
 
  static CherenkovParticleID makeEmpty();
 
public:
 
  /// Access the Overall photoelectron count
  float getNpe() const;
 
  /// Access the Average refractive index at the Cherenkov photons' vertices
  float getRefractiveIndex() const;
 
  /// Access the Average energy for these Cherenkov photons [GeV]
  float getPhotonEnergy() const;
 
 
  /// Access the reconstructed charged particle
  const edm4eic::TrackSegment getChargedParticle() const;
 
  std::size_t rawHitAssociations_size() const;
  edm4eic::MCRecoTrackerHitAssociation getRawHitAssociations(std::size_t) const;
  std::vector<edm4eic::MCRecoTrackerHitAssociation>::const_iterator rawHitAssociations_begin() const;
  std::vector<edm4eic::MCRecoTrackerHitAssociation>::const_iterator rawHitAssociations_end() const;
  podio::RelationRange<edm4eic::MCRecoTrackerHitAssociation> getRawHitAssociations() const;
  std::size_t hypotheses_size() const;
  edm4eic::CherenkovParticleIDHypothesis getHypotheses(std::size_t) const;
  std::vector<edm4eic::CherenkovParticleIDHypothesis>::const_iterator hypotheses_begin() const;
  std::vector<edm4eic::CherenkovParticleIDHypothesis>::const_iterator hypotheses_end() const;
  podio::RelationRange<edm4eic::CherenkovParticleIDHypothesis> getHypotheses() const;
  std::size_t thetaPhiPhotons_size() const;
  edm4hep::Vector2f getThetaPhiPhotons(std::size_t) const;
  std::vector<edm4hep::Vector2f>::const_iterator thetaPhiPhotons_begin() const;
  std::vector<edm4hep::Vector2f>::const_iterator thetaPhiPhotons_end() const;
  podio::RelationRange<edm4hep::Vector2f> getThetaPhiPhotons() const;
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from CherenkovParticleIDObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<CherenkovParticleIDObj>{nullptr}; }
 
  bool operator==(const CherenkovParticleID& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableCherenkovParticleID& other) const;
 
  bool operator!=(const CherenkovParticleID& other) const { return !(*this == other); }
  bool operator!=(const MutableCherenkovParticleID& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const CherenkovParticleID& other) const { return m_obj < other.m_obj; }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(CherenkovParticleID& a, CherenkovParticleID& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing CherenkovParticleIDObj
  explicit CherenkovParticleID(podio::utils::MaybeSharedPtr<CherenkovParticleIDObj> obj);
  CherenkovParticleID(CherenkovParticleIDObj* obj);
 
  podio::utils::MaybeSharedPtr<CherenkovParticleIDObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const CherenkovParticleID& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const CherenkovParticleID& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif