#include <MutableCluster.h>

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

	MutableCluster (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)

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

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

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

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

	~MutableCluster ()
	destructor More...

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

void	setType (std::int32_t value)
	Set the Flagword that defines the type of the cluster. More...

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

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

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

void	setTimeError (float value)
	Set the Error on the cluster time. More...

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

void	setPosition (edm4hep::Vector3f value)
	Set the Global position of the cluster [mm]. More...

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

void	setPositionError (eicd::Cov3f value)
	Set the Covariance matrix of the position (6 Parameters). More...

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

void	setIntrinsicTheta (float value)
	Set the Intrinsic cluster propagation direction polar angle [rad]. More...

void	setIntrinsicPhi (float value)
	Set the Intrinsic cluster propagation direction azimuthal angle [rad]. More...

void	setIntrinsicDirectionError (eicd::Cov2f value)
	Set the Error on the intrinsic cluster propagation direction. More...

eicd::Cov2f &	intrinsicDirectionError ()
	Get reference to Error on the intrinsic cluster propagation direction. More...

void	addToClusters (eicd::Cluster)

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

void	addToHits (eicd::CalorimeterHit)

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

void	addToParticleIDs (edm4hep::ParticleID)

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

void	addToShapeParameters (float)

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

void	addToHitContributions (float)

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

void	addToSubdetectorEnergies (float)

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

bool	operator== (const Cluster &other) const

bool	operator< (const MutableCluster &other) const

unsigned int	id () const

const podio::ObjectID	getObjectID () const

Friends
class	ClusterCollection

class	ClusterMutableCollectionIterator

class	Cluster

void	swap (MutableCluster &a, MutableCluster &b)

Detailed Description

EIC hit cluster, reworked to more closely resemble EDM4hep

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

Constructor & Destructor Documentation

◆ MutableCluster() [1/4]

eicd::MutableCluster::MutableCluster ( )

default constructor

◆ MutableCluster() [2/4]

eicd::MutableCluster::MutableCluster	(	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
	)

◆ MutableCluster() [3/4]

eicd::MutableCluster::MutableCluster ( ClusterObj * obj )

constructor from existing ClusterObj

◆ MutableCluster() [4/4]

eicd::MutableCluster::MutableCluster ( const MutableCluster & other )

copy constructor

◆ ~MutableCluster()

eicd::MutableCluster::~MutableCluster ( )

destructor

Member Function Documentation

◆ addToClusters()

void eicd::MutableCluster::addToClusters ( eicd::Cluster component )

◆ addToHitContributions()

void eicd::MutableCluster::addToHitContributions ( float component )

◆ addToHits()

void eicd::MutableCluster::addToHits ( eicd::CalorimeterHit component )

◆ addToParticleIDs()

void eicd::MutableCluster::addToParticleIDs ( edm4hep::ParticleID component )

◆ addToShapeParameters()

void eicd::MutableCluster::addToShapeParameters ( float component )

◆ addToSubdetectorEnergies()

void eicd::MutableCluster::addToSubdetectorEnergies ( float component )

◆ clone()

MutableCluster eicd::MutableCluster::clone ( ) const

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

◆ clusters_begin()

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

◆ clusters_end()

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

◆ clusters_size()

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

◆ getClusters() [1/2]

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

◆ getClusters() [2/2]

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

◆ getEnergy()

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

Access the Reconstructed energy of the cluster [GeV].

◆ getEnergyError()

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

Access the Error on the cluster energy [GeV].

◆ getHitContributions() [1/2]

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

◆ getHitContributions() [2/2]

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

◆ getHits() [1/2]

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

◆ getHits() [2/2]

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

◆ getIntrinsicDirectionError()

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

Access the Error on the intrinsic cluster propagation direction.

◆ getIntrinsicPhi()

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

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

◆ getIntrinsicTheta()

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

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

◆ getNhits()

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

Access the Number of hits in the cluster.

◆ getObjectID()

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

◆ getParticleIDs() [1/2]

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

◆ getParticleIDs() [2/2]

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

◆ getPosition()

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

Access the Global position of the cluster [mm].

◆ getPositionError()

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

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

◆ getShapeParameters() [1/2]

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

◆ getShapeParameters() [2/2]

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

◆ getSubdetectorEnergies() [1/2]

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

◆ getSubdetectorEnergies() [2/2]

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

◆ getTime()

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

Access the [ns].

◆ getTimeError()

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

Access the Error on the cluster time.

◆ getType()

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

Access the Flagword that defines the type of the cluster.

◆ hitContributions_begin()

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

◆ hitContributions_end()

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

◆ hitContributions_size()

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

◆ hits_begin()

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

◆ hits_end()

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

◆ hits_size()

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

◆ id()

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

inline

◆ intrinsicDirectionError()

eicd::Cov2f & eicd::MutableCluster::intrinsicDirectionError ( )

Get reference to Error on the intrinsic cluster propagation direction.

◆ isAvailable()

bool eicd::MutableCluster::isAvailable ( ) const

check whether the object is actually available

◆ operator Cluster()

eicd::MutableCluster::operator Cluster ( ) const

conversion to const object

◆ operator<()

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

inline

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

inline

◆ particleIDs_begin()

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

◆ particleIDs_end()

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

◆ particleIDs_size()

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

◆ position()

edm4hep::Vector3f & eicd::MutableCluster::position ( )

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

◆ positionError()

eicd::Cov3f & eicd::MutableCluster::positionError ( )

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

◆ setEnergy()

void eicd::MutableCluster::setEnergy ( float value )

Set the Reconstructed energy of the cluster [GeV].

◆ setEnergyError()

void eicd::MutableCluster::setEnergyError ( float value )

Set the Error on the cluster energy [GeV].

◆ setIntrinsicDirectionError()

void eicd::MutableCluster::setIntrinsicDirectionError ( eicd::Cov2f value )

Set the Error on the intrinsic cluster propagation direction.

◆ setIntrinsicPhi()

void eicd::MutableCluster::setIntrinsicPhi ( float value )

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

◆ setIntrinsicTheta()

void eicd::MutableCluster::setIntrinsicTheta ( float value )

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

◆ setNhits()

void eicd::MutableCluster::setNhits ( std::uint32_t value )

Set the Number of hits in the cluster.

◆ setPosition()

void eicd::MutableCluster::setPosition ( edm4hep::Vector3f value )

Set the Global position of the cluster [mm].

◆ setPositionError()

void eicd::MutableCluster::setPositionError ( eicd::Cov3f value )

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

◆ setTime()

void eicd::MutableCluster::setTime ( float value )

Set the [ns].

◆ setTimeError()

void eicd::MutableCluster::setTimeError ( float value )

Set the Error on the cluster time.

◆ setType()

void eicd::MutableCluster::setType ( std::int32_t value )

Set the Flagword that defines the type of the cluster.

◆ shapeParameters_begin()

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

◆ shapeParameters_end()

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

◆ shapeParameters_size()

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

◆ subdetectorEnergies_begin()

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

◆ subdetectorEnergies_end()

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

◆ subdetectorEnergies_size()

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

◆ unlink()

void eicd::MutableCluster::unlink ( )

inline

disconnect from ClusterObj instance

Friends And Related Function Documentation

◆ Cluster

friend class Cluster

friend

◆ ClusterCollection

friend class ClusterCollection

friend

◆ ClusterMutableCollectionIterator

friend class ClusterMutableCollectionIterator

friend

◆ swap

void swap	(	MutableCluster &	a,
		MutableCluster &	b
	)

friend

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

build/eicd/MutableCluster.h
build/src/MutableCluster.cc

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MutableCluster() [1/4]

◆ MutableCluster() [2/4]

◆ MutableCluster() [3/4]

◆ MutableCluster() [4/4]

◆ ~MutableCluster()

Member Function Documentation

◆ addToClusters()

◆ addToHitContributions()

◆ addToHits()

◆ addToParticleIDs()

◆ addToShapeParameters()

◆ addToSubdetectorEnergies()

◆ 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()

◆ intrinsicDirectionError()

◆ isAvailable()

◆ operator Cluster()

◆ operator<()

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ particleIDs_begin()

◆ particleIDs_end()

◆ particleIDs_size()

◆ position()

◆ positionError()

◆ setEnergy()

◆ setEnergyError()

◆ setIntrinsicDirectionError()

◆ setIntrinsicPhi()

◆ setIntrinsicTheta()

◆ setNhits()

◆ setPosition()

◆ setPositionError()

◆ setTime()

◆ setTimeError()

◆ setType()

◆ shapeParameters_begin()

◆ shapeParameters_end()

◆ shapeParameters_size()

◆ subdetectorEnergies_begin()

◆ subdetectorEnergies_end()

◆ subdetectorEnergies_size()