Herd::Cluster Class Reference

Tracker cluster object for transient data model. More...

#include <dataobjects/Cluster.h>

Inheritance diagram for Herd::Cluster:

Public Member Functions
	Cluster ()
	Default constructor. More...
	Cluster (std::vector< Hit > hits, size_t seedIndex)
	Constructor. More...
virtual	~Cluster ()=default
	Virtual destructor. More...
const std::vector< Hit > &	Hits () const
	Gets the hits forming the cluster. More...
void	SetHits (std::vector< Hit > hits, size_t seedIndex)
	Sets the hits forming the cluster. More...
size_t	SeedHitIndex () const
	Gets the index of the seed hit within the hits vector. More...
float	EDep () const
	Gets the deposited energy associated to the cluster. More...
Point	COGPosition (const TrackingDetectorGeoParams &geoParams) const
	Get the center of gravity position of the cluster. More...
bool	operator== (const Cluster &right) const
	Get the center of gravity position of the fit cluster. More...

Protected Attributes
std::vector< Hit >	_hits
	Hits in each channel constituting the cluster. More...

Private Member Functions
void	_ComputeEdep ()
	Update the value of _edep. More...

Private Attributes
float	_eDep
	Deposited energy [GeV]. More...
size_t	_seedHitIndex
	Index of the seed channel in the hits vector. More...

Detailed Description

Tracker cluster object for transient data model.

This class hold the information about a single cluster of silicon channels.

Constructor & Destructor Documentation

Cluster() [1/2]

Herd::Cluster::Cluster

(

)

Default constructor.

Builds a cluster with no channels and undefined properties.

Cluster() [2/2]

Herd::Cluster::Cluster	(	std::vector< Hit >	hits,
		size_t	seedIndex
	)

Constructor.

Creates a cluster using the given hits.

Parameters

hits	Vector of hits constituting the cluster.

~Cluster()

virtual Herd::Cluster::~Cluster ( )

virtualdefault

Virtual destructor.

Member Function Documentation

_ComputeEdep()

void Herd::Cluster::_ComputeEdep ( )

private

Update the value of _edep.

COGPosition()

Point Herd::Cluster::COGPosition

(

const TrackingDetectorGeoParams &

geoParams

)

const

Get the center of gravity position of the cluster.

Parameters

The	geoparams associated to this cluster

Returns

The center of gravity

EDep()

float Herd::Cluster::EDep ( ) const

inline

Gets the deposited energy associated to the cluster.

The deposited energy is the sum of the deposited energies of the hits constituting the cluster.

Returns

The energy deposit in the cluster.

Hits()

const std::vector<Hit>& Herd::Cluster::Hits ( ) const

inline

Gets the hits forming the cluster.

Returns

The hits vector.

operator==()

bool Herd::Cluster::operator== ( const Cluster &  right ) const

inline

Get the center of gravity position of the fit cluster.

Parameters

The	geoparams associated to this cluster

Returns

The center of gravity

SeedHitIndex()

size_t Herd::Cluster::SeedHitIndex ( ) const

inline

Gets the index of the seed hit within the hits vector.

The seed hit is defined as the hit with the highest energy deposit The returned index is the index of the hit channel in the hits vector; e.g. to retrieve the seed hit:

cluster.Hits()[cluster.SeedHitIndex()];

Returns

the index of the seed hit.

SetHits()

void Herd::Cluster::SetHits	(	std::vector< Hit >	hits,
		size_t	seedIndex
	)

Sets the hits forming the cluster.

Parameters

hits	The hits vector.

Member Data Documentation

_eDep

float Herd::Cluster::_eDep

private

Deposited energy [GeV].

_hits

std::vector<Hit> Herd::Cluster::_hits

protected

Hits in each channel constituting the cluster.

_seedHitIndex

size_t Herd::Cluster::_seedHitIndex

private

Index of the seed channel in the hits vector.

---

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

• /builds/herd/HerdSoftware/include/analysis/dataobjects/Cluster.h
• /builds/herd/HerdSoftware/src/analysis/dataobjects/Cluster.cpp