edm4eic::RingImage Class Reference

#include <RingImage.h>

Public Types
using	mutable_type = MutableRingImage
using	collection_type = RingImageCollection

Public Member Functions
	RingImage ()=default
	default constructor
	RingImage (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.
	RingImage (const RingImage &other)=default
	copy constructor
RingImage &	operator= (RingImage other) &
	copy-assignment operator
RingImage &	operator= (RingImage other) &&=delete
MutableRingImage	clone (bool cloneRelations=true) const
	~RingImage ()=default
	destructor
	RingImage (const MutableRingImage &other)
	converting constructor from mutable 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].
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from RingImageObj instance
bool	operator== (const RingImage &other) const
bool	operator== (const MutableRingImage &other) const
bool	operator!= (const RingImage &other) const
bool	operator!= (const MutableRingImage &other) const
bool	operator< (const RingImage &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static RingImage	makeEmpty ()

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::RingImage"

Friends
class	MutableRingImage
class	RingImageCollection
class	edm4eic::RingImageCollectionData
class	RingImageCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const RingImage &obj)
void	swap (RingImage &a, RingImage &b)

Detailed Description

EIC Ring Image Cluster

Author

: S. Joosten, C. Peng

Member Typedef Documentation

collection_type

using edm4eic::RingImage::collection_type = RingImageCollection

mutable_type

using edm4eic::RingImage::mutable_type = MutableRingImage

Constructor & Destructor Documentation

RingImage() [1/4]

edm4eic::RingImage::RingImage ( )

default

default constructor

RingImage() [2/4]

edm4eic::RingImage::RingImage	(	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.

RingImage() [3/4]

edm4eic::RingImage::RingImage ( const RingImage & other )

default

copy constructor

~RingImage()

edm4eic::RingImage::~RingImage ( )

default

destructor

RingImage() [4/4]

edm4eic::RingImage::RingImage

(

const MutableRingImage &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableRingImage edm4eic::RingImage::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()

float edm4eic::RingImage::getNpe

(

)

const

Access the Number of photo-electrons [#].

getObjectID()

const podio::ObjectID edm4eic::RingImage::getObjectID

(

)

const

getPosition()

const edm4hep::Vector3f & edm4eic::RingImage::getPosition

(

)

const

Access the Global position of the cluster [mm].

getPositionError()

const edm4hep::Vector3f & edm4eic::RingImage::getPositionError

(

)

const

Access the Error on the position.

getRadius()

float edm4eic::RingImage::getRadius

(

)

const

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

getRadiusError()

float edm4eic::RingImage::getRadiusError

(

)

const

Access the Estimated error from the fit [mm].

getTheta()

float edm4eic::RingImage::getTheta

(

)

const

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

getThetaError()

float edm4eic::RingImage::getThetaError

(

)

const

Access the Error on the opening angle.

id()

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

inline

isAvailable()

bool edm4eic::RingImage::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

RingImage edm4eic::RingImage::makeEmpty ( )

static

operator!=() [1/2]

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

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

RingImage & edm4eic::RingImage::operator=

(

RingImage

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

bool edm4eic::RingImage::operator==

(

const MutableRingImage &

other

)

const

operator==() [2/2]

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

inline

unlink()

void edm4eic::RingImage::unlink ( )

inline

disconnect from RingImageObj instance

Friends And Related Symbol Documentation

edm4eic::RingImageCollectionData

friend class edm4eic::RingImageCollectionData

friend

MutableRingImage

friend class MutableRingImage

friend

podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const RingImage & obj )

friend

RingImageCollection

friend class RingImageCollection

friend

RingImageCollectionIterator

friend class RingImageCollectionIterator

friend

swap

void swap ( RingImage & a, RingImage & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::RingImage::typeName = "edm4eic::RingImage"

staticconstexpr

---

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

• build/edm4eic/RingImage.h
• build/src/RingImage.cc