eic::RingImage Class Reference

#include <RingImage.h>

Public Member Functions
	RingImage ()
	default constructor More...
	RingImage (eic::Index ID, float npe, eic::VectorXYZ position, eic::VectorXYZ positionError, float theta, float thetaError, float radius, float radiusError)
	RingImage (RingImageObj *obj)
	constructor from existing RingImageObj More...
	RingImage (const RingImage &other)
	copy constructor More...
RingImage &	operator= (const RingImage &other)
	copy-assignment operator More...
RingImage	clone () const
	support cloning (deep-copy) More...
	~RingImage ()
	destructor More...
	operator ConstRingImage () const
	conversion to const object More...
const eic::Index &	ID () const
	Access the Unique cluster ID. More...
const float &	npe () const
	Access the number of photo-electrons [#]. More...
const eic::VectorXYZ &	position () const
	Access the Global position of the cluster [mm]. More...
const eic::VectorXYZ &	positionError () 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...
void	ID (eic::Index value)
	Set the Unique cluster ID. More...
eic::Index &	ID ()
	Get reference to Unique cluster ID. More...
void	npe (float value)
	Set the number of photo-electrons [#]. More...
void	position (eic::VectorXYZ value)
	Set the Global position of the cluster [mm]. More...
eic::VectorXYZ &	position ()
	Get reference to Global position of the cluster [mm]. More...
void	positionError (eic::VectorXYZ value)
	Set the Error on the position. More...
eic::VectorXYZ &	positionError ()
	Get reference to Error on the position. More...
void	theta (float value)
	Set the opening angle of the ring [rad, 0->pi]. More...
void	thetaError (float value)
	Set the error on the opening angle. More...
void	radius (float value)
	Set the radius of the best fit ring [mm]. More...
void	radiusError (float value)
	Set 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 ConstRingImage &other) const
bool	operator< (const RingImage &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	RingImageCollection
class	RingImageCollectionIterator
class	ConstRingImage

Detailed Description

EIC Ring Image Cluster

Author

: S. Joosten, C. Peng

Constructor & Destructor Documentation

RingImage() [1/4]

eic::RingImage::RingImage

(

)

default constructor

RingImage() [2/4]

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

RingImage() [3/4]

eic::RingImage::RingImage

(

RingImageObj *

obj

)

constructor from existing RingImageObj

RingImage() [4/4]

eic::RingImage::RingImage

(

const RingImage &

other

)

copy constructor

~RingImage()

eic::RingImage::~RingImage

(

)

destructor

Member Function Documentation

clone()

RingImage eic::RingImage::clone

(

)

const

support cloning (deep-copy)

getObjectID()

const podio::ObjectID eic::RingImage::getObjectID

(

)

const

ID() [1/3]

eic::Index & eic::RingImage::ID

(

)

Get reference to Unique cluster ID.

ID() [2/3]

const eic::Index & eic::RingImage::ID

(

)

const

Access the Unique cluster ID.

id()

unsigned int eic::RingImage::id ( ) const

inline

ID() [3/3]

void eic::RingImage::ID

(

eic::Index

value

)

Set the Unique cluster ID.

isAvailable()

bool eic::RingImage::isAvailable

(

)

const

check whether the object is actually available

npe() [1/2]

const float & eic::RingImage::npe

(

)

const

Access the number of photo-electrons [#].

npe() [2/2]

void eic::RingImage::npe

(

float

value

)

Set the number of photo-electrons [#].

operator ConstRingImage()

eic::RingImage::operator ConstRingImage

(

)

const

conversion to const object

operator<()

bool eic::RingImage::operator< ( const RingImage &  other ) const

inline

operator=()

RingImage & eic::RingImage::operator=

(

const RingImage &

other

)

copy-assignment operator

operator==() [1/2]

bool eic::RingImage::operator==

(

const ConstRingImage &

other

)

const

operator==() [2/2]

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

inline

position() [1/3]

eic::VectorXYZ & eic::RingImage::position

(

)

Get reference to Global position of the cluster [mm].

position() [2/3]

const eic::VectorXYZ & eic::RingImage::position

(

)

const

Access the Global position of the cluster [mm].

position() [3/3]

void eic::RingImage::position

(

eic::VectorXYZ

value

)

Set the Global position of the cluster [mm].

positionError() [1/3]

eic::VectorXYZ & eic::RingImage::positionError

(

)

Get reference to Error on the position.

positionError() [2/3]

const eic::VectorXYZ & eic::RingImage::positionError

(

)

const

Access the Error on the position.

positionError() [3/3]

void eic::RingImage::positionError

(

eic::VectorXYZ

value

)

Set the Error on the position.

radius() [1/2]

const float & eic::RingImage::radius

(

)

const

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

radius() [2/2]

void eic::RingImage::radius

(

float

value

)

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

radiusError() [1/2]

const float & eic::RingImage::radiusError

(

)

const

Access the estimated error from the fit [mm].

radiusError() [2/2]

void eic::RingImage::radiusError

(

float

value

)

Set the estimated error from the fit [mm].

theta() [1/2]

const float & eic::RingImage::theta

(

)

const

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

theta() [2/2]

void eic::RingImage::theta

(

float

value

)

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

thetaError() [1/2]

const float & eic::RingImage::thetaError

(

)

const

Access the error on the opening angle.

thetaError() [2/2]

void eic::RingImage::thetaError

(

float

value

)

Set the error on the opening angle.

unlink()

void eic::RingImage::unlink ( )

inline

disconnect from RingImageObj instance

Friends And Related Function Documentation

ConstRingImage

friend class ConstRingImage

friend

RingImageCollection

friend class RingImageCollection

friend

RingImageCollectionIterator

friend class RingImageCollectionIterator

friend

---

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

• eicd/RingImage.h
• src/RingImage.cc