RingImage.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_RingImage_H
#define EICD_RingImage_H
 
#include "eicd/RingImageConst.h"
#include "eicd/RingImageObj.h"
 
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class RingImage
 *  EIC Ring Image Cluster
 *  @author: S. Joosten, C. Peng
 */
class RingImage {
 
  friend class RingImageCollection;
  friend class RingImageCollectionIterator;
  friend class ConstRingImage;
 
public:
 
  /// default constructor
  RingImage();
  RingImage(eic::Index ID, float npe, eic::VectorXYZ position, eic::VectorXYZ positionError, float theta, float thetaError, float radius, float radiusError);
 
  /// constructor from existing RingImageObj
  RingImage(RingImageObj* obj);
 
  /// copy constructor
  RingImage(const RingImage& other);
 
  /// copy-assignment operator
  RingImage& operator=(const RingImage& other);
 
  /// support cloning (deep-copy)
  RingImage clone() const;
 
  /// destructor
  ~RingImage();
 
  /// conversion to const object
  operator ConstRingImage() const;
 
public:
 
  /// Access the Unique cluster ID
  const eic::Index& ID() const;
 
  /// Access the number of photo-electrons [#]
  const float& npe() const;
 
  /// Access the Global position of the cluster [mm]
  const eic::VectorXYZ& position() const;
 
  /// Access the Error on the position
  const eic::VectorXYZ& positionError() const;
 
  /// Access the opening angle of the ring [rad, 0->pi]
  const float& theta() const;
 
  /// Access the error on the opening angle
  const float& thetaError() const;
 
  /// Access the radius of the best fit ring [mm]
  const float& radius() const;
 
  /// Access the estimated error from the fit [mm]
  const float& radiusError() const;
 
 
 
  /// Set the Unique cluster ID
  void ID(eic::Index value);
  /// Get reference to Unique cluster ID
  eic::Index& ID();
 
  /// Set the number of photo-electrons [#]
  void npe(float 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 Error on the position
  void positionError(eic::VectorXYZ value);
  /// Get reference to Error on the position
  eic::VectorXYZ& positionError();
 
  /// Set the opening angle of the ring [rad, 0->pi]
  void theta(float value);
 
  /// Set the error on the opening angle
  void thetaError(float value);
 
  /// Set the radius of the best fit ring [mm]
  void radius(float value);
 
  /// Set the estimated error from the fit [mm]
  void radiusError(float value);
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RingImageObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const RingImage& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstRingImage& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const RingImage& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  RingImageObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstRingImage& value);
 
} // namespace eic
 
 
#endif