ATLAS Offline Software
Loading...
Searching...
No Matches
AFPSiClusterBasicObj Class Reference

Class representing basic silicon pixels cluster, designed to be used for creating the clusters. More...

#include <AFPSiClusterBasicObj.h>

Collaboration diagram for AFPSiClusterBasicObj:

Public Member Functions

 AFPSiClusterBasicObj (const xAOD::AFPSiHit *hit, const int clusterAlgID)
 Constructs object from the hit. Horizontal and vertical errors are set to \(1/\sqrt{12} \approx 0.289\) i.e. standard deviation of uniform distribution.
 AFPSiClusterBasicObj (const float horizID, const float vertID, const float charge, const int clusterAlgID)
 Constructs object with given horizontal and vertical positions (ID numbers) and charge. VertID and horizID errors are set to \(1/\sqrt{12} \approx 0.289\) i.e. standard deviation of uniform distribution.
 AFPSiClusterBasicObj (const float horizID, const float horizIDErr, const float vertID, const float vertIDErr, const float charge, const int clusterAlgID)
float horizID () const
 horizontal position (ID number) of the cluster (float because it can be weighted mean of hits)
void setHorizID (const float horizID)
float horizIDErr () const
 uncertainty of horizontal position (ID number) in fraction
void setHorizIDErr (const float horizIDErr)
float vertID () const
 vertical position (ID number) of the cluster (float because it can be weighted mean of hits)
void setVertID (const float vertID)
float vertIDErr () const
 uncertainty of vertical position (ID number) in fraction
void setVertIDErr (const float vertIDErr)
double charge () const
 charge of the cluster
void setCharge (const double charge)
int clusterAlgID () const
 clustering algorithm ID number (use xAOD::AFPClusterAlgID for labels)
void setClusterAlgID (const int clusterAlgID)
std::list< const xAOD::AFPSiHit * > & hits ()
 list of pixels used to form the cluster
const std::list< const xAOD::AFPSiHit * > & hits () const
 list of pixels used to form the cluster

Protected Attributes

float m_horizID
 horizontal position (ID number) of the cluster (float because it can be weighted mean of hits)
float m_horizIDErr
 uncertainty of horizontal position (ID number) in fraction
float m_vertID
 vertical position (ID number) of the cluster (float because it can be weighted mean of hits)
float m_vertIDErr
 uncertainty of vertical position (ID number) in fraction
double m_charge
 charge of the cluster
int m_clusterAlgID
 clustering algorithm ID number (use xAOD::AFPClusterAlgID for labels)
std::list< const xAOD::AFPSiHit * > m_hits
 list of pixels used to form the cluster

Detailed Description

Class representing basic silicon pixels cluster, designed to be used for creating the clusters.

Simple class contains only charge, column and row information. The main purpose of this class is to provide object that can be modified in the clustering algorithm.

Definition at line 27 of file AFPSiClusterBasicObj.h.

Constructor & Destructor Documentation

◆ AFPSiClusterBasicObj() [1/3]

AFPSiClusterBasicObj::AFPSiClusterBasicObj ( const xAOD::AFPSiHit * hit,
const int clusterAlgID )
inline

Constructs object from the hit. Horizontal and vertical errors are set to \(1/\sqrt{12} \approx 0.289\) i.e. standard deviation of uniform distribution.

Definition at line 31 of file AFPSiClusterBasicObj.h.

31 :
float m_horizID
horizontal position (ID number) of the cluster (float because it can be weighted mean of hits)
std::list< const xAOD::AFPSiHit * > m_hits
list of pixels used to form the cluster
float m_vertIDErr
uncertainty of vertical position (ID number) in fraction
double m_charge
charge of the cluster
float m_vertID
vertical position (ID number) of the cluster (float because it can be weighted mean of hits)
int clusterAlgID() const
clustering algorithm ID number (use xAOD::AFPClusterAlgID for labels)
float m_horizIDErr
uncertainty of horizontal position (ID number) in fraction
int m_clusterAlgID
clustering algorithm ID number (use xAOD::AFPClusterAlgID for labels)
float depositedCharge() const
Charge deposited in the pixel.
int pixelHorizID() const
Index of the pixel along X axis in LHC coordinate system.
int pixelVertID() const
Index of the pixel along Y axis in LHC coordinate system.

◆ AFPSiClusterBasicObj() [2/3]

AFPSiClusterBasicObj::AFPSiClusterBasicObj ( const float horizID,
const float vertID,
const float charge,
const int clusterAlgID )
inline

Constructs object with given horizontal and vertical positions (ID numbers) and charge. VertID and horizID errors are set to \(1/\sqrt{12} \approx 0.289\) i.e. standard deviation of uniform distribution.

Definition at line 35 of file AFPSiClusterBasicObj.h.

35 :
float vertID() const
vertical position (ID number) of the cluster (float because it can be weighted mean of hits)
double charge() const
charge of the cluster
float horizID() const
horizontal position (ID number) of the cluster (float because it can be weighted mean of hits)

◆ AFPSiClusterBasicObj() [3/3]

AFPSiClusterBasicObj::AFPSiClusterBasicObj ( const float horizID,
const float horizIDErr,
const float vertID,
const float vertIDErr,
const float charge,
const int clusterAlgID )
inline

Definition at line 38 of file AFPSiClusterBasicObj.h.

38 :
float vertIDErr() const
uncertainty of vertical position (ID number) in fraction
float horizIDErr() const
uncertainty of horizontal position (ID number) in fraction

Member Function Documentation

◆ charge()

double AFPSiClusterBasicObj::charge ( ) const
inline

charge of the cluster

Definition at line 62 of file AFPSiClusterBasicObj.h.

62{return m_charge;}

◆ clusterAlgID()

int AFPSiClusterBasicObj::clusterAlgID ( ) const
inline

clustering algorithm ID number (use xAOD::AFPClusterAlgID for labels)

Definition at line 67 of file AFPSiClusterBasicObj.h.

67{return m_clusterAlgID;}

◆ hits() [1/2]

std::list< const xAOD::AFPSiHit * > & AFPSiClusterBasicObj::hits ( )
inline

list of pixels used to form the cluster

Definition at line 72 of file AFPSiClusterBasicObj.h.

72{return m_hits;}

◆ hits() [2/2]

const std::list< const xAOD::AFPSiHit * > & AFPSiClusterBasicObj::hits ( ) const
inline

list of pixels used to form the cluster

Definition at line 75 of file AFPSiClusterBasicObj.h.

75{return m_hits;}

◆ horizID()

float AFPSiClusterBasicObj::horizID ( ) const
inline

horizontal position (ID number) of the cluster (float because it can be weighted mean of hits)

Definition at line 42 of file AFPSiClusterBasicObj.h.

42{return m_horizID;}

◆ horizIDErr()

float AFPSiClusterBasicObj::horizIDErr ( ) const
inline

uncertainty of horizontal position (ID number) in fraction

Definition at line 47 of file AFPSiClusterBasicObj.h.

47{return m_horizIDErr;}

◆ setCharge()

void AFPSiClusterBasicObj::setCharge ( const double charge)
inline

Definition at line 64 of file AFPSiClusterBasicObj.h.

◆ setClusterAlgID()

void AFPSiClusterBasicObj::setClusterAlgID ( const int clusterAlgID)
inline

Definition at line 69 of file AFPSiClusterBasicObj.h.

◆ setHorizID()

void AFPSiClusterBasicObj::setHorizID ( const float horizID)
inline

Definition at line 44 of file AFPSiClusterBasicObj.h.

◆ setHorizIDErr()

void AFPSiClusterBasicObj::setHorizIDErr ( const float horizIDErr)
inline

Definition at line 49 of file AFPSiClusterBasicObj.h.

◆ setVertID()

void AFPSiClusterBasicObj::setVertID ( const float vertID)
inline

Definition at line 54 of file AFPSiClusterBasicObj.h.

◆ setVertIDErr()

void AFPSiClusterBasicObj::setVertIDErr ( const float vertIDErr)
inline

Definition at line 59 of file AFPSiClusterBasicObj.h.

◆ vertID()

float AFPSiClusterBasicObj::vertID ( ) const
inline

vertical position (ID number) of the cluster (float because it can be weighted mean of hits)

Definition at line 52 of file AFPSiClusterBasicObj.h.

52{return m_vertID;}

◆ vertIDErr()

float AFPSiClusterBasicObj::vertIDErr ( ) const
inline

uncertainty of vertical position (ID number) in fraction

Definition at line 57 of file AFPSiClusterBasicObj.h.

57{return m_vertIDErr;}

Member Data Documentation

◆ m_charge

double AFPSiClusterBasicObj::m_charge
protected

charge of the cluster

Definition at line 82 of file AFPSiClusterBasicObj.h.

◆ m_clusterAlgID

int AFPSiClusterBasicObj::m_clusterAlgID
protected

clustering algorithm ID number (use xAOD::AFPClusterAlgID for labels)

Definition at line 83 of file AFPSiClusterBasicObj.h.

◆ m_hits

std::list<const xAOD::AFPSiHit*> AFPSiClusterBasicObj::m_hits
protected

list of pixels used to form the cluster

Definition at line 86 of file AFPSiClusterBasicObj.h.

◆ m_horizID

float AFPSiClusterBasicObj::m_horizID
protected

horizontal position (ID number) of the cluster (float because it can be weighted mean of hits)

Definition at line 78 of file AFPSiClusterBasicObj.h.

◆ m_horizIDErr

float AFPSiClusterBasicObj::m_horizIDErr
protected

uncertainty of horizontal position (ID number) in fraction

Definition at line 79 of file AFPSiClusterBasicObj.h.

◆ m_vertID

float AFPSiClusterBasicObj::m_vertID
protected

vertical position (ID number) of the cluster (float because it can be weighted mean of hits)

Definition at line 80 of file AFPSiClusterBasicObj.h.

◆ m_vertIDErr

float AFPSiClusterBasicObj::m_vertIDErr
protected

uncertainty of vertical position (ID number) in fraction

Definition at line 81 of file AFPSiClusterBasicObj.h.


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