edm4eic::MutableCluster Class Reference

#include <MutableCluster.h>

Public Types
using	object_type = Cluster
using	collection_type = ClusterCollection

Public Member Functions
	MutableCluster ()
	default constructor
	MutableCluster (std::int32_t type, float energy, float energyError, float time, float timeError, std::uint32_t nhits, edm4hep::Vector3f position, edm4eic::Cov3f positionError, float intrinsicTheta, float intrinsicPhi, edm4eic::Cov2f intrinsicDirectionError)
	Constructor initializing all members.
	MutableCluster (const MutableCluster &other)=default
	copy constructor
MutableCluster &	operator= (MutableCluster other)
	copy-assignment operator
MutableCluster	clone () const
	create a mutable deep-copy of the object with identical relations
	~MutableCluster ()=default
	destructor
	operator Cluster () const
	conversion to const 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.
void	setType (std::int32_t value)
	Set the Flag-word that defines the type of the cluster.
void	setEnergy (float value)
	Set the Reconstructed energy of the cluster [GeV].
void	setEnergyError (float value)
	Set the Error on the cluster energy [GeV].
void	setTime (float value)
	Set the [ns].
void	setTimeError (float value)
	Set the Error on the cluster time.
void	setNhits (std::uint32_t value)
	Set the Number of hits in the cluster.
void	setPosition (edm4hep::Vector3f value)
	Set the Global position of the cluster [mm].
edm4hep::Vector3f &	position ()
	Get reference to Global position of the cluster [mm].
void	setPositionError (edm4eic::Cov3f value)
	Set the Covariance matrix of the position (6 Parameters).
edm4eic::Cov3f &	positionError ()
	Get reference to Covariance matrix of the position (6 Parameters).
void	setIntrinsicTheta (float value)
	Set the Intrinsic cluster propagation direction polar angle [rad].
void	setIntrinsicPhi (float value)
	Set the Intrinsic cluster propagation direction azimuthal angle [rad].
void	setIntrinsicDirectionError (edm4eic::Cov2f value)
	Set the Error on the intrinsic cluster propagation direction.
edm4eic::Cov2f &	intrinsicDirectionError ()
	Get reference to Error on the intrinsic cluster propagation direction.
void	addToClusters (edm4eic::Cluster)
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
void	addToHits (edm4eic::CalorimeterHit)
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
void	addToParticleIDs (edm4hep::ParticleID)
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
void	addToShapeParameters (float)
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
void	addToHitContributions (float)
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
void	addToSubdetectorEnergies (float)
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 MutableCluster &other) const
bool	operator== (const Cluster &other) const
bool	operator< (const MutableCluster &other) const
podio::ObjectID	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

Member Typedef Documentation

collection_type

using edm4eic::MutableCluster::collection_type = ClusterCollection

object_type

using edm4eic::MutableCluster::object_type = Cluster

Constructor & Destructor Documentation

MutableCluster() [1/3]

edm4eic::MutableCluster::MutableCluster

(

)

default constructor

MutableCluster() [2/3]

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

Constructor initializing all members.

MutableCluster() [3/3]

edm4eic::MutableCluster::MutableCluster ( const MutableCluster & other )

default

copy constructor

~MutableCluster()

edm4eic::MutableCluster::~MutableCluster ( )

default

destructor

Member Function Documentation

addToClusters()

void edm4eic::MutableCluster::addToClusters

(

edm4eic::Cluster

component

)

addToHitContributions()

void edm4eic::MutableCluster::addToHitContributions

(

float

component

)

addToHits()

void edm4eic::MutableCluster::addToHits

(

edm4eic::CalorimeterHit

component

)

addToParticleIDs()

void edm4eic::MutableCluster::addToParticleIDs

(

edm4hep::ParticleID

component

)

addToShapeParameters()

void edm4eic::MutableCluster::addToShapeParameters

(

float

component

)

addToSubdetectorEnergies()

void edm4eic::MutableCluster::addToSubdetectorEnergies

(

float

component

)

clone()

MutableCluster edm4eic::MutableCluster::clone

(

)

const

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

clusters_begin()

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

(

)

const

clusters_end()

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

(

)

const

clusters_size()

std::size_t edm4eic::MutableCluster::clusters_size

(

)

const

getClusters() [1/2]

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

(

)

const

getClusters() [2/2]

edm4eic::Cluster edm4eic::MutableCluster::getClusters

(

std::size_t

index

)

const

getEnergy()

float edm4eic::MutableCluster::getEnergy

(

)

const

Access the Reconstructed energy of the cluster [GeV].

getEnergyError()

float edm4eic::MutableCluster::getEnergyError

(

)

const

Access the Error on the cluster energy [GeV].

getHitContributions() [1/2]

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

(

)

const

getHitContributions() [2/2]

float edm4eic::MutableCluster::getHitContributions

(

std::size_t

index

)

const

getHits() [1/2]

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

(

)

const

getHits() [2/2]

edm4eic::CalorimeterHit edm4eic::MutableCluster::getHits

(

std::size_t

index

)

const

getIntrinsicDirectionError()

const edm4eic::Cov2f & edm4eic::MutableCluster::getIntrinsicDirectionError

(

)

const

Access the Error on the intrinsic cluster propagation direction.

getIntrinsicPhi()

float edm4eic::MutableCluster::getIntrinsicPhi

(

)

const

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

getIntrinsicTheta()

float edm4eic::MutableCluster::getIntrinsicTheta

(

)

const

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

getNhits()

std::uint32_t edm4eic::MutableCluster::getNhits

(

)

const

Access the Number of hits in the cluster.

getObjectID()

const podio::ObjectID edm4eic::MutableCluster::getObjectID

(

)

const

getParticleIDs() [1/2]

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

(

)

const

getParticleIDs() [2/2]

edm4hep::ParticleID edm4eic::MutableCluster::getParticleIDs

(

std::size_t

index

)

const

getPosition()

const edm4hep::Vector3f & edm4eic::MutableCluster::getPosition

(

)

const

Access the Global position of the cluster [mm].

getPositionError()

const edm4eic::Cov3f & edm4eic::MutableCluster::getPositionError

(

)

const

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

getShapeParameters() [1/2]

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

(

)

const

getShapeParameters() [2/2]

float edm4eic::MutableCluster::getShapeParameters

(

std::size_t

index

)

const

getSubdetectorEnergies() [1/2]

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

(

)

const

getSubdetectorEnergies() [2/2]

float edm4eic::MutableCluster::getSubdetectorEnergies

(

std::size_t

index

)

const

getTime()

float edm4eic::MutableCluster::getTime

(

)

const

Access the [ns].

getTimeError()

float edm4eic::MutableCluster::getTimeError

(

)

const

Access the Error on the cluster time.

getType()

std::int32_t edm4eic::MutableCluster::getType

(

)

const

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

hitContributions_begin()

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

(

)

const

hitContributions_end()

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

(

)

const

hitContributions_size()

std::size_t edm4eic::MutableCluster::hitContributions_size

(

)

const

hits_begin()

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

(

)

const

hits_end()

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

(

)

const

hits_size()

std::size_t edm4eic::MutableCluster::hits_size

(

)

const

id()

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

inline

intrinsicDirectionError()

edm4eic::Cov2f & edm4eic::MutableCluster::intrinsicDirectionError

(

)

Get reference to Error on the intrinsic cluster propagation direction.

isAvailable()

bool edm4eic::MutableCluster::isAvailable

(

)

const

check whether the object is actually available

operator Cluster()

edm4eic::MutableCluster::operator Cluster

(

)

const

conversion to const object

operator<()

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

inline

operator=()

MutableCluster & edm4eic::MutableCluster::operator=

(

MutableCluster

other

)

copy-assignment operator

operator==() [1/2]

bool edm4eic::MutableCluster::operator==

(

const Cluster &

other

)

const

operator==() [2/2]

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

inline

particleIDs_begin()

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

(

)

const

particleIDs_end()

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

(

)

const

particleIDs_size()

std::size_t edm4eic::MutableCluster::particleIDs_size

(

)

const

position()

edm4hep::Vector3f & edm4eic::MutableCluster::position

(

)

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

positionError()

edm4eic::Cov3f & edm4eic::MutableCluster::positionError

(

)

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

setEnergy()

void edm4eic::MutableCluster::setEnergy

(

float

value

)

Set the Reconstructed energy of the cluster [GeV].

setEnergyError()

void edm4eic::MutableCluster::setEnergyError

(

float

value

)

Set the Error on the cluster energy [GeV].

setIntrinsicDirectionError()

void edm4eic::MutableCluster::setIntrinsicDirectionError

(

edm4eic::Cov2f

value

)

Set the Error on the intrinsic cluster propagation direction.

setIntrinsicPhi()

void edm4eic::MutableCluster::setIntrinsicPhi

(

float

value

)

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

setIntrinsicTheta()

void edm4eic::MutableCluster::setIntrinsicTheta

(

float

value

)

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

setNhits()

void edm4eic::MutableCluster::setNhits

(

std::uint32_t

value

)

Set the Number of hits in the cluster.

setPosition()

void edm4eic::MutableCluster::setPosition

(

edm4hep::Vector3f

value

)

Set the Global position of the cluster [mm].

setPositionError()

void edm4eic::MutableCluster::setPositionError

(

edm4eic::Cov3f

value

)

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

setTime()

void edm4eic::MutableCluster::setTime

(

float

value

)

Set the [ns].

setTimeError()

void edm4eic::MutableCluster::setTimeError

(

float

value

)

Set the Error on the cluster time.

setType()

void edm4eic::MutableCluster::setType

(

std::int32_t

value

)

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

shapeParameters_begin()

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

(

)

const

shapeParameters_end()

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

(

)

const

shapeParameters_size()

std::size_t edm4eic::MutableCluster::shapeParameters_size

(

)

const

subdetectorEnergies_begin()

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

(

)

const

subdetectorEnergies_end()

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

(

)

const

subdetectorEnergies_size()

std::size_t edm4eic::MutableCluster::subdetectorEnergies_size

(

)

const

unlink()

void edm4eic::MutableCluster::unlink ( )

inline

disconnect from ClusterObj instance

Friends And Related Symbol 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/edm4eic/MutableCluster.h
• build/src/MutableCluster.cc