MutableTruthiness.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTruthiness_H
#define EDM4EIC_MutableTruthiness_H
 
#include "edm4eic/TruthinessObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/Truthiness.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 <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class TruthinessCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTruthiness
 *  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 MutableTruthiness {
 
  friend class TruthinessCollection;
  friend class TruthinessMutableCollectionIterator;
  friend class Truthiness;
 
public:
  using object_type = Truthiness;
  using collection_type = TruthinessCollection;
 
  /// default constructor
  MutableTruthiness();
 
  /// Constructor initializing all members
  MutableTruthiness(const float truthiness, const edm4eic::TruthinessContribution& associationContribution, const float unassociatedMCParticlesContribution, const float unassociatedRecoParticlesContribution);
 
  /// copy constructor
  MutableTruthiness(const MutableTruthiness& other) = default;
 
  /// copy-assignment operator
  MutableTruthiness& operator=(MutableTruthiness other) &; // Rebind this to other's internal object
  MutableTruthiness& operator=(MutableTruthiness 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
  ~MutableTruthiness() = default;
 
 
public:
 
  /// 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;
 
 
 
  /// Set the Overall truthiness of the entire event
  void setTruthiness(const float truthiness);
  /// Get mutable reference to Overall truthiness of the entire event
  float& getTruthiness();
  /// Get reference to Overall truthiness of the entire event
  [[deprecated("use getTruthiness instead")]]
  float& truthiness();
 
  /// Set the Contribution from all associated particles
  void setAssociationContribution(const edm4eic::TruthinessContribution& associationContribution);
  /// Get mutable reference to Contribution from all associated particles
  edm4eic::TruthinessContribution& getAssociationContribution();
  /// Get reference to Contribution from all associated particles
  [[deprecated("use getAssociationContribution instead")]]
  edm4eic::TruthinessContribution& associationContribution();
 
  /// Set the Contribution from unassociated MC particles
  void setUnassociatedMCParticlesContribution(const float unassociatedMCParticlesContribution);
  /// Get mutable reference to Contribution from unassociated MC particles
  float& getUnassociatedMCParticlesContribution();
  /// Get reference to Contribution from unassociated MC particles
  [[deprecated("use getUnassociatedMCParticlesContribution instead")]]
  float& unassociatedMCParticlesContribution();
 
  /// Set the Contribution from unassociated reconstructed particles
  void setUnassociatedRecoParticlesContribution(const float unassociatedRecoParticlesContribution);
  /// Get mutable reference to Contribution from unassociated reconstructed particles
  float& getUnassociatedRecoParticlesContribution();
  /// Get reference to Contribution from unassociated reconstructed particles
  [[deprecated("use getUnassociatedRecoParticlesContribution instead")]]
  float& unassociatedRecoParticlesContribution();
 
 
 
  void addToAssociations(const edm4eic::MCRecoParticleAssociation&);
  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;
  void addToUnassociatedMCParticles(const edm4hep::MCParticle&);
  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;
  void addToUnassociatedRecoParticles(const edm4eic::ReconstructedParticle&);
  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;
  void addToAssociationContributions(const edm4eic::TruthinessContribution&);
  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 MutableTruthiness& other) const { return m_obj == other.m_obj; }
  bool operator==(const Truthiness& other) const;
 
  bool operator!=(const MutableTruthiness& other) const { return !(*this == other); }
  bool operator!=(const Truthiness& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTruthiness& 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<MutableTruthiness>;
 
  friend void swap(MutableTruthiness& a, MutableTruthiness& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TruthinessObj
  explicit MutableTruthiness(podio::utils::MaybeSharedPtr<TruthinessObj> obj);
 
  podio::utils::MaybeSharedPtr<TruthinessObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTruthiness& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableTruthiness> {
  std::size_t operator()(const edm4eic::MutableTruthiness& obj) const {
    return std::hash<edm4eic::TruthinessObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif