hpstr
The Heavy Photon Search Toolkit for Reconstruction (hpstr) provides an interface to physics data from the HPS experiment saved in the LCIO format and converts it into an ROOT based format.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Private Attributes | List of all members
Particle Class Reference

#include <Particle.h>

Inheritance diagram for Particle:

Public Member Functions

 Particle ()
 
 ~Particle ()
 
void Clear (Option_t *option="")
 
void setTrack (Track *track)
 
Track getTrack () const
 
void setCluster (CalCluster *cluster)
 
CalCluster getCluster () const
 
void addParticle (Particle *particle)
 
void setCharge (const int charge)
 
void setGoodnessOfPID (const double goodness_pid)
 
void setType (const int type)
 
void setPDG (const int pdg)
 
void setEnergy (const double energy)
 
void setMass (const double mass)
 
void setMomentum (const double *momentum)
 
void setCorrMomentum (const double *momentum)
 
int getCharge () const
 
double getGoodnessOfPID () const
 
int getType () const
 
int getPDG () const
 
double getEnergy () const
 
double getP () const
 
double getMass () const
 
std::vector< double > getMomentum () const
 
std::vector< double > getCorrMomentum () const
 
std::vector< double > getVertexPosition () const
 
 ClassDef (Particle, 1)
 

Private Attributes

Track track_
 
CalCluster cluster_
 
int charge_ {-9999}
 
int type_ {-9999}
 
int pdg_ {-9999}
 
double goodness_pid_ {-9999}
 
double px_ {-9999}
 
double px_corr_ {-9999}
 
double py_ {-9999}
 
double py_corr_ {-9999}
 
double pz_ {-9999}
 
double pz_corr_ {-9999}
 
double energy_ {-9999}
 
double mass_ {-9999}
 

Detailed Description

Definition at line 24 of file Particle.h.

Constructor & Destructor Documentation

◆ Particle()

Particle ( )

Default Constructor.

◆ ~Particle()

~Particle ( )

Destructor.

Definition at line 15 of file Particle.cxx.

Member Function Documentation

◆ addParticle()

void addParticle ( Particle particle)

Add a reference to an Particle object. This will be used to add daughter particles to this particle.

Parameters
particleDaughter particle composing this particle

◆ ClassDef()

ClassDef ( Particle  ,
 
)

◆ Clear()

void Clear ( Option_t *  option = "")

Reset this Particle object

Definition at line 19 of file Particle.cxx.

◆ getCharge()

int getCharge ( ) const
inline
Returns
The particle charge.

Definition at line 131 of file Particle.h.

◆ getCluster()

CalCluster getCluster ( ) const
inline
Returns
An array of references to the calorimeter clusters associated with this particle

Definition at line 62 of file Particle.h.

◆ getCorrMomentum()

std::vector< double > getCorrMomentum ( ) const
Returns
The corrected momentum of the paritcle in GeV.

Definition at line 37 of file Particle.cxx.

◆ getEnergy()

double getEnergy ( ) const
inline
Returns
The particle energy in GeV.

Definition at line 143 of file Particle.h.

◆ getGoodnessOfPID()

double getGoodnessOfPID ( ) const
inline
Returns
The goodness of the PID.

Definition at line 134 of file Particle.h.

◆ getMass()

double getMass ( ) const
inline
Returns
The invariant mass of the particle in GeV.

Definition at line 149 of file Particle.h.

◆ getMomentum()

std::vector< double > getMomentum ( ) const
Returns
The momentum of the particle.

Definition at line 29 of file Particle.cxx.

◆ getP()

double getP ( ) const
inline
Returns
The particle momentum in GeV.

Definition at line 146 of file Particle.h.

◆ getPDG()

int getPDG ( ) const
inline
Returns
The particle ID.

Definition at line 140 of file Particle.h.

◆ getTrack()

Track getTrack ( ) const
inline
Returns
A reference to the track associated with this particle

Definition at line 48 of file Particle.h.

◆ getType()

int getType ( ) const
inline
Returns
The type of this particle.

Definition at line 137 of file Particle.h.

◆ getVertexPosition()

std::vector< double > getVertexPosition ( ) const
Returns
The vertex position of the particle.

◆ setCharge()

void setCharge ( const int  charge)
inline

Set the charge of the particle.

Parameters
charge_Particle charge

Definition at line 77 of file Particle.h.

◆ setCluster()

void setCluster ( CalCluster cluster)
inline

Add a reference to an CalCluster object. This will be used to associated a particle with the calorimeter cluster that composes it.

Parameters
clusterCluster whose reference will be added

Definition at line 56 of file Particle.h.

◆ setCorrMomentum()

void setCorrMomentum ( const double *  momentum)

Set the corrected momentum of the paritcle in GeV.

Parameters
momentumAn array containing the three momentum components of the particle.

Definition at line 31 of file Particle.cxx.

◆ setEnergy()

void setEnergy ( const double  energy)
inline

Set the energy of the particle in GeV.

Parameters
energyThe energy of this particle

Definition at line 105 of file Particle.h.

◆ setGoodnessOfPID()

void setGoodnessOfPID ( const double  goodness_pid)
inline

Set the overall goodness of the PID for this particle.

Parameters
goodness_pid_The goodness of the PID.

Definition at line 84 of file Particle.h.

◆ setMass()

void setMass ( const double  mass)
inline

Set the invariant mass of the particle in GeV.

Parameters
massThe invariant mass of the particle

Definition at line 112 of file Particle.h.

◆ setMomentum()

void setMomentum ( const double *  momentum)

Set the momentum of the particle in GeV.

Parameters
momentumAn array containing the three momentum components of the particle.

Definition at line 23 of file Particle.cxx.

◆ setPDG()

void setPDG ( const int  pdg)
inline

Set the PDG ID of this particle.

Parameters
pdgThe PDG ID of this particle

Definition at line 98 of file Particle.h.

◆ setTrack()

void setTrack ( Track track)
inline

Set the Track object.

Parameters
trackTrack associated to particle

Definition at line 42 of file Particle.h.

◆ setType()

void setType ( const int  type)
inline

Set the type of this particle.

Parameters
typeThe type of this particle

Definition at line 91 of file Particle.h.

Member Data Documentation

◆ charge_

int charge_ {-9999}
private

The charge of this particle

Definition at line 171 of file Particle.h.

◆ cluster_

CalCluster cluster_
private

The array calorimeter cluster associated with this particle

Definition at line 168 of file Particle.h.

◆ energy_

double energy_ {-9999}
private

The energy of the particle in GeV

Definition at line 201 of file Particle.h.

◆ goodness_pid_

double goodness_pid_ {-9999}
private

The goodness of PID of this particle.

Definition at line 180 of file Particle.h.

◆ mass_

double mass_ {-9999}
private

The invariant mass of the particle in GeV

Definition at line 204 of file Particle.h.

◆ pdg_

int pdg_ {-9999}
private

The PDG ID of this particle

Definition at line 177 of file Particle.h.

◆ px_

double px_ {-9999}
private

The x component of the momentum of this particle in GeV

Definition at line 183 of file Particle.h.

◆ px_corr_

double px_corr_ {-9999}
private

The x component of the corrected momentum of this particle in GeV

Definition at line 186 of file Particle.h.

◆ py_

double py_ {-9999}
private

The y component of the momentum of this particle in GeV

Definition at line 189 of file Particle.h.

◆ py_corr_

double py_corr_ {-9999}
private

The y component of the corrected momentum of this particle in GeV

Definition at line 192 of file Particle.h.

◆ pz_

double pz_ {-9999}
private

The z component of the momentum of this particle in GeV

Definition at line 195 of file Particle.h.

◆ pz_corr_

double pz_corr_ {-9999}
private

The z component of the corrected momentum of this particle in GeV

Definition at line 198 of file Particle.h.

◆ track_

Track track_
private

The track associated with this particle

Definition at line 165 of file Particle.h.

◆ type_

int type_ {-9999}
private

The type of this particle

Definition at line 174 of file Particle.h.


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