edm4eic::MutableRingImage Class Reference

#include <MutableRingImage.h>

Public Types
using	object_type = RingImage
using	collection_type = RingImageCollection

Public Member Functions
	MutableRingImage ()
	default constructor
	MutableRingImage (float npe, edm4hep::Vector3f position, edm4hep::Vector3f positionError, float theta, float thetaError, float radius, float radiusError)
	Constructor initializing all members.
	MutableRingImage (const MutableRingImage &other)=default
	copy constructor
MutableRingImage &	operator= (MutableRingImage other)
	copy-assignment operator
MutableRingImage	clone () const
	create a mutable deep-copy of the object with identical relations
	~MutableRingImage ()=default
	destructor
	operator RingImage () const
	conversion to const object
float	getNpe () const
	Access the Number of photo-electrons [#].
const edm4hep::Vector3f &	getPosition () const
	Access the Global position of the cluster [mm].
const edm4hep::Vector3f &	getPositionError () const
	Access the Error on the position.
float	getTheta () const
	Access the Opening angle of the ring [rad, 0->pi].
float	getThetaError () const
	Access the Error on the opening angle.
float	getRadius () const
	Access the Radius of the best fit ring [mm].
float	getRadiusError () const
	Access the Estimated error from the fit [mm].
void	setNpe (float value)
	Set the Number of photo-electrons [#].
void	setPosition (edm4hep::Vector3f value)
	Set the Global position of the cluster [mm].
edm4hep::Vector3f &	position ()
	Get reference to Global position of the cluster [mm].
void	setPositionError (edm4hep::Vector3f value)
	Set the Error on the position.
edm4hep::Vector3f &	positionError ()
	Get reference to Error on the position.
void	setTheta (float value)
	Set the Opening angle of the ring [rad, 0->pi].
void	setThetaError (float value)
	Set the Error on the opening angle.
void	setRadius (float value)
	Set the Radius of the best fit ring [mm].
void	setRadiusError (float value)
	Set the Estimated error from the fit [mm].
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from RingImageObj instance
bool	operator== (const MutableRingImage &other) const
bool	operator== (const RingImage &other) const
bool	operator< (const MutableRingImage &other) const
podio::ObjectID	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

Member Typedef Documentation

collection_type

using edm4eic::MutableRingImage::collection_type = RingImageCollection

object_type

using edm4eic::MutableRingImage::object_type = RingImage

Constructor & Destructor Documentation

MutableRingImage() [1/3]

edm4eic::MutableRingImage::MutableRingImage

(

)

default constructor

MutableRingImage() [2/3]

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

Constructor initializing all members.

MutableRingImage() [3/3]

edm4eic::MutableRingImage::MutableRingImage ( const MutableRingImage & other )

default

copy constructor

~MutableRingImage()

edm4eic::MutableRingImage::~MutableRingImage ( )

default

destructor

Member Function Documentation

clone()

MutableRingImage edm4eic::MutableRingImage::clone

(

)

const

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

getNpe()

float edm4eic::MutableRingImage::getNpe

(

)

const

Access the Number of photo-electrons [#].

getObjectID()

const podio::ObjectID edm4eic::MutableRingImage::getObjectID

(

)

const

getPosition()

const edm4hep::Vector3f & edm4eic::MutableRingImage::getPosition

(

)

const

Access the Global position of the cluster [mm].

getPositionError()

const edm4hep::Vector3f & edm4eic::MutableRingImage::getPositionError

(

)

const

Access the Error on the position.

getRadius()

float edm4eic::MutableRingImage::getRadius

(

)

const

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

getRadiusError()

float edm4eic::MutableRingImage::getRadiusError

(

)

const

Access the Estimated error from the fit [mm].

getTheta()

float edm4eic::MutableRingImage::getTheta

(

)

const

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

getThetaError()

float edm4eic::MutableRingImage::getThetaError

(

)

const

Access the Error on the opening angle.

id()

podio::ObjectID edm4eic::MutableRingImage::id ( ) const

inline

isAvailable()

bool edm4eic::MutableRingImage::isAvailable

(

)

const

check whether the object is actually available

operator RingImage()

edm4eic::MutableRingImage::operator RingImage

(

)

const

conversion to const object

operator<()

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

inline

operator=()

MutableRingImage & edm4eic::MutableRingImage::operator=

(

MutableRingImage

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::MutableRingImage::operator==

(

const RingImage &

other

)

const

position()

edm4hep::Vector3f & edm4eic::MutableRingImage::position

(

)

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

positionError()

edm4hep::Vector3f & edm4eic::MutableRingImage::positionError

(

)

Get reference to Error on the position.

setNpe()

void edm4eic::MutableRingImage::setNpe

(

float

value

)

Set the Number of photo-electrons [#].

setPosition()

void edm4eic::MutableRingImage::setPosition

(

edm4hep::Vector3f

value

)

Set the Global position of the cluster [mm].

setPositionError()

void edm4eic::MutableRingImage::setPositionError

(

edm4hep::Vector3f

value

)

Set the Error on the position.

setRadius()

void edm4eic::MutableRingImage::setRadius

(

float

value

)

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

setRadiusError()

void edm4eic::MutableRingImage::setRadiusError

(

float

value

)

Set the Estimated error from the fit [mm].

setTheta()

void edm4eic::MutableRingImage::setTheta

(

float

value

)

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

setThetaError()

void edm4eic::MutableRingImage::setThetaError

(

float

value

)

Set the Error on the opening angle.

unlink()

void edm4eic::MutableRingImage::unlink ( )

inline

disconnect from RingImageObj instance

Friends And Related Symbol 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/edm4eic/MutableRingImage.h
• build/src/MutableRingImage.cc