eicd::MutableRingImage Class Reference

#include <MutableRingImage.h>

Public Member Functions
	MutableRingImage ()
	default constructor More...
	MutableRingImage (float npe, edm4hep::Vector3f position, edm4hep::Vector3f positionError, float theta, float thetaError, float radius, float radiusError)
	MutableRingImage (RingImageObj *obj)
	constructor from existing RingImageObj More...
	MutableRingImage (const MutableRingImage &other)
	copy constructor More...
MutableRingImage &	operator= (MutableRingImage other)
	copy-assignment operator More...
MutableRingImage	clone () const
	create a mutable deep-copy of the object with identical relations More...
	~MutableRingImage ()
	destructor More...
	operator RingImage () const
	conversion to const object 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...
void	setNpe (float value)
	Set the Number of photo-electrons [#]. More...
void	setPosition (edm4hep::Vector3f value)
	Set the Global position of the cluster [mm]. More...
edm4hep::Vector3f &	position ()
	Get reference to Global position of the cluster [mm]. More...
void	setPositionError (edm4hep::Vector3f value)
	Set the Error on the position. More...
edm4hep::Vector3f &	positionError ()
	Get reference to Error on the position. More...
void	setTheta (float value)
	Set the Opening angle of the ring [rad, 0->pi]. More...
void	setThetaError (float value)
	Set the Error on the opening angle. More...
void	setRadius (float value)
	Set the Radius of the best fit ring [mm]. More...
void	setRadiusError (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 MutableRingImage &other) const
bool	operator== (const RingImage &other) const
bool	operator< (const MutableRingImage &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

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

Detailed Description

EIC Ring Image Cluster

Author

: S. Joosten, C. Peng

Constructor & Destructor Documentation

MutableRingImage() [1/4]

eicd::MutableRingImage::MutableRingImage

(

)

default constructor

MutableRingImage() [2/4]

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

MutableRingImage() [3/4]

eicd::MutableRingImage::MutableRingImage

(

RingImageObj *

obj

)

constructor from existing RingImageObj

MutableRingImage() [4/4]

eicd::MutableRingImage::MutableRingImage

(

const MutableRingImage &

other

)

copy constructor

~MutableRingImage()

eicd::MutableRingImage::~MutableRingImage

(

)

destructor

Member Function Documentation

clone()

MutableRingImage eicd::MutableRingImage::clone

(

)

const

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

getNpe()

const float & eicd::MutableRingImage::getNpe

(

)

const

Access the Number of photo-electrons [#].

getObjectID()

const podio::ObjectID eicd::MutableRingImage::getObjectID

(

)

const

getPosition()

const edm4hep::Vector3f & eicd::MutableRingImage::getPosition

(

)

const

Access the Global position of the cluster [mm].

getPositionError()

const edm4hep::Vector3f & eicd::MutableRingImage::getPositionError

(

)

const

Access the Error on the position.

getRadius()

const float & eicd::MutableRingImage::getRadius

(

)

const

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

getRadiusError()

const float & eicd::MutableRingImage::getRadiusError

(

)

const

Access the Estimated error from the fit [mm].

getTheta()

const float & eicd::MutableRingImage::getTheta

(

)

const

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

getThetaError()

const float & eicd::MutableRingImage::getThetaError

(

)

const

Access the Error on the opening angle.

id()

unsigned int eicd::MutableRingImage::id ( ) const

inline

isAvailable()

bool eicd::MutableRingImage::isAvailable

(

)

const

check whether the object is actually available

operator RingImage()

eicd::MutableRingImage::operator RingImage

(

)

const

conversion to const object

operator<()

bool eicd::MutableRingImage::operator< ( const MutableRingImage &  other ) const

inline

operator=()

MutableRingImage & eicd::MutableRingImage::operator=

(

MutableRingImage

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool eicd::MutableRingImage::operator==

(

const RingImage &

other

)

const

position()

edm4hep::Vector3f & eicd::MutableRingImage::position

(

)

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

positionError()

edm4hep::Vector3f & eicd::MutableRingImage::positionError

(

)

Get reference to Error on the position.

setNpe()

void eicd::MutableRingImage::setNpe

(

float

value

)

Set the Number of photo-electrons [#].

setPosition()

void eicd::MutableRingImage::setPosition

(

edm4hep::Vector3f

value

)

Set the Global position of the cluster [mm].

setPositionError()

void eicd::MutableRingImage::setPositionError

(

edm4hep::Vector3f

value

)

Set the Error on the position.

setRadius()

void eicd::MutableRingImage::setRadius

(

float

value

)

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

setRadiusError()

void eicd::MutableRingImage::setRadiusError

(

float

value

)

Set the Estimated error from the fit [mm].

setTheta()

void eicd::MutableRingImage::setTheta

(

float

value

)

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

setThetaError()

void eicd::MutableRingImage::setThetaError

(

float

value

)

Set the Error on the opening angle.

unlink()

void eicd::MutableRingImage::unlink ( )

inline

disconnect from RingImageObj instance

Friends And Related Function Documentation

RingImage

friend class RingImage

friend

RingImageCollection

friend class RingImageCollection

friend

RingImageMutableCollectionIterator

friend class RingImageMutableCollectionIterator

friend

swap

void swap ( MutableRingImage &  a, MutableRingImage &  b  )

friend

---

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

• build/eicd/MutableRingImage.h
• build/src/MutableRingImage.cc