eic::ClusterLayer Class Reference

#include <ClusterLayer.h>

Public Member Functions
	ClusterLayer ()
	default constructor More...
	ClusterLayer (eic::Index ID, eic::Index clusterID, std::int32_t layer, std::uint32_t nhits, float energy, float energyError, float radius, float skewness, eic::VectorXYZ position)
	ClusterLayer (ClusterLayerObj *obj)
	constructor from existing ClusterLayerObj More...
	ClusterLayer (const ClusterLayer &other)
	copy constructor More...
ClusterLayer &	operator= (const ClusterLayer &other)
	copy-assignment operator More...
ClusterLayer	clone () const
	support cloning (deep-copy) More...
	~ClusterLayer ()
	destructor More...
	operator ConstClusterLayer () const
	conversion to const object More...
const eic::Index &	ID () const
	Access the unique layer ID. More...
const eic::Index &	clusterID () const
	Access the associated full 3D cluster, -1 if none. More...
const std::int32_t &	layer () const
	Access the layer number for this cluster layer. More...
const std::uint32_t &	nhits () const
	Access the Number of hits. More...
const float &	energy () const
	Access the Energy in this cluster layer [GeV]. More...
const float &	energyError () const
	Access the Error on energy [GeV]. More...
const float &	radius () const
	Access the Shower radius [mm]. More...
const float &	skewness () const
	Access the Skewness of hits distribution. More...
const eic::VectorXYZ &	position () const
	Access the Global center position. [mm]. More...
void	ID (eic::Index value)
	Set the unique layer ID. More...
eic::Index &	ID ()
	Get reference to unique layer ID. More...
void	clusterID (eic::Index value)
	Set the associated full 3D cluster, -1 if none. More...
eic::Index &	clusterID ()
	Get reference to associated full 3D cluster, -1 if none. More...
void	layer (std::int32_t value)
	Set the layer number for this cluster layer. More...
void	nhits (std::uint32_t value)
	Set the Number of hits. More...
void	energy (float value)
	Set the Energy in this cluster layer [GeV]. More...
void	energyError (float value)
	Set the Error on energy [GeV]. More...
void	radius (float value)
	Set the Shower radius [mm]. More...
void	skewness (float value)
	Set the Skewness of hits distribution. More...
void	position (eic::VectorXYZ value)
	Set the Global center position. [mm]. More...
eic::VectorXYZ &	position ()
	Get reference to Global center position. [mm]. More...
bool	isAvailable () const
	check whether the object is actually available More...
void	unlink ()
	disconnect from ClusterLayerObj instance More...
bool	operator== (const ClusterLayer &other) const
bool	operator== (const ConstClusterLayer &other) const
bool	operator< (const ClusterLayer &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	ClusterLayerCollection
class	ClusterLayerCollectionIterator
class	ConstClusterLayer

Detailed Description

2D Cluster in a single layer for a multi-layer detector

Author

: S. Joosten, C. Peng

Constructor & Destructor Documentation

ClusterLayer() [1/4]

eic::ClusterLayer::ClusterLayer

(

)

default constructor

ClusterLayer() [2/4]

eic::ClusterLayer::ClusterLayer	(	eic::Index	ID,
		eic::Index	clusterID,
		std::int32_t	layer,
		std::uint32_t	nhits,
		float	energy,
		float	energyError,
		float	radius,
		float	skewness,
		eic::VectorXYZ	position
	)

ClusterLayer() [3/4]

eic::ClusterLayer::ClusterLayer

(

ClusterLayerObj *

obj

)

constructor from existing ClusterLayerObj

ClusterLayer() [4/4]

eic::ClusterLayer::ClusterLayer

(

const ClusterLayer &

other

)

copy constructor

~ClusterLayer()

eic::ClusterLayer::~ClusterLayer

(

)

destructor

Member Function Documentation

clone()

ClusterLayer eic::ClusterLayer::clone

(

)

const

support cloning (deep-copy)

clusterID() [1/3]

eic::Index & eic::ClusterLayer::clusterID

(

)

Get reference to associated full 3D cluster, -1 if none.

clusterID() [2/3]

const eic::Index & eic::ClusterLayer::clusterID

(

)

const

Access the associated full 3D cluster, -1 if none.

clusterID() [3/3]

void eic::ClusterLayer::clusterID

(

eic::Index

value

)

Set the associated full 3D cluster, -1 if none.

energy() [1/2]

const float & eic::ClusterLayer::energy

(

)

const

Access the Energy in this cluster layer [GeV].

energy() [2/2]

void eic::ClusterLayer::energy

(

float

value

)

Set the Energy in this cluster layer [GeV].

energyError() [1/2]

const float & eic::ClusterLayer::energyError

(

)

const

Access the Error on energy [GeV].

energyError() [2/2]

void eic::ClusterLayer::energyError

(

float

value

)

Set the Error on energy [GeV].

getObjectID()

const podio::ObjectID eic::ClusterLayer::getObjectID

(

)

const

ID() [1/3]

eic::Index & eic::ClusterLayer::ID

(

)

Get reference to unique layer ID.

ID() [2/3]

const eic::Index & eic::ClusterLayer::ID

(

)

const

Access the unique layer ID.

id()

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

inline

ID() [3/3]

void eic::ClusterLayer::ID

(

eic::Index

value

)

Set the unique layer ID.

isAvailable()

bool eic::ClusterLayer::isAvailable

(

)

const

check whether the object is actually available

layer() [1/2]

const std::int32_t & eic::ClusterLayer::layer

(

)

const

Access the layer number for this cluster layer.

layer() [2/2]

void eic::ClusterLayer::layer

(

std::int32_t

value

)

Set the layer number for this cluster layer.

nhits() [1/2]

const std::uint32_t & eic::ClusterLayer::nhits

(

)

const

Access the Number of hits.

nhits() [2/2]

void eic::ClusterLayer::nhits

(

std::uint32_t

value

)

Set the Number of hits.

operator ConstClusterLayer()

eic::ClusterLayer::operator ConstClusterLayer

(

)

const

conversion to const object

operator<()

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

inline

operator=()

ClusterLayer & eic::ClusterLayer::operator=

(

const ClusterLayer &

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool eic::ClusterLayer::operator==

(

const ConstClusterLayer &

other

)

const

position() [1/3]

eic::VectorXYZ & eic::ClusterLayer::position

(

)

Get reference to Global center position. [mm].

position() [2/3]

const eic::VectorXYZ & eic::ClusterLayer::position

(

)

const

Access the Global center position. [mm].

position() [3/3]

void eic::ClusterLayer::position

(

eic::VectorXYZ

value

)

Set the Global center position. [mm].

radius() [1/2]

const float & eic::ClusterLayer::radius

(

)

const

Access the Shower radius [mm].

radius() [2/2]

void eic::ClusterLayer::radius

(

float

value

)

Set the Shower radius [mm].

skewness() [1/2]

const float & eic::ClusterLayer::skewness

(

)

const

Access the Skewness of hits distribution.

skewness() [2/2]

void eic::ClusterLayer::skewness

(

float

value

)

Set the Skewness of hits distribution.

unlink()

void eic::ClusterLayer::unlink ( )

inline

disconnect from ClusterLayerObj instance

Friends And Related Function Documentation

ClusterLayerCollection

friend class ClusterLayerCollection

friend

ClusterLayerCollectionIterator

friend class ClusterLayerCollectionIterator

friend

ConstClusterLayer

friend class ConstClusterLayer

friend

---

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

• eicd/ClusterLayer.h
• src/ClusterLayer.cc