Imperial Analysis
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ic::Candidate Class Reference

Stores a four-momentum, charge and identifier, and is the base class for most other physics objects. More...

#include "UserCode/ICHiggsTauTau/interface/Candidate.hh"

+ Inheritance diagram for ic::Candidate:

Public Member Functions

 Candidate ()
 
virtual ~Candidate ()
 
virtual void Print () const
 
 ClassDef (Candidate, 2)
 
Properties
Vector const & vector () const
 Four-momentum. More...
 
std::size_t id () const
 Unique identifier. More...
 
double pt () const
 Direct access to the \( p_{\text{T}} \). More...
 
double eta () const
 Direct access to \( \eta \). More...
 
double phi () const
 Direct access to \( \phi \). More...
 
double energy () const
 Direct access to the energy. More...
 
int charge () const
 Electric charge. More...
 
double M () const
 Calculates the candidate mass. More...
 
Setters
void set_vector (Vector const &vector)
 Four-momentum. More...
 
void set_id (std::size_t const &id)
 Unique identifier. More...
 
void set_pt (double const &pt)
 Direct access to the \( p_{\text{T}} \). More...
 
void set_eta (double const &eta)
 Direct access to \( \eta \). More...
 
void set_phi (double const &phi)
 Direct access to \( \phi \). More...
 
void set_energy (double const &energy)
 Direct access to the energy. More...
 
void set_charge (int const &charge)
 Electric charge. More...
 

Detailed Description

Stores a four-momentum, charge and identifier, and is the base class for most other physics objects.

Definition at line 13 of file Candidate.hh.

Constructor & Destructor Documentation

ic::Candidate::Candidate ( )

Definition at line 5 of file Candidate.cc.

ic::Candidate::~Candidate ( )
virtual

Definition at line 7 of file Candidate.cc.

Member Function Documentation

void ic::Candidate::Print ( ) const
virtual
Vector const& ic::Candidate::vector ( ) const
inline

Four-momentum.

Returns the underlying ROOT PtEtaPhiEVector, from which a large number of kinematic variables can be calculated. Please note, specific getter functions are provided by the Candidate class for the most commonly used variables: pt, eta, phi, energy and mass.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 31 of file Candidate.hh.

std::size_t ic::Candidate::id ( ) const
inline

Unique identifier.

Each Candidate object (and any object deriving from it) typically has a unique id assigned by its Producer. This provides a lightweight mechanism for objects to refer to each other. For example, A GenJet may store the id of each GenParticle constituents. As another example, a PFJet may store the id of its constituent tracks.

Definition at line 39 of file Candidate.hh.

double ic::Candidate::pt ( ) const
inline

Direct access to the \( p_{\text{T}} \).

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 42 of file Candidate.hh.

double ic::Candidate::eta ( ) const
inline

Direct access to \( \eta \).

Definition at line 45 of file Candidate.hh.

double ic::Candidate::phi ( ) const
inline

Direct access to \( \phi \).

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 48 of file Candidate.hh.

double ic::Candidate::energy ( ) const
inline

Direct access to the energy.

Definition at line 51 of file Candidate.hh.

int ic::Candidate::charge ( ) const
inline

Electric charge.

Definition at line 54 of file Candidate.hh.

double ic::Candidate::M ( ) const
inline

Calculates the candidate mass.

Definition at line 57 of file Candidate.hh.

void ic::Candidate::set_vector ( Vector const &  vector)
inline

Four-momentum.

Definition at line 63 of file Candidate.hh.

void ic::Candidate::set_pt ( double const &  pt)
inline
void ic::Candidate::set_eta ( double const &  eta)
inline
void ic::Candidate::set_phi ( double const &  phi)
inline
void ic::Candidate::set_energy ( double const &  energy)
inline
ic::Candidate::ClassDef ( Candidate  ,
 
)

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