#include <Cluster.h>

Public Member Functions
	Cluster ()
	default constructor More...

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

	Cluster (ClusterObj *obj)
	constructor from existing ClusterObj More...

	Cluster (const Cluster &other)
	copy constructor More...

Cluster &	operator= (const Cluster &other)
	copy-assignment operator More...

Cluster	clone () const
	support cloning (deep-copy) More...

	~Cluster ()
	destructor More...

	operator ConstCluster () const
	conversion to const object 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...

void	ID (eic::Index value)
	Set the unique ID for this cluster. More...

eic::Index &	ID ()
	Get reference to unique ID for this cluster. More...

void	energy (float value)
	Set the Reconstructed energy of the cluster [GeV]. More...

void	energyError (float value)
	Set the Error on the cluster energy [GeV]. More...

void	time (float value)
	Set the [ns]. More...

void	nhits (std::uint32_t value)
	Set the Number of hits in the cluster. More...

void	position (eic::VectorXYZ value)
	Set the Global position of the cluster [mm]. More...

eic::VectorXYZ &	position ()
	Get reference to Global position of the cluster [mm]. More...

void	positionError (eic::CovXYZ value)
	Set the Covariance matrix of the position (6 Parameters). More...

eic::CovXYZ &	positionError ()
	Get reference to Covariance matrix of the position (6 Parameters). More...

void	radius (float value)
	Set the shower radius [mm]. More...

void	skewness (float value)
	Set 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 Cluster &other) const

bool	operator== (const ConstCluster &other) const

bool	operator< (const Cluster &other) const

unsigned int	id () const

const podio::ObjectID	getObjectID () const

Friends
class	ClusterCollection

class	ClusterCollectionIterator

class	ConstCluster

Detailed Description

EIC cluster

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

Constructor & Destructor Documentation

◆ Cluster() [1/4]

eic::Cluster::Cluster ( )

default constructor

◆ Cluster() [2/4]

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

◆ Cluster() [3/4]

eic::Cluster::Cluster ( ClusterObj * obj )

constructor from existing ClusterObj

◆ Cluster() [4/4]

eic::Cluster::Cluster ( const Cluster & other )

copy constructor

◆ ~Cluster()

eic::Cluster::~Cluster ( )

destructor

Member Function Documentation

◆ clone()

Cluster eic::Cluster::clone ( ) const

support cloning (deep-copy)

◆ energy() [1/2]

const float & eic::Cluster::energy ( ) const

Access the Reconstructed energy of the cluster [GeV].

◆ energy() [2/2]

void eic::Cluster::energy ( float value )

Set the Reconstructed energy of the cluster [GeV].

◆ energyError() [1/2]

const float & eic::Cluster::energyError ( ) const

Access the Error on the cluster energy [GeV].

◆ energyError() [2/2]

void eic::Cluster::energyError ( float value )

Set the Error on the cluster energy [GeV].

◆ getObjectID()

const podio::ObjectID eic::Cluster::getObjectID ( ) const

◆ ID() [1/3]

eic::Index & eic::Cluster::ID ( )

Get reference to unique ID for this cluster.

◆ ID() [2/3]

const eic::Index & eic::Cluster::ID ( ) const

Access the unique ID for this cluster.

◆ id()

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

inline

◆ ID() [3/3]

void eic::Cluster::ID ( eic::Index value )

Set the unique ID for this cluster.

◆ isAvailable()

bool eic::Cluster::isAvailable ( ) const

check whether the object is actually available

◆ nhits() [1/2]

const std::uint32_t & eic::Cluster::nhits ( ) const

Access the Number of hits in the cluster.

◆ nhits() [2/2]

void eic::Cluster::nhits ( std::uint32_t value )

Set the Number of hits in the cluster.

◆ operator ConstCluster()

eic::Cluster::operator ConstCluster ( ) const

conversion to const object

◆ operator<()

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

inline

◆ operator=()

Cluster & eic::Cluster::operator= ( const Cluster & other )

copy-assignment operator

◆ operator==() [1/2]

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

inline

◆ operator==() [2/2]

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

◆ position() [1/3]

eic::VectorXYZ & eic::Cluster::position ( )

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

◆ position() [2/3]

const eic::VectorXYZ & eic::Cluster::position ( ) const

Access the Global position of the cluster [mm].

◆ position() [3/3]

void eic::Cluster::position ( eic::VectorXYZ value )

Set the Global position of the cluster [mm].

◆ positionError() [1/3]

eic::CovXYZ & eic::Cluster::positionError ( )

Get reference to Covariance matrix of the position (6 Parameters).

◆ positionError() [2/3]

const eic::CovXYZ & eic::Cluster::positionError ( ) const

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

◆ positionError() [3/3]

void eic::Cluster::positionError ( eic::CovXYZ value )

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

◆ radius() [1/2]

const float & eic::Cluster::radius ( ) const

Access the shower radius [mm].

◆ radius() [2/2]

void eic::Cluster::radius ( float value )

Set the shower radius [mm].

◆ skewness() [1/2]

const float & eic::Cluster::skewness ( ) const

Access the shower skewness [unitless].

◆ skewness() [2/2]

void eic::Cluster::skewness ( float value )

Set the shower skewness [unitless].

◆ time() [1/2]

const float & eic::Cluster::time ( ) const

Access the [ns].

◆ time() [2/2]

void eic::Cluster::time ( float value )

Set the [ns].

◆ unlink()

void eic::Cluster::unlink ( )

inline

disconnect from ClusterObj instance

Friends And Related Function Documentation

◆ ClusterCollection

friend class ClusterCollection

friend

◆ ClusterCollectionIterator

friend class ClusterCollectionIterator

friend

◆ ConstCluster

friend class ConstCluster

friend

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

eicd/Cluster.h
src/Cluster.cc

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Cluster() [1/4]

◆ Cluster() [2/4]

◆ Cluster() [3/4]

◆ Cluster() [4/4]

◆ ~Cluster()

Member Function Documentation

◆ clone()

◆ energy() [1/2]

◆ energy() [2/2]

◆ energyError() [1/2]

◆ energyError() [2/2]

◆ getObjectID()

◆ ID() [1/3]

◆ ID() [2/3]

◆ id()

◆ ID() [3/3]

◆ isAvailable()

◆ nhits() [1/2]

◆ nhits() [2/2]

◆ operator ConstCluster()

◆ operator<()

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ position() [1/3]

◆ position() [2/3]

◆ position() [3/3]

◆ positionError() [1/3]

◆ positionError() [2/3]

◆ positionError() [3/3]

◆ radius() [1/2]

◆ radius() [2/2]

◆ skewness() [1/2]

◆ skewness() [2/2]

◆ time() [1/2]

◆ time() [2/2]

◆ unlink()

Friends And Related Function Documentation

◆ ClusterCollection

◆ ClusterCollectionIterator

◆ ConstCluster