EICd
EIC data model
eic::ConstRingImage Class Reference

#include <RingImageConst.h>

Public Member Functions

 ConstRingImage ()
 default constructor More...
 
 ConstRingImage (eic::Index ID, float npe, eic::VectorXYZ position, eic::VectorXYZ positionError, float theta, float thetaError, float radius, float radiusError)
 
 ConstRingImage (RingImageObj *obj)
 constructor from existing RingImageObj More...
 
 ConstRingImage (const ConstRingImage &other)
 copy constructor More...
 
ConstRingImageoperator= (const ConstRingImage &other)
 copy-assignment operator More...
 
ConstRingImage clone () const
 support cloning (deep-copy) More...
 
 ~ConstRingImage ()
 destructor More...
 
const eic::IndexID () const
 Access the Unique cluster ID. More...
 
const float & npe () const
 Access the number of photo-electrons [#]. More...
 
const eic::VectorXYZposition () const
 Access the Global position of the cluster [mm]. More...
 
const eic::VectorXYZpositionError () const
 Access the Error on the position. More...
 
const float & theta () const
 Access the opening angle of the ring [rad, 0->pi]. More...
 
const float & thetaError () const
 Access the error on the opening angle. More...
 
const float & radius () const
 Access the radius of the best fit ring [mm]. More...
 
const float & radiusError () const
 Access the estimated error from the fit [mm]. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from RingImageObj instance More...
 
bool operator== (const ConstRingImage &other) const
 
bool operator== (const RingImage &other) const
 
bool operator< (const ConstRingImage &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class RingImage
 
class RingImageCollection
 
class RingImageConstCollectionIterator
 

Detailed Description

EIC Ring Image Cluster

Author
: S. Joosten, C. Peng

Constructor & Destructor Documentation

◆ ConstRingImage() [1/4]

eic::ConstRingImage::ConstRingImage ( )

default constructor

◆ ConstRingImage() [2/4]

eic::ConstRingImage::ConstRingImage ( eic::Index  ID,
float  npe,
eic::VectorXYZ  position,
eic::VectorXYZ  positionError,
float  theta,
float  thetaError,
float  radius,
float  radiusError 
)

◆ ConstRingImage() [3/4]

eic::ConstRingImage::ConstRingImage ( RingImageObj obj)

constructor from existing RingImageObj

◆ ConstRingImage() [4/4]

eic::ConstRingImage::ConstRingImage ( const ConstRingImage other)

copy constructor

◆ ~ConstRingImage()

eic::ConstRingImage::~ConstRingImage ( )

destructor

Member Function Documentation

◆ clone()

ConstRingImage eic::ConstRingImage::clone ( ) const

support cloning (deep-copy)

◆ getObjectID()

const podio::ObjectID eic::ConstRingImage::getObjectID ( ) const

◆ ID()

const eic::Index & eic::ConstRingImage::ID ( ) const

Access the Unique cluster ID.

◆ id()

unsigned int eic::ConstRingImage::id ( ) const
inline

◆ isAvailable()

bool eic::ConstRingImage::isAvailable ( ) const

check whether the object is actually available

◆ npe()

const float & eic::ConstRingImage::npe ( ) const

Access the number of photo-electrons [#].

◆ operator<()

bool eic::ConstRingImage::operator< ( const ConstRingImage other) const
inline

◆ operator=()

ConstRingImage & eic::ConstRingImage::operator= ( const ConstRingImage other)

copy-assignment operator

◆ operator==() [1/2]

bool eic::ConstRingImage::operator== ( const ConstRingImage other) const
inline

◆ operator==() [2/2]

bool eic::ConstRingImage::operator== ( const RingImage other) const

◆ position()

const eic::VectorXYZ & eic::ConstRingImage::position ( ) const

Access the Global position of the cluster [mm].

◆ positionError()

const eic::VectorXYZ & eic::ConstRingImage::positionError ( ) const

Access the Error on the position.

◆ radius()

const float & eic::ConstRingImage::radius ( ) const

Access the radius of the best fit ring [mm].

◆ radiusError()

const float & eic::ConstRingImage::radiusError ( ) const

Access the estimated error from the fit [mm].

◆ theta()

const float & eic::ConstRingImage::theta ( ) const

Access the opening angle of the ring [rad, 0->pi].

◆ thetaError()

const float & eic::ConstRingImage::thetaError ( ) const

Access the error on the opening angle.

◆ unlink()

void eic::ConstRingImage::unlink ( )
inline

disconnect from RingImageObj instance

Friends And Related Function Documentation

◆ RingImage

friend class RingImage
friend

◆ RingImageCollection

friend class RingImageCollection
friend

◆ RingImageConstCollectionIterator

friend class RingImageConstCollectionIterator
friend

The documentation for this class was generated from the following files: