edm4eic::MutableRingImage Class Reference

#include <MutableRingImage.h>

Public Types
using	object_type = RingImage
using	collection_type = RingImageCollection

Public Member Functions
	MutableRingImage ()
	default constructor
	MutableRingImage (const float npe, const edm4hep::Vector3f &position, const edm4hep::Vector3f &positionError, const float theta, const float thetaError, const float radius, const float radiusError)
	Constructor initializing all members.
	MutableRingImage (const MutableRingImage &other)=default
	copy constructor
MutableRingImage &	operator= (MutableRingImage other) &
	copy-assignment operator
MutableRingImage &	operator= (MutableRingImage other) &&=delete
MutableRingImage	clone (bool cloneRelations=true) const
	~MutableRingImage ()=default
	destructor
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 (const float npe)
	Set the Number of photo-electrons [#].
float &	getNpe ()
	Get mutable reference to Number of photo-electrons [#].
float &	npe ()
	Get reference to Number of photo-electrons [#].
void	setPosition (const edm4hep::Vector3f &position)
	Set the Global position of the cluster [mm].
edm4hep::Vector3f &	getPosition ()
	Get mutable reference to Global position of the cluster [mm].
edm4hep::Vector3f &	position ()
	Get reference to Global position of the cluster [mm].
void	setPositionError (const edm4hep::Vector3f &positionError)
	Set the Error on the position.
edm4hep::Vector3f &	getPositionError ()
	Get mutable reference to Error on the position.
edm4hep::Vector3f &	positionError ()
	Get reference to Error on the position.
void	setTheta (const float theta)
	Set the Opening angle of the ring [rad, 0->pi].
float &	getTheta ()
	Get mutable reference to Opening angle of the ring [rad, 0->pi].
float &	theta ()
	Get reference to Opening angle of the ring [rad, 0->pi].
void	setThetaError (const float thetaError)
	Set the Error on the opening angle.
float &	getThetaError ()
	Get mutable reference to Error on the opening angle.
float &	thetaError ()
	Get reference to Error on the opening angle.
void	setRadius (const float radius)
	Set the Radius of the best fit ring [mm].
float &	getRadius ()
	Get mutable reference to Radius of the best fit ring [mm].
float &	radius ()
	Get reference to Radius of the best fit ring [mm].
void	setRadiusError (const float radiusError)
	Set the Estimated error from the fit [mm].
float &	getRadiusError ()
	Get mutable reference to Estimated error from the fit [mm].
float &	radiusError ()
	Get reference to 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
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	(	const float	npe,
		const edm4hep::Vector3f &	position,
		const edm4hep::Vector3f &	positionError,
		const float	theta,
		const float	thetaError,
		const float	radius,
		const 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

(

bool

cloneRelations = true

)

const

create a mutable deep-copy of the object with identical relations if cloneRelations=false, the relations are not cloned and will be empty

getNpe() [1/2]

float & edm4eic::MutableRingImage::getNpe

(

)

Get mutable reference to Number of photo-electrons [#].

getNpe() [2/2]

float edm4eic::MutableRingImage::getNpe

(

)

const

Access the Number of photo-electrons [#].

getObjectID()

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

(

)

const

getPosition() [1/2]

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

(

)

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

getPosition() [2/2]

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

(

)

const

Access the Global position of the cluster [mm].

getPositionError() [1/2]

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

(

)

Get mutable reference to Error on the position.

getPositionError() [2/2]

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

(

)

const

Access the Error on the position.

getRadius() [1/2]

float & edm4eic::MutableRingImage::getRadius

(

)

Get mutable reference to Radius of the best fit ring [mm].

getRadius() [2/2]

float edm4eic::MutableRingImage::getRadius

(

)

const

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

getRadiusError() [1/2]

float & edm4eic::MutableRingImage::getRadiusError

(

)

Get mutable reference to Estimated error from the fit [mm].

getRadiusError() [2/2]

float edm4eic::MutableRingImage::getRadiusError

(

)

const

Access the Estimated error from the fit [mm].

getTheta() [1/2]

float & edm4eic::MutableRingImage::getTheta

(

)

Get mutable reference to Opening angle of the ring [rad, 0->pi].

getTheta() [2/2]

float edm4eic::MutableRingImage::getTheta

(

)

const

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

getThetaError() [1/2]

float & edm4eic::MutableRingImage::getThetaError

(

)

Get mutable reference to Error on the opening angle.

getThetaError() [2/2]

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

npe()

float & edm4eic::MutableRingImage::npe

(

)

Get reference to Number of photo-electrons [#].

operator!=() [1/2]

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

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

MutableRingImage & edm4eic::MutableRingImage::operator=

(

MutableRingImage

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

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.

radius()

float & edm4eic::MutableRingImage::radius

(

)

Get reference to Radius of the best fit ring [mm].

radiusError()

float & edm4eic::MutableRingImage::radiusError

(

)

Get reference to Estimated error from the fit [mm].

setNpe()

void edm4eic::MutableRingImage::setNpe

(

const float

npe

)

Set the Number of photo-electrons [#].

setPosition()

void edm4eic::MutableRingImage::setPosition

(

const edm4hep::Vector3f &

position

)

Set the Global position of the cluster [mm].

setPositionError()

void edm4eic::MutableRingImage::setPositionError

(

const edm4hep::Vector3f &

positionError

)

Set the Error on the position.

setRadius()

void edm4eic::MutableRingImage::setRadius

(

const float

radius

)

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

setRadiusError()

void edm4eic::MutableRingImage::setRadiusError

(

const float

radiusError

)

Set the Estimated error from the fit [mm].

setTheta()

void edm4eic::MutableRingImage::setTheta

(

const float

theta

)

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

setThetaError()

void edm4eic::MutableRingImage::setThetaError

(

const float

thetaError

)

Set the Error on the opening angle.

theta()

float & edm4eic::MutableRingImage::theta

(

)

Get reference to Opening angle of the ring [rad, 0->pi].

thetaError()

float & edm4eic::MutableRingImage::thetaError

(

)

Get reference to 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