#include <Cluster.h>

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

	Cluster (std::int32_t type, float energy, float energyError, float time, float timeError, std::uint32_t nhits, edm4hep::Vector3f position, eicd::Cov3f positionError, float intrinsicTheta, float intrinsicPhi, eicd::Cov2f intrinsicDirectionError)

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

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

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

MutableCluster	clone () const
	create a mutable deep-copy of the object with identical relations More...

	~Cluster ()
	destructor More...

const std::int32_t &	getType () const
	Access the Flagword that defines the type of the cluster. More...

const float &	getEnergy () const
	Access the Reconstructed energy of the cluster [GeV]. More...

const float &	getEnergyError () const
	Access the Error on the cluster energy [GeV]. More...

const float &	getTime () const
	Access the [ns]. More...

const float &	getTimeError () const
	Access the Error on the cluster time. More...

const std::uint32_t &	getNhits () const
	Access the Number of hits in the cluster. More...

const edm4hep::Vector3f &	getPosition () const
	Access the Global position of the cluster [mm]. More...

const eicd::Cov3f &	getPositionError () const
	Access the Covariance matrix of the position (6 Parameters). More...

const float &	getIntrinsicTheta () const
	Access the Intrinsic cluster propagation direction polar angle [rad]. More...

const float &	getIntrinsicPhi () const
	Access the Intrinsic cluster propagation direction azimuthal angle [rad]. More...

const eicd::Cov2f &	getIntrinsicDirectionError () const
	Access the Error on the intrinsic cluster propagation direction. More...

unsigned int	clusters_size () const

eicd::Cluster	getClusters (unsigned int) const

std::vector< eicd::Cluster >::const_iterator	clusters_begin () const

std::vector< eicd::Cluster >::const_iterator	clusters_end () const

podio::RelationRange< eicd::Cluster >	getClusters () const

unsigned int	hits_size () const

eicd::CalorimeterHit	getHits (unsigned int) const

std::vector< eicd::CalorimeterHit >::const_iterator	hits_begin () const

std::vector< eicd::CalorimeterHit >::const_iterator	hits_end () const

podio::RelationRange< eicd::CalorimeterHit >	getHits () const

unsigned int	particleIDs_size () const

edm4hep::ParticleID	getParticleIDs (unsigned int) const

std::vector< edm4hep::ParticleID >::const_iterator	particleIDs_begin () const

std::vector< edm4hep::ParticleID >::const_iterator	particleIDs_end () const

podio::RelationRange< edm4hep::ParticleID >	getParticleIDs () const

unsigned int	shapeParameters_size () const

float	getShapeParameters (unsigned int) const

std::vector< float >::const_iterator	shapeParameters_begin () const

std::vector< float >::const_iterator	shapeParameters_end () const

podio::RelationRange< float >	getShapeParameters () const

unsigned int	hitContributions_size () const

float	getHitContributions (unsigned int) const

std::vector< float >::const_iterator	hitContributions_begin () const

std::vector< float >::const_iterator	hitContributions_end () const

podio::RelationRange< float >	getHitContributions () const

unsigned int	subdetectorEnergies_size () const

float	getSubdetectorEnergies (unsigned int) const

std::vector< float >::const_iterator	subdetectorEnergies_begin () const

std::vector< float >::const_iterator	subdetectorEnergies_end () const

podio::RelationRange< float >	getSubdetectorEnergies () const

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 MutableCluster &other) const

bool	operator< (const Cluster &other) const

unsigned int	id () const

const podio::ObjectID	getObjectID () const

Friends
class	MutableCluster

class	ClusterCollection

class	ClusterCollectionIterator

void	swap (Cluster &a, Cluster &b)

Detailed Description

EIC hit cluster, reworked to more closely resemble EDM4hep

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

Constructor & Destructor Documentation

◆ Cluster() [1/4]

eicd::Cluster::Cluster ( )

default constructor

◆ Cluster() [2/4]

eicd::Cluster::Cluster	(	std::int32_t	type,
		float	energy,
		float	energyError,
		float	time,
		float	timeError,
		std::uint32_t	nhits,
		edm4hep::Vector3f	position,
		eicd::Cov3f	positionError,
		float	intrinsicTheta,
		float	intrinsicPhi,
		eicd::Cov2f	intrinsicDirectionError
	)

◆ Cluster() [3/4]

eicd::Cluster::Cluster ( ClusterObj * obj )

constructor from existing ClusterObj

◆ Cluster() [4/4]

eicd::Cluster::Cluster ( const Cluster & other )

copy constructor

◆ ~Cluster()

eicd::Cluster::~Cluster ( )

destructor

Member Function Documentation

◆ clone()

MutableCluster eicd::Cluster::clone ( ) const

create a mutable deep-copy of the object with identical relations

◆ clusters_begin()

std::vector< eicd::Cluster >::const_iterator eicd::Cluster::clusters_begin ( ) const

◆ clusters_end()

std::vector< eicd::Cluster >::const_iterator eicd::Cluster::clusters_end ( ) const

◆ clusters_size()

unsigned int eicd::Cluster::clusters_size ( ) const

◆ getClusters() [1/2]

podio::RelationRange< eicd::Cluster > eicd::Cluster::getClusters ( ) const

◆ getClusters() [2/2]

eicd::Cluster eicd::Cluster::getClusters ( unsigned int index ) const

◆ getEnergy()

const float & eicd::Cluster::getEnergy ( ) const

Access the Reconstructed energy of the cluster [GeV].

◆ getEnergyError()

const float & eicd::Cluster::getEnergyError ( ) const

Access the Error on the cluster energy [GeV].

◆ getHitContributions() [1/2]

podio::RelationRange< float > eicd::Cluster::getHitContributions ( ) const

◆ getHitContributions() [2/2]

float eicd::Cluster::getHitContributions ( unsigned int index ) const

◆ getHits() [1/2]

podio::RelationRange< eicd::CalorimeterHit > eicd::Cluster::getHits ( ) const

◆ getHits() [2/2]

eicd::CalorimeterHit eicd::Cluster::getHits ( unsigned int index ) const

◆ getIntrinsicDirectionError()

const eicd::Cov2f & eicd::Cluster::getIntrinsicDirectionError ( ) const

Access the Error on the intrinsic cluster propagation direction.

◆ getIntrinsicPhi()

const float & eicd::Cluster::getIntrinsicPhi ( ) const

Access the Intrinsic cluster propagation direction azimuthal angle [rad].

◆ getIntrinsicTheta()

const float & eicd::Cluster::getIntrinsicTheta ( ) const

Access the Intrinsic cluster propagation direction polar angle [rad].

◆ getNhits()

const std::uint32_t & eicd::Cluster::getNhits ( ) const

Access the Number of hits in the cluster.

◆ getObjectID()

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

◆ getParticleIDs() [1/2]

podio::RelationRange< edm4hep::ParticleID > eicd::Cluster::getParticleIDs ( ) const

◆ getParticleIDs() [2/2]

edm4hep::ParticleID eicd::Cluster::getParticleIDs ( unsigned int index ) const

◆ getPosition()

const edm4hep::Vector3f & eicd::Cluster::getPosition ( ) const

Access the Global position of the cluster [mm].

◆ getPositionError()

const eicd::Cov3f & eicd::Cluster::getPositionError ( ) const

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

◆ getShapeParameters() [1/2]

podio::RelationRange< float > eicd::Cluster::getShapeParameters ( ) const

◆ getShapeParameters() [2/2]

float eicd::Cluster::getShapeParameters ( unsigned int index ) const

◆ getSubdetectorEnergies() [1/2]

podio::RelationRange< float > eicd::Cluster::getSubdetectorEnergies ( ) const

◆ getSubdetectorEnergies() [2/2]

float eicd::Cluster::getSubdetectorEnergies ( unsigned int index ) const

◆ getTime()

const float & eicd::Cluster::getTime ( ) const

Access the [ns].

◆ getTimeError()

const float & eicd::Cluster::getTimeError ( ) const

Access the Error on the cluster time.

◆ getType()

const std::int32_t & eicd::Cluster::getType ( ) const

Access the Flagword that defines the type of the cluster.

◆ hitContributions_begin()

std::vector< float >::const_iterator eicd::Cluster::hitContributions_begin ( ) const

◆ hitContributions_end()

std::vector< float >::const_iterator eicd::Cluster::hitContributions_end ( ) const

◆ hitContributions_size()

unsigned int eicd::Cluster::hitContributions_size ( ) const

◆ hits_begin()

std::vector< eicd::CalorimeterHit >::const_iterator eicd::Cluster::hits_begin ( ) const

◆ hits_end()

std::vector< eicd::CalorimeterHit >::const_iterator eicd::Cluster::hits_end ( ) const

◆ hits_size()

unsigned int eicd::Cluster::hits_size ( ) const

◆ id()

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

inline

◆ isAvailable()

bool eicd::Cluster::isAvailable ( ) const

check whether the object is actually available

◆ operator<()

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

inline

◆ operator=()

Cluster & eicd::Cluster::operator= ( Cluster other )

copy-assignment operator

◆ operator==() [1/2]

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

inline

◆ operator==() [2/2]

bool eicd::Cluster::operator== ( const MutableCluster & other ) const

◆ particleIDs_begin()

std::vector< edm4hep::ParticleID >::const_iterator eicd::Cluster::particleIDs_begin ( ) const

◆ particleIDs_end()

std::vector< edm4hep::ParticleID >::const_iterator eicd::Cluster::particleIDs_end ( ) const

◆ particleIDs_size()

unsigned int eicd::Cluster::particleIDs_size ( ) const

◆ shapeParameters_begin()

std::vector< float >::const_iterator eicd::Cluster::shapeParameters_begin ( ) const

◆ shapeParameters_end()

std::vector< float >::const_iterator eicd::Cluster::shapeParameters_end ( ) const

◆ shapeParameters_size()

unsigned int eicd::Cluster::shapeParameters_size ( ) const

◆ subdetectorEnergies_begin()

std::vector< float >::const_iterator eicd::Cluster::subdetectorEnergies_begin ( ) const

◆ subdetectorEnergies_end()

std::vector< float >::const_iterator eicd::Cluster::subdetectorEnergies_end ( ) const

◆ subdetectorEnergies_size()

unsigned int eicd::Cluster::subdetectorEnergies_size ( ) const

◆ unlink()

void eicd::Cluster::unlink ( )

inline

disconnect from ClusterObj instance

Friends And Related Function Documentation

◆ ClusterCollection

friend class ClusterCollection

friend

◆ ClusterCollectionIterator

friend class ClusterCollectionIterator

friend

◆ MutableCluster

friend class MutableCluster

friend

◆ swap

void swap	(	Cluster &	a,
		Cluster &	b
	)

friend

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

build/eicd/Cluster.h
build/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()

◆ clusters_begin()

◆ clusters_end()

◆ clusters_size()

◆ getClusters() [1/2]

◆ getClusters() [2/2]

◆ getEnergy()

◆ getEnergyError()

◆ getHitContributions() [1/2]

◆ getHitContributions() [2/2]

◆ getHits() [1/2]

◆ getHits() [2/2]

◆ getIntrinsicDirectionError()

◆ getIntrinsicPhi()

◆ getIntrinsicTheta()

◆ getNhits()

◆ getObjectID()

◆ getParticleIDs() [1/2]

◆ getParticleIDs() [2/2]

◆ getPosition()

◆ getPositionError()

◆ getShapeParameters() [1/2]

◆ getShapeParameters() [2/2]

◆ getSubdetectorEnergies() [1/2]

◆ getSubdetectorEnergies() [2/2]

◆ getTime()

◆ getTimeError()

◆ getType()

◆ hitContributions_begin()

◆ hitContributions_end()

◆ hitContributions_size()

◆ hits_begin()

◆ hits_end()

◆ hits_size()

◆ id()

◆ isAvailable()

◆ operator<()

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ particleIDs_begin()

◆ particleIDs_end()

◆ particleIDs_size()

◆ shapeParameters_begin()

◆ shapeParameters_end()

◆ shapeParameters_size()

◆ subdetectorEnergies_begin()

◆ subdetectorEnergies_end()

◆ subdetectorEnergies_size()

◆ unlink()

Friends And Related Function Documentation

◆ ClusterCollection

◆ ClusterCollectionIterator

◆ MutableCluster

◆ swap