Truthiness.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_Truthiness_H
#define EDM4EIC_Truthiness_H
 
#include "edm4eic/TruthinessObj.h"
 
#include "edm4eic/MCRecoParticleAssociation.h"
#include "edm4eic/ReconstructedParticle.h"
#include "edm4eic/TruthinessContribution.h"
#include "edm4hep/MCParticle.h"
#include "podio/RelationRange.h"
#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 TruthinessCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::Truthiness& obj);
};
 
namespace edm4eic {
 
class MutableTruthiness;
class TruthinessCollection;
class TruthinessCollectionData;
 
/** @class Truthiness
 *  Positive-definite convex norm of how confidently wrong the reconstruction is, with non-negative contributions from various aspects of the reconstruction, where a zero value indicates a perfect reconstruction.
 *  @author: W. Deconinck, S. Colbert
 */
class Truthiness {
 
  friend class MutableTruthiness;
  friend class TruthinessCollection;
  friend class edm4eic::TruthinessCollectionData;
  friend class TruthinessCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const Truthiness & obj);
 
public:
  using mutable_type = MutableTruthiness;
  using collection_type = TruthinessCollection;
 
  /// default constructor
  Truthiness();
 
  /// Constructor initializing all members
  Truthiness(const float truthiness, const edm4eic::TruthinessContribution& associationContribution, const float unassociatedMCParticlesContribution, const float unassociatedRecoParticlesContribution);
 
  /// copy constructor
  Truthiness(const Truthiness& other) = default;
 
  /// copy-assignment operator
  Truthiness& operator=(Truthiness other) &; // Rebind this to other's internal object
  Truthiness& operator=(Truthiness 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
  MutableTruthiness clone(bool cloneRelations=true) const;
 
  /// destructor
  ~Truthiness() = default;
 
  /// converting constructor from mutable object
  Truthiness(const MutableTruthiness& other);
 
  static Truthiness makeEmpty();
 
public:
 
  static constexpr std::string_view typeName = "edm4eic::Truthiness";
 
  /// Access the Overall truthiness of the entire event
  float getTruthiness() const;
 
  /// Access the Contribution from all associated particles
  const edm4eic::TruthinessContribution& getAssociationContribution() const;
 
  /// Access the Contribution from unassociated MC particles
  float getUnassociatedMCParticlesContribution() const;
 
  /// Access the Contribution from unassociated reconstructed particles
  float getUnassociatedRecoParticlesContribution() const;
 
 
 
  std::size_t associations_size() const;
  edm4eic::MCRecoParticleAssociation getAssociations(std::size_t) const;
  std::vector<edm4eic::MCRecoParticleAssociation>::const_iterator associations_begin() const;
  std::vector<edm4eic::MCRecoParticleAssociation>::const_iterator associations_end() const;
  podio::RelationRange<edm4eic::MCRecoParticleAssociation> getAssociations() const;
  std::size_t unassociatedMCParticles_size() const;
  edm4hep::MCParticle getUnassociatedMCParticles(std::size_t) const;
  std::vector<edm4hep::MCParticle>::const_iterator unassociatedMCParticles_begin() const;
  std::vector<edm4hep::MCParticle>::const_iterator unassociatedMCParticles_end() const;
  podio::RelationRange<edm4hep::MCParticle> getUnassociatedMCParticles() const;
  std::size_t unassociatedRecoParticles_size() const;
  edm4eic::ReconstructedParticle getUnassociatedRecoParticles(std::size_t) const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator unassociatedRecoParticles_begin() const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator unassociatedRecoParticles_end() const;
  podio::RelationRange<edm4eic::ReconstructedParticle> getUnassociatedRecoParticles() const;
  std::size_t associationContributions_size() const;
  edm4eic::TruthinessContribution getAssociationContributions(std::size_t) const;
  std::vector<edm4eic::TruthinessContribution>::const_iterator associationContributions_begin() const;
  std::vector<edm4eic::TruthinessContribution>::const_iterator associationContributions_end() const;
  podio::RelationRange<edm4eic::TruthinessContribution> getAssociationContributions() const;
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TruthinessObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TruthinessObj>{nullptr}; }
 
  bool operator==(const Truthiness& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableTruthiness& other) const;
 
  bool operator!=(const Truthiness& other) const { return !(*this == other); }
  bool operator!=(const MutableTruthiness& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Truthiness& 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<Truthiness>;
 
  friend void swap(Truthiness& a, Truthiness& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TruthinessObj
  explicit Truthiness(podio::utils::MaybeSharedPtr<TruthinessObj> obj);
  Truthiness(TruthinessObj* obj);
 
  podio::utils::MaybeSharedPtr<TruthinessObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const Truthiness& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const Truthiness& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::Truthiness> {
  std::size_t operator()(const edm4eic::Truthiness& obj) const {
    return std::hash<edm4eic::TruthinessObj*>{}(obj.m_obj.get());
  }
};
 
 
// This is needed to avoid triggering opening every library in LD_LIBRARY_PATH
// until it's fixed in ROOT. See https://github.com/root-project/root/issues/18489
// and https://github.com/AIDASoft/podio/issues/770
#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunknown-warning-option"
#pragma clang diagnostic ignored "-Wdeprecated-redundant-constexpr-static-def"
#pragma clang diagnostic ignored "-Wdeprecated"
constexpr std::string_view edm4eic::Truthiness::typeName;
#pragma clang diagnostic pop
#elif defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated"
constexpr std::string_view edm4eic::Truthiness::typeName;
#pragma GCC diagnostic pop
#endif
 
#endif