eic::ConstCluster Class Reference

#include <ClusterConst.h>

Public Member Functions
	ConstCluster ()
	default constructor More...
	ConstCluster (eic::Index ID, float energy, float energyError, float time, std::uint32_t nhits, eic::VectorXYZ position, eic::CovXYZ positionError, float radius, float skewness)
	ConstCluster (ClusterObj *obj)
	constructor from existing ClusterObj More...
	ConstCluster (const ConstCluster &other)
	copy constructor More...
ConstCluster &	operator= (const ConstCluster &other)
	copy-assignment operator More...
ConstCluster	clone () const
	support cloning (deep-copy) More...
	~ConstCluster ()
	destructor More...
const eic::Index &	ID () const
	Access the unique ID for this cluster. More...
const float &	energy () const
	Access the Reconstructed energy of the cluster [GeV]. More...
const float &	energyError () const
	Access the Error on the cluster energy [GeV]. More...
const float &	time () const
	Access the [ns]. More...
const std::uint32_t &	nhits () const
	Access the Number of hits in the cluster. More...
const eic::VectorXYZ &	position () const
	Access the Global position of the cluster [mm]. More...
const eic::CovXYZ &	positionError () const
	Access the Covariance matrix of the position (6 Parameters). More...
const float &	radius () const
	Access the shower radius [mm]. More...
const float &	skewness () const
	Access the shower skewness [unitless]. More...
bool	isAvailable () const
	check whether the object is actually available More...
void	unlink ()
	disconnect from ClusterObj instance More...
bool	operator== (const ConstCluster &other) const
bool	operator== (const Cluster &other) const
bool	operator< (const ConstCluster &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	Cluster
class	ClusterCollection
class	ClusterConstCollectionIterator

Detailed Description

EIC cluster

Author

: W. Armstrong, S. Joosten, C.Peng

Constructor & Destructor Documentation

ConstCluster() [1/4]

eic::ConstCluster::ConstCluster

(

)

default constructor

ConstCluster() [2/4]

eic::ConstCluster::ConstCluster	(	eic::Index	ID,
		float	energy,
		float	energyError,
		float	time,
		std::uint32_t	nhits,
		eic::VectorXYZ	position,
		eic::CovXYZ	positionError,
		float	radius,
		float	skewness
	)

ConstCluster() [3/4]

eic::ConstCluster::ConstCluster

(

ClusterObj *

obj

)

constructor from existing ClusterObj

ConstCluster() [4/4]

eic::ConstCluster::ConstCluster

(

const ConstCluster &

other

)

copy constructor

~ConstCluster()

eic::ConstCluster::~ConstCluster

(

)

destructor

Member Function Documentation

clone()

ConstCluster eic::ConstCluster::clone

(

)

const

support cloning (deep-copy)

energy()

const float & eic::ConstCluster::energy

(

)

const

Access the Reconstructed energy of the cluster [GeV].

energyError()

const float & eic::ConstCluster::energyError

(

)

const

Access the Error on the cluster energy [GeV].

getObjectID()

const podio::ObjectID eic::ConstCluster::getObjectID

(

)

const

ID()

const eic::Index & eic::ConstCluster::ID

(

)

const

Access the unique ID for this cluster.

id()

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

inline

isAvailable()

bool eic::ConstCluster::isAvailable

(

)

const

check whether the object is actually available

nhits()

const std::uint32_t & eic::ConstCluster::nhits

(

)

const

Access the Number of hits in the cluster.

operator<()

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

inline

operator=()

ConstCluster & eic::ConstCluster::operator=

(

const ConstCluster &

other

)

copy-assignment operator

operator==() [1/2]

bool eic::ConstCluster::operator==

(

const Cluster &

other

)

const

operator==() [2/2]

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

inline

position()

const eic::VectorXYZ & eic::ConstCluster::position

(

)

const

Access the Global position of the cluster [mm].

positionError()

const eic::CovXYZ & eic::ConstCluster::positionError

(

)

const

Access the Covariance matrix of the position (6 Parameters).

radius()

const float & eic::ConstCluster::radius

(

)

const

Access the shower radius [mm].

skewness()

const float & eic::ConstCluster::skewness

(

)

const

Access the shower skewness [unitless].

time()

const float & eic::ConstCluster::time

(

)

const

Access the [ns].

unlink()

void eic::ConstCluster::unlink ( )

inline

disconnect from ClusterObj instance

Friends And Related Function Documentation

Cluster

friend class Cluster

friend

ClusterCollection

friend class ClusterCollection

friend

ClusterConstCollectionIterator

friend class ClusterConstCollectionIterator

friend

---

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

• eicd/ClusterConst.h
• src/ClusterConst.cc