EICd
EIC data model
eicd::RingImage Class Reference

#include <RingImage.h>

Public Member Functions

 RingImage ()
 default constructor More...
 
 RingImage (float npe, edm4hep::Vector3f position, edm4hep::Vector3f positionError, float theta, float thetaError, float radius, float radiusError)
 
 RingImage (RingImageObj *obj)
 constructor from existing RingImageObj More...
 
 RingImage (const RingImage &other)
 copy constructor More...
 
RingImageoperator= (RingImage other)
 copy-assignment operator More...
 
MutableRingImage clone () const
 create a mutable deep-copy of the object with identical relations More...
 
 ~RingImage ()
 destructor More...
 
const float & getNpe () const
 Access the Number of photo-electrons [#]. More...
 
const edm4hep::Vector3f & getPosition () const
 Access the Global position of the cluster [mm]. More...
 
const edm4hep::Vector3f & getPositionError () const
 Access the Error on the position. More...
 
const float & getTheta () const
 Access the Opening angle of the ring [rad, 0->pi]. More...
 
const float & getThetaError () const
 Access the Error on the opening angle. More...
 
const float & getRadius () const
 Access the Radius of the best fit ring [mm]. More...
 
const float & getRadiusError () 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 RingImage &other) const
 
bool operator== (const MutableRingImage &other) const
 
bool operator< (const RingImage &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class MutableRingImage
 
class RingImageCollection
 
class RingImageCollectionIterator
 
void swap (RingImage &a, RingImage &b)
 

Detailed Description

EIC Ring Image Cluster

Author
: S. Joosten, C. Peng

Constructor & Destructor Documentation

◆ RingImage() [1/4]

eicd::RingImage::RingImage ( )

default constructor

◆ RingImage() [2/4]

eicd::RingImage::RingImage ( float  npe,
edm4hep::Vector3f  position,
edm4hep::Vector3f  positionError,
float  theta,
float  thetaError,
float  radius,
float  radiusError 
)

◆ RingImage() [3/4]

eicd::RingImage::RingImage ( RingImageObj obj)

constructor from existing RingImageObj

◆ RingImage() [4/4]

eicd::RingImage::RingImage ( const RingImage other)

copy constructor

◆ ~RingImage()

eicd::RingImage::~RingImage ( )

destructor

Member Function Documentation

◆ clone()

MutableRingImage eicd::RingImage::clone ( ) const

create a mutable deep-copy of the object with identical relations

◆ getNpe()

const float & eicd::RingImage::getNpe ( ) const

Access the Number of photo-electrons [#].

◆ getObjectID()

const podio::ObjectID eicd::RingImage::getObjectID ( ) const

◆ getPosition()

const edm4hep::Vector3f & eicd::RingImage::getPosition ( ) const

Access the Global position of the cluster [mm].

◆ getPositionError()

const edm4hep::Vector3f & eicd::RingImage::getPositionError ( ) const

Access the Error on the position.

◆ getRadius()

const float & eicd::RingImage::getRadius ( ) const

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

◆ getRadiusError()

const float & eicd::RingImage::getRadiusError ( ) const

Access the Estimated error from the fit [mm].

◆ getTheta()

const float & eicd::RingImage::getTheta ( ) const

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

◆ getThetaError()

const float & eicd::RingImage::getThetaError ( ) const

Access the Error on the opening angle.

◆ id()

unsigned int eicd::RingImage::id ( ) const
inline

◆ isAvailable()

bool eicd::RingImage::isAvailable ( ) const

check whether the object is actually available

◆ operator<()

bool eicd::RingImage::operator< ( const RingImage other) const
inline

◆ operator=()

RingImage & eicd::RingImage::operator= ( RingImage  other)

copy-assignment operator

◆ operator==() [1/2]

bool eicd::RingImage::operator== ( const MutableRingImage other) const

◆ operator==() [2/2]

bool eicd::RingImage::operator== ( const RingImage other) const
inline

◆ unlink()

void eicd::RingImage::unlink ( )
inline

disconnect from RingImageObj instance

Friends And Related Function Documentation

◆ MutableRingImage

friend class MutableRingImage
friend

◆ RingImageCollection

friend class RingImageCollection
friend

◆ RingImageCollectionIterator

friend class RingImageCollectionIterator
friend

◆ swap

void swap ( RingImage a,
RingImage b 
)
friend

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