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/ClusterConst.h"
#include "eicd/ClusterObj.h"
 
#include "eicd/CovXYZ.h"
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class Cluster
 *  EIC cluster
 *  @author: W. Armstrong, S. Joosten, C.Peng
 */
class Cluster {
 
  friend class ClusterCollection;
  friend class ClusterCollectionIterator;
  friend class ConstCluster;
 
public:
 
  /// default constructor
  Cluster();
  Cluster(eic::Index ID, float energy, float energyError, float time, std::uint32_t nhits, eic::VectorXYZ position, eic::CovXYZ positionError, float radius, float skewness);
 
  /// constructor from existing ClusterObj
  Cluster(ClusterObj* obj);
 
  /// copy constructor
  Cluster(const Cluster& other);
 
  /// copy-assignment operator
  Cluster& operator=(const Cluster& other);
 
  /// support cloning (deep-copy)
  Cluster clone() const;
 
  /// destructor
  ~Cluster();
 
  /// conversion to const object
  operator ConstCluster() const;
 
public:
 
  /// Access the unique ID for this cluster
  const eic::Index& ID() const;
 
  /// Access the Reconstructed energy of the cluster [GeV].
  const float& energy() const;
 
  /// Access the Error on the cluster energy [GeV]
  const float& energyError() const;
 
  /// Access the [ns]
  const float& time() const;
 
  /// Access the Number of hits in the cluster.
  const std::uint32_t& nhits() const;
 
  /// Access the Global position of the cluster [mm].
  const eic::VectorXYZ& position() const;
 
  /// Access the Covariance matrix of the position (6 Parameters).
  const eic::CovXYZ& positionError() const;
 
  /// Access the shower radius [mm]
  const float& radius() const;
 
  /// Access the shower skewness [unitless]
  const float& skewness() const;
 
 
 
  /// Set the unique ID for this cluster
  void ID(eic::Index value);
  /// Get reference to unique ID for this cluster
  eic::Index& ID();
 
  /// Set the Reconstructed energy of the cluster [GeV].
  void energy(float value);
 
  /// Set the Error on the cluster energy [GeV]
  void energyError(float value);
 
  /// Set the [ns]
  void time(float value);
 
  /// Set the Number of hits in the cluster.
  void nhits(std::uint32_t value);
 
  /// Set the Global position of the cluster [mm].
  void position(eic::VectorXYZ value);
  /// Get reference to Global position of the cluster [mm].
  eic::VectorXYZ& position();
 
  /// Set the Covariance matrix of the position (6 Parameters).
  void positionError(eic::CovXYZ value);
  /// Get reference to Covariance matrix of the position (6 Parameters).
  eic::CovXYZ& positionError();
 
  /// Set the shower radius [mm]
  void radius(float value);
 
  /// Set the shower skewness [unitless]
  void skewness(float value);
 
 
 
 
 
 
  /// 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 ConstCluster& 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;
 
private:
  ClusterObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstCluster& value);
 
} // namespace eic
 
 
#endif