xAOD::AFPSiHitsCluster_v1 Class Reference

Class representing a cluster of AFP pixel hits. More...

#include <AFPSiHitsCluster_v1.h>

Inheritance diagram for xAOD::AFPSiHitsCluster_v1:

Collaboration diagram for xAOD::AFPSiHitsCluster_v1:

Public Types
typedef ElementLink< AFPSiHitContainer >	AFPHitLink_t
	Type of a link to the hit.

Public Member Functions
int	stationID () const
	Index of the station with pixels cluster.
void	setStationID (int stationID)
	Set index of the station with pixel hit.
int	pixelLayerID () const
	Index of the silicon layer with the cluster.
void	setPixelLayerID (int layerID)
	Method setting index of the detector layer with the cluster.
float	xLocal () const
	Cluster position along X axis in station local coordinate system.
void	setXLocal (float newXLocal)
	Set cluster position along X axis in station local coordinate system.
float	xLocalErr () const
	Uncertainty of cluster position along X axis in station local coordinate system.
void	setXLocalErr (float newXLocalErr)
	Set uncertainty of cluster position along X axis in station local coordinate system.
float	yLocal () const
	Cluster position along Y axis in station local coordinate system.
void	setYLocal (float newYLocal)
	Set cluster position along Y axis in station local coordinate system.
float	yLocalErr () const
	Uncertainty of cluster position along Y axis in station local coordinate system.
void	setYLocalErr (float newYLocalErr)
	Set uncertainty of cluster position along Y axis in station local coordinate system.
float	zLocal () const
	Cluster position along Z axis in station local coordinate system.
void	setZLocal (float newZLocal)
	Set cluster position along Z axis in station local coordinate system.
float	zLocalErr () const
	Uncertainty of cluster position along Z axis in station local coordinate system.
void	setZLocalErr (float newZLocalErr)
	Set uncertainty of cluster position along Z axis in station local coordinate system.
float	depositedCharge () const
	Total charge of the cluster.
void	setDepositedCharge (float charge)
	Method setting total charge of the cluster.
int	nHits () const
	Number of fired pixels (hits) in cluster.
void	setNHits (int nPixels)
	Set number of fired pixels (hits) in the cluster.
const std::vector< AFPHitLink_t > &	hitsLinks () const
	Vector of links to pixels that were used to construct the cluster.
void	setHitsLinks (const std::vector< AFPHitLink_t > &newHitsVector)
	Set vector of links to pixels used to construct the cluster.
void	addHitLink (const AFPHitLink_t &newHit)
	Add a link to a pixel in this cluster.
int	clusterAlgID () const
	Identification number of the algorithm used to cluster pixels.
void	setClusterAlgID (int newIAlgID)
	Set ID number of the clustering algorithm.
void	toPersistent ()
	Function making sure that the object is ready for persistification i.e. saving.

Detailed Description

Class representing a cluster of AFP pixel hits.

Definition at line 31 of file AFPSiHitsCluster_v1.h.

Member Typedef Documentation

AFPHitLink_t

typedef ElementLink< AFPSiHitContainer > xAOD::AFPSiHitsCluster_v1::AFPHitLink_t

Type of a link to the hit.

Definition at line 35 of file AFPSiHitsCluster_v1.h.

Member Function Documentation

addHitLink()

void xAOD::AFPSiHitsCluster_v1::addHitLink

(

const AFPHitLink_t &

newHit

)

Add a link to a pixel in this cluster.

A new link to the hit is added to the existing vector of links to the pixels in this cluster.

Parameters

newHit

link to the pixel used to construct this cluster.

Definition at line 40 of file AFPSiHitsCluster_v1.cxx.

  {
    hitsLinksAcc( *this ).push_back( link );
  }

clusterAlgID()

int xAOD::AFPSiHitsCluster_v1::clusterAlgID

(

)

const

Identification number of the algorithm used to cluster pixels.

The following coding is used.

ID	Algorithm	Comments
0	no clustering - one hit per clusetr

depositedCharge()

float xAOD::AFPSiHitsCluster_v1::depositedCharge

(

)

const

Total charge of the cluster.

The method of calculation depends on used algorithm.

hitsLinks()

const std::vector< AFPHitLink_t > & xAOD::AFPSiHitsCluster_v1::hitsLinks

(

)

const

Vector of links to pixels that were used to construct the cluster.

This method provides access to the hits (pixels) that were used to reconstruct the cluster via ElementLink object.

Note

• It can be checked if the link is active using method ElementLink::isValid()
• A pointer to the xAOD::AFPSiHit object can be retrieved using asterisk operator e.g.

  xAOD::AFPSiHit* hit = *(hits().at(0));

Returns

nHits()

int xAOD::AFPSiHitsCluster_v1::nHits

(

)

const

Number of fired pixels (hits) in cluster.

pixelLayerID()

int xAOD::AFPSiHitsCluster_v1::pixelLayerID

(

)

const

Index of the silicon layer with the cluster.

It is advised to use class xAOD::AFPPixelLayerID instead of integers to process this information. In this class the numbering scheme is explained.

setClusterAlgID()

void xAOD::AFPSiHitsCluster_v1::setClusterAlgID

(

int

newIAlgID

)

Set ID number of the clustering algorithm.

Parameters

newIAlgID

identification number of the algorithm used to cluster hits

setDepositedCharge()

void xAOD::AFPSiHitsCluster_v1::setDepositedCharge

(

float

charge

)

Method setting total charge of the cluster.

Parameters

charge

value of the cluster charge

setHitsLinks()

void xAOD::AFPSiHitsCluster_v1::setHitsLinks

(

const std::vector< AFPHitLink_t > &

newHitsVector

)

Set vector of links to pixels used to construct the cluster.

Parameters

newHitsVector

vector of links to pixels used to construct the cluster.

setNHits()

void xAOD::AFPSiHitsCluster_v1::setNHits

(

int

nPixels

)

Set number of fired pixels (hits) in the cluster.

setPixelLayerID()

void xAOD::AFPSiHitsCluster_v1::setPixelLayerID

(

int

layerID

)

Method setting index of the detector layer with the cluster.

It is advised to use class xAOD::AFPPixelLayerID instead of integers to process this information. In this class the numbering scheme is explained.

Parameters

layerID

index of the pixel layer with the cluster

setStationID()

void xAOD::AFPSiHitsCluster_v1::setStationID

(

int

stationID

)

Set index of the station with pixel hit.

It is advised to use class xAOD::AFPStationID instead of integers to process this information. In this class the numbering scheme is explained.

Returns

index of the station (see class xAOD::AFPStationID )

Parameters

stationID

index of the station with the hit

setXLocal()

void xAOD::AFPSiHitsCluster_v1::setXLocal

(

float

newXLocal

)

Set cluster position along X axis in station local coordinate system.

setXLocalErr()

void xAOD::AFPSiHitsCluster_v1::setXLocalErr

(

float

newXLocalErr

)

Set uncertainty of cluster position along X axis in station local coordinate system.

setYLocal()

void xAOD::AFPSiHitsCluster_v1::setYLocal

(

float

newYLocal

)

Set cluster position along Y axis in station local coordinate system.

setYLocalErr()

void xAOD::AFPSiHitsCluster_v1::setYLocalErr

(

float

newYLocalErr

)

Set uncertainty of cluster position along Y axis in station local coordinate system.

setZLocal()

void xAOD::AFPSiHitsCluster_v1::setZLocal

(

float

newZLocal

)

Set cluster position along Z axis in station local coordinate system.

setZLocalErr()

void xAOD::AFPSiHitsCluster_v1::setZLocalErr

(

float

newZLocalErr

)

Set uncertainty of cluster position along Z axis in station local coordinate system.

stationID()

int xAOD::AFPSiHitsCluster_v1::stationID

(

)

const

Index of the station with pixels cluster.

It is advised to use class xAOD::AFPStationID instead of integers to process this information. In this class the numbering scheme is explained.

Returns

index of the station (see class xAOD::AFPStationID )

toPersistent()

void xAOD::AFPSiHitsCluster_v1::toPersistent

(

)

Function making sure that the object is ready for persistification i.e. saving.

Definition at line 45 of file AFPSiHitsCluster_v1.cxx.

                                         {
    // Prepare the hits links for persistification:
    if ( hitsLinksAcc.isAvailableWritable( *this ) )
      for (AFPHitLink_t hitLink : hitsLinksAcc( *this ) )
    hitLink.toPersistent();
  }

xLocal()

float xAOD::AFPSiHitsCluster_v1::xLocal

(

)

const

Cluster position along X axis in station local coordinate system.

xLocalErr()

float xAOD::AFPSiHitsCluster_v1::xLocalErr

(

)

const

Uncertainty of cluster position along X axis in station local coordinate system.

yLocal()

float xAOD::AFPSiHitsCluster_v1::yLocal

(

)

const

Cluster position along Y axis in station local coordinate system.

yLocalErr()

float xAOD::AFPSiHitsCluster_v1::yLocalErr

(

)

const

Uncertainty of cluster position along Y axis in station local coordinate system.

zLocal()

float xAOD::AFPSiHitsCluster_v1::zLocal

(

)

const

Cluster position along Z axis in station local coordinate system.

zLocalErr()

float xAOD::AFPSiHitsCluster_v1::zLocalErr

(

)

const

Uncertainty of cluster position along Z axis in station local coordinate system.

---

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

• AFPSiHitsCluster_v1.h
• AFPSiHitsCluster_v1.cxx