edm4eic::Cluster Class Reference

#include <Cluster.h>

Public Types
using	mutable_type = MutableCluster
using	collection_type = ClusterCollection

Public Member Functions
	Cluster ()
	default constructor
	Cluster (const std::int32_t type, const float energy, const float energyError, const float time, const float timeError, const std::uint32_t nhits, const edm4hep::Vector3f &position, const edm4eic::Cov3f &positionError, const float intrinsicTheta, const float intrinsicPhi, const edm4eic::Cov2f &intrinsicDirectionError)
	Constructor initializing all members.
	Cluster (const Cluster &other)=default
	copy constructor
Cluster &	operator= (Cluster other) &
	copy-assignment operator
Cluster &	operator= (Cluster other) &&=delete
MutableCluster	clone (bool cloneRelations=true) const
	~Cluster ()=default
	destructor
	Cluster (const MutableCluster &other)
	converting constructor from mutable object
std::int32_t	getType () const
	Access the Flag-word that defines the type of the cluster.
float	getEnergy () const
	Access the Reconstructed energy of the cluster [GeV].
float	getEnergyError () const
	Access the Error on the cluster energy [GeV].
float	getTime () const
	Access the [ns].
float	getTimeError () const
	Access the Error on the cluster time.
std::uint32_t	getNhits () const
	Access the Number of hits in the cluster.
const edm4hep::Vector3f &	getPosition () const
	Access the Global position of the cluster [mm].
const edm4eic::Cov3f &	getPositionError () const
	Access the Covariance matrix of the position (6 Parameters).
float	getIntrinsicTheta () const
	Access the Intrinsic cluster propagation direction polar angle [rad].
float	getIntrinsicPhi () const
	Access the Intrinsic cluster propagation direction azimuthal angle [rad].
const edm4eic::Cov2f &	getIntrinsicDirectionError () const
	Access the Error on the intrinsic cluster propagation direction.
std::size_t	clusters_size () const
edm4eic::Cluster	getClusters (std::size_t) const
std::vector< edm4eic::Cluster >::const_iterator	clusters_begin () const
std::vector< edm4eic::Cluster >::const_iterator	clusters_end () const
podio::RelationRange< edm4eic::Cluster >	getClusters () const
std::size_t	hits_size () const
edm4eic::CalorimeterHit	getHits (std::size_t) const
std::vector< edm4eic::CalorimeterHit >::const_iterator	hits_begin () const
std::vector< edm4eic::CalorimeterHit >::const_iterator	hits_end () const
podio::RelationRange< edm4eic::CalorimeterHit >	getHits () const
std::size_t	particleIDs_size () const
edm4hep::ParticleID	getParticleIDs (std::size_t) 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
std::size_t	shapeParameters_size () const
float	getShapeParameters (std::size_t) const
std::vector< float >::const_iterator	shapeParameters_begin () const
std::vector< float >::const_iterator	shapeParameters_end () const
podio::RelationRange< float >	getShapeParameters () const
std::size_t	hitContributions_size () const
float	getHitContributions (std::size_t) const
std::vector< float >::const_iterator	hitContributions_begin () const
std::vector< float >::const_iterator	hitContributions_end () const
podio::RelationRange< float >	getHitContributions () const
std::size_t	subdetectorEnergies_size () const
float	getSubdetectorEnergies (std::size_t) 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
void	unlink ()
	disconnect from ClusterObj instance
bool	operator== (const Cluster &other) const
bool	operator== (const MutableCluster &other) const
bool	operator!= (const Cluster &other) const
bool	operator!= (const MutableCluster &other) const
bool	operator< (const Cluster &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static Cluster	makeEmpty ()

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::Cluster"

Friends
class	MutableCluster
class	ClusterCollection
class	edm4eic::ClusterCollectionData
class	ClusterCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const Cluster &obj)
void	swap (Cluster &a, Cluster &b)

Detailed Description

EIC hit cluster, reworked to more closely resemble EDM4hep

Author

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

Member Typedef Documentation

collection_type

using edm4eic::Cluster::collection_type = ClusterCollection

mutable_type

using edm4eic::Cluster::mutable_type = MutableCluster

Constructor & Destructor Documentation

Cluster() [1/4]

edm4eic::Cluster::Cluster

(

)

default constructor

Cluster() [2/4]

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

Constructor initializing all members.

Cluster() [3/4]

edm4eic::Cluster::Cluster ( const Cluster & other )

default

copy constructor

~Cluster()

edm4eic::Cluster::~Cluster ( )

default

destructor

Cluster() [4/4]

edm4eic::Cluster::Cluster

(

const MutableCluster &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableCluster edm4eic::Cluster::clone

(

bool

cloneRelations = true

)

const

create a mutable deep-copy of the object with identical relations if cloneRelations=false, the relations are not cloned and will be empty

clusters_begin()

std::vector< edm4eic::Cluster >::const_iterator edm4eic::Cluster::clusters_begin

(

)

const

clusters_end()

std::vector< edm4eic::Cluster >::const_iterator edm4eic::Cluster::clusters_end

(

)

const

clusters_size()

std::size_t edm4eic::Cluster::clusters_size

(

)

const

getClusters() [1/2]

podio::RelationRange< edm4eic::Cluster > edm4eic::Cluster::getClusters

(

)

const

getClusters() [2/2]

edm4eic::Cluster edm4eic::Cluster::getClusters

(

std::size_t

index

)

const

getEnergy()

float edm4eic::Cluster::getEnergy

(

)

const

Access the Reconstructed energy of the cluster [GeV].

getEnergyError()

float edm4eic::Cluster::getEnergyError

(

)

const

Access the Error on the cluster energy [GeV].

getHitContributions() [1/2]

podio::RelationRange< float > edm4eic::Cluster::getHitContributions

(

)

const

getHitContributions() [2/2]

float edm4eic::Cluster::getHitContributions

(

std::size_t

index

)

const

getHits() [1/2]

podio::RelationRange< edm4eic::CalorimeterHit > edm4eic::Cluster::getHits

(

)

const

getHits() [2/2]

edm4eic::CalorimeterHit edm4eic::Cluster::getHits

(

std::size_t

index

)

const

getIntrinsicDirectionError()

const edm4eic::Cov2f & edm4eic::Cluster::getIntrinsicDirectionError

(

)

const

Access the Error on the intrinsic cluster propagation direction.

getIntrinsicPhi()

float edm4eic::Cluster::getIntrinsicPhi

(

)

const

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

getIntrinsicTheta()

float edm4eic::Cluster::getIntrinsicTheta

(

)

const

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

getNhits()

std::uint32_t edm4eic::Cluster::getNhits

(

)

const

Access the Number of hits in the cluster.

getObjectID()

const podio::ObjectID edm4eic::Cluster::getObjectID

(

)

const

getParticleIDs() [1/2]

podio::RelationRange< edm4hep::ParticleID > edm4eic::Cluster::getParticleIDs

(

)

const

getParticleIDs() [2/2]

edm4hep::ParticleID edm4eic::Cluster::getParticleIDs

(

std::size_t

index

)

const

getPosition()

const edm4hep::Vector3f & edm4eic::Cluster::getPosition

(

)

const

Access the Global position of the cluster [mm].

getPositionError()

const edm4eic::Cov3f & edm4eic::Cluster::getPositionError

(

)

const

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

getShapeParameters() [1/2]

podio::RelationRange< float > edm4eic::Cluster::getShapeParameters

(

)

const

getShapeParameters() [2/2]

float edm4eic::Cluster::getShapeParameters

(

std::size_t

index

)

const

getSubdetectorEnergies() [1/2]

podio::RelationRange< float > edm4eic::Cluster::getSubdetectorEnergies

(

)

const

getSubdetectorEnergies() [2/2]

float edm4eic::Cluster::getSubdetectorEnergies

(

std::size_t

index

)

const

getTime()

float edm4eic::Cluster::getTime

(

)

const

Access the [ns].

getTimeError()

float edm4eic::Cluster::getTimeError

(

)

const

Access the Error on the cluster time.

getType()

std::int32_t edm4eic::Cluster::getType

(

)

const

Access the Flag-word that defines the type of the cluster.

hitContributions_begin()

std::vector< float >::const_iterator edm4eic::Cluster::hitContributions_begin

(

)

const

hitContributions_end()

std::vector< float >::const_iterator edm4eic::Cluster::hitContributions_end

(

)

const

hitContributions_size()

std::size_t edm4eic::Cluster::hitContributions_size

(

)

const

hits_begin()

std::vector< edm4eic::CalorimeterHit >::const_iterator edm4eic::Cluster::hits_begin

(

)

const

hits_end()

std::vector< edm4eic::CalorimeterHit >::const_iterator edm4eic::Cluster::hits_end

(

)

const

hits_size()

std::size_t edm4eic::Cluster::hits_size

(

)

const

id()

podio::ObjectID edm4eic::Cluster::id ( ) const

inline

isAvailable()

bool edm4eic::Cluster::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

Cluster edm4eic::Cluster::makeEmpty ( )

static

operator!=() [1/2]

bool edm4eic::Cluster::operator!= ( const Cluster & other ) const

inline

operator!=() [2/2]

bool edm4eic::Cluster::operator!= ( const MutableCluster & other ) const

inline

operator<()

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

inline

operator=() [1/2]

Cluster & edm4eic::Cluster::operator=

(

Cluster

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::Cluster::operator==

(

const MutableCluster &

other

)

const

particleIDs_begin()

std::vector< edm4hep::ParticleID >::const_iterator edm4eic::Cluster::particleIDs_begin

(

)

const

particleIDs_end()

std::vector< edm4hep::ParticleID >::const_iterator edm4eic::Cluster::particleIDs_end

(

)

const

particleIDs_size()

std::size_t edm4eic::Cluster::particleIDs_size

(

)

const

shapeParameters_begin()

std::vector< float >::const_iterator edm4eic::Cluster::shapeParameters_begin

(

)

const

shapeParameters_end()

std::vector< float >::const_iterator edm4eic::Cluster::shapeParameters_end

(

)

const

shapeParameters_size()

std::size_t edm4eic::Cluster::shapeParameters_size

(

)

const

subdetectorEnergies_begin()

std::vector< float >::const_iterator edm4eic::Cluster::subdetectorEnergies_begin

(

)

const

subdetectorEnergies_end()

std::vector< float >::const_iterator edm4eic::Cluster::subdetectorEnergies_end

(

)

const

subdetectorEnergies_size()

std::size_t edm4eic::Cluster::subdetectorEnergies_size

(

)

const

unlink()

void edm4eic::Cluster::unlink ( )

inline

disconnect from ClusterObj instance

Friends And Related Symbol Documentation

ClusterCollection

friend class ClusterCollection

friend

ClusterCollectionIterator

friend class ClusterCollectionIterator

friend

edm4eic::ClusterCollectionData

friend class edm4eic::ClusterCollectionData

friend

MutableCluster

friend class MutableCluster

friend

podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const Cluster & obj )

friend

swap

void swap ( Cluster & a, Cluster & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::Cluster::typeName = "edm4eic::Cluster"

staticconstexpr

---

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

• build/edm4eic/Cluster.h
• build/src/Cluster.cc