CMS 3D CMS Logo

pftools::Deposition Class Reference

This class holds an arbitrary energy deposition, specified in terms of angular position, energy, depth (optional) and detector element type. More...

#include <RecoParticleFlow/PFClusterTools/interface/Deposition.h>

List of all members.

Public Member Functions

 Deposition (DetectorElementPtr element, double eta=0.0, double phi=0.0, double energy=0.0, double depth=0.0)
double getDepth () const
DetectorElementPtr getDetectorElement () const
double getEnergy () const
double getEta () const
double getPhi () const
void setEnergy (double energy)
virtual ~Deposition ()

Private Attributes

double myDepth
DetectorElementPtr myElementPtr
double myEnergy
double myEta
double myPhi

Friends

std::ostream & operator<< (std::ostream &s, const Deposition &d)


Detailed Description

This class holds an arbitrary energy deposition, specified in terms of angular position, energy, depth (optional) and detector element type.

Author:
Jamie Balin
Date:
April 2008

Definition at line 20 of file Deposition.h.


Constructor & Destructor Documentation

Deposition::Deposition ( DetectorElementPtr  element,
double  eta = 0.0,
double  phi = 0.0,
double  energy = 0.0,
double  depth = 0.0 
)

Definition at line 3 of file Deposition.cc.

00004                                              :
00005         myElementPtr(element), myEta(eta), myPhi(phi), myEnergy(energy),
00006                         myDepth(depth) {
00007 }

Deposition::~Deposition (  )  [virtual]

Definition at line 9 of file Deposition.cc.

00009                         {
00010 }


Member Function Documentation

double pftools::Deposition::getDepth (  )  const [inline]

Definition at line 52 of file Deposition.h.

References myDepth.

00052                                        {
00053                 return myDepth;
00054         }

DetectorElementPtr pftools::Deposition::getDetectorElement (  )  const [inline]

Definition at line 43 of file Deposition.h.

References myElementPtr.

Referenced by pftools::ParticleDeposit::getRecEnergy(), pftools::ParticleDeposit::getTruthEnergy(), pftools::operator<<(), and pftools::ParticleDeposit::setRecEnergy().

00043                                                              {
00044                 return myElementPtr;
00045         }

double pftools::Deposition::getEnergy (  )  const [inline]

Definition at line 38 of file Deposition.h.

References myEnergy.

Referenced by pftools::ParticleDeposit::getRecEnergy(), pftools::ParticleDeposit::getTruthEnergy(), and pftools::operator<<().

00038                                         {
00039                 return myEnergy;
00040         }

double pftools::Deposition::getEta (  )  const [inline]

Definition at line 28 of file Deposition.h.

References myEta.

Referenced by pftools::ParticleDeposit::getRecEnergy(), and pftools::operator<<().

00028                                      {
00029                 return myEta;
00030         }

double pftools::Deposition::getPhi (  )  const [inline]

Definition at line 33 of file Deposition.h.

References myPhi.

Referenced by pftools::ParticleDeposit::getRecEnergy(), and pftools::operator<<().

00033                                      {
00034                 return myPhi;
00035         }

void pftools::Deposition::setEnergy ( double  energy  )  [inline]

Definition at line 23 of file Deposition.h.

References myEnergy.

Referenced by pftools::ParticleDeposit::setRecEnergy().

00023                                              {
00024                 myEnergy = energy;
00025         }


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  s,
const Deposition d 
) [friend]

Definition at line 12 of file Deposition.cc.

00012                                                                   {
00013         s << "Deposit's type: "<< *(d.getDetectorElement()) << "\tE:\t"<< d.getEnergy()
00014                         << ", \teta:\t"<< d.getEta() << ", \tmyPhi:\t"<< d.getPhi() << "\n";
00015         return s;
00016 }


Member Data Documentation

double pftools::Deposition::myDepth [private]

Definition at line 74 of file Deposition.h.

Referenced by getDepth().

DetectorElementPtr pftools::Deposition::myElementPtr [private]

Definition at line 69 of file Deposition.h.

Referenced by getDetectorElement().

double pftools::Deposition::myEnergy [private]

Definition at line 73 of file Deposition.h.

Referenced by getEnergy(), and setEnergy().

double pftools::Deposition::myEta [private]

Definition at line 71 of file Deposition.h.

Referenced by getEta().

double pftools::Deposition::myPhi [private]

Definition at line 72 of file Deposition.h.

Referenced by getPhi().


The documentation for this class was generated from the following files:
Generated on Tue Jun 9 18:50:05 2009 for CMSSW by  doxygen 1.5.4