Class to store calorimeter calibration hit. More...

#include <CaloCalibrationHit.h>

Collaboration diagram for CaloCalibrationHit:

Public Member Functions
	CaloCalibrationHit (Identifier id, double energyEM, double energyNonEM, double energyInvisible, double energyEscaped)
	Standard constructor using identifer and energy by type. More...

	CaloCalibrationHit (Identifier id, double energyEM, double energyNonEM, double energyInvisible, double energyEscaped, unsigned int particleID)
	Standard constructor using identifer, energy by type and primary particle ID. More...

	CaloCalibrationHit ()
	Default constructor; should never be used, but provided for some persistency services. More...

	CaloCalibrationHit (const CaloCalibrationHit &cchSource)
	Copy constructor. More...

CaloCalibrationHit &	operator= (const CaloCalibrationHit &cchSource)
	Assignment operator. More...

virtual	~CaloCalibrationHit ()
	Destructor. More...

Identifier	cellID () const

double	energyEM () const

double	energyNonEM () const

double	energyInvisible () const

double	energyEscaped () const

double	energyTotal () const

double	energy (unsigned int i) const

unsigned int	particleID () const

double	operator() (unsigned int i) const

bool	Less (const CaloCalibrationHit *h) const
	Calibration hits are ordered by values of their identifiers. More...

bool	Equals (const CaloCalibrationHit &h) const
	Calibration hits are ordered by values of their identifiers. More...

bool	Equals (const CaloCalibrationHit *h) const

void	Add (const CaloCalibrationHit *h)
	Method used for energy accumulation. More...

Private Attributes
Identifier	m_ID
	identifier of the cell in which this hit occured. More...

double	m_energy0
	energies (in MeV) deposited in this hit. More...

double	m_energy1

double	m_energy2

double	m_energy3

unsigned int	m_particleID
	identifier of Primary Particle which caused this hit More...

Detailed Description

Class to store calorimeter calibration hit.

A calibration hit stores for active, inactive and dead material elements the energy loss according to the process (EM energy loss, non EM energy loss, Invisible energy and Escaped energy)

Definition at line 16 of file CaloCalibrationHit.h.

Constructor & Destructor Documentation

◆ CaloCalibrationHit() [1/4]

CaloCalibrationHit::CaloCalibrationHit	(	Identifier	id,
		double	energyEM,
		double	energyNonEM,
		double	energyInvisible,
		double	energyEscaped
	)

inline

Standard constructor using identifer and energy by type.

Parameters

[in]	id	Cell identifier (calorimeter cell or dead material identifier)
[in]	energyEM	energy loss by EM processes
[in]	energyNonEM	visible energy loss by non EM processes (pion dEdx for instance)
[in]	energyInvisible	invisible energy loss (usually nuclear binding energy)
[in]	energyEscaped	energy which escaped from this cell because of production of neutrino (or escaping muon energy)

Definition at line 31 of file CaloCalibrationHit.h.

                                   :
     m_ID(id), 
     m_energy0(energyEM), 
     m_energy1(energyNonEM), 
     m_energy2(energyInvisible), 
     m_energy3(energyEscaped),
     m_particleID(0)
   {}

◆ CaloCalibrationHit() [2/4]

CaloCalibrationHit::CaloCalibrationHit	(	Identifier	id,
		double	energyEM,
		double	energyNonEM,
		double	energyInvisible,
		double	energyEscaped,
		unsigned int	particleID
	)

inline

Standard constructor using identifer, energy by type and primary particle ID.

Parameters

[in]	id	Cell identifier (calorimeter cell or dead material identifier)
[in]	energyEM	energy loss by EM processes
[in]	energyNonEM	visible energy loss by non EM processes (pion dEdx for instance)
[in]	energyInvisible	invisible energy loss (usually nuclear binding energy)
[in]	energyEscaped	energy which escaped from this cell because of production of neutrino (or escaping muon energy)
[in]	particleID	barcode of primary particle which caused given hit

Definition at line 52 of file CaloCalibrationHit.h.

                                                :
   m_ID(id), 
   m_energy0(energyEM), 
   m_energy1(energyNonEM), 
   m_energy2(energyInvisible), 
   m_energy3(energyEscaped),
   m_particleID(particleID)
                                                {}

◆ CaloCalibrationHit() [3/4]

CaloCalibrationHit::CaloCalibrationHit ( )

inline

Default constructor; should never be used, but provided for some persistency services.

Definition at line 67 of file CaloCalibrationHit.h.

                       :
     m_ID(Identifier()),
     m_energy0(0.),
     m_energy1(0.),
     m_energy2(0.),
     m_energy3(0.),
     m_particleID(0)
   {}

◆ CaloCalibrationHit() [4/4]

CaloCalibrationHit::CaloCalibrationHit ( const CaloCalibrationHit & cchSource )

inline

Copy constructor.

Definition at line 77 of file CaloCalibrationHit.h.

     : m_ID (cchSource.m_ID),
       m_energy0 (cchSource.m_energy0),
       m_energy1 (cchSource.m_energy1),
       m_energy2 (cchSource.m_energy2),
       m_energy3 (cchSource.m_energy3),
       m_particleID (cchSource.m_particleID)
   {
   }

◆ ~CaloCalibrationHit()

virtual CaloCalibrationHit::~CaloCalibrationHit ( )

inlinevirtual

Destructor.

Definition at line 101 of file CaloCalibrationHit.h.

101 {}

Member Function Documentation

◆ Add()

void CaloCalibrationHit::Add ( const CaloCalibrationHit * h )

inline

Method used for energy accumulation.

Definition at line 167 of file CaloCalibrationHit.h.

   {
     m_energy0 += h->m_energy0;
     m_energy1 += h->m_energy1;
     m_energy2 += h->m_energy2;
     m_energy3 += h->m_energy3;
   }

◆ cellID()

Identifier CaloCalibrationHit::cellID ( ) const

inline

Returns: cell identifier of this hit

Definition at line 104 of file CaloCalibrationHit.h.

104 { return m_ID; }

◆ energy()

double CaloCalibrationHit::energy ( unsigned int i ) const

inline

Returns: energy deposits by specifying input type. Units are MeV.

Definition at line 129 of file CaloCalibrationHit.h.

   {
     switch (i)
       {
       case 0: return  m_energy0;
       case 1: return  m_energy1;
       case 2: return  m_energy2;
       case 3: return  m_energy3;
       default: return 0.;
       }
   }

◆ energyEM()

double CaloCalibrationHit::energyEM ( ) const

inline

Returns: EM energy deposits. Units are MeV.

Definition at line 107 of file CaloCalibrationHit.h.

107 { return m_energy0; }

◆ energyEscaped()

double CaloCalibrationHit::energyEscaped ( ) const

inline

Returns: escaped energy. Units are MeV.

Definition at line 116 of file CaloCalibrationHit.h.

116 { return m_energy3; }

◆ energyInvisible()

double CaloCalibrationHit::energyInvisible ( ) const

inline

Returns: invisible energy. Units are MeV.

Definition at line 113 of file CaloCalibrationHit.h.

113 { return m_energy2; }

◆ energyNonEM()

double CaloCalibrationHit::energyNonEM ( ) const

inline

Returns: NonEM energy deposits. Units are MeV.

Definition at line 110 of file CaloCalibrationHit.h.

110 { return m_energy1; }

◆ energyTotal()

double CaloCalibrationHit::energyTotal ( ) const

inline

Returns: total energy deposits. Units are MeV.

Definition at line 119 of file CaloCalibrationHit.h.

   {
     return 
        m_energy0 + 
        m_energy1 + 
        m_energy2 + 
        m_energy3;
   }

◆ Equals() [1/2]

bool CaloCalibrationHit::Equals ( const CaloCalibrationHit & h ) const

inline

Calibration hits are ordered by values of their identifiers.

Calibration hits are ordered by values of their identifiers

Definition at line 159 of file CaloCalibrationHit.h.

                                                  { 
     return (m_ID == h.m_ID) && (m_particleID == h.m_particleID); 
   };

◆ Equals() [2/2]

bool CaloCalibrationHit::Equals ( const CaloCalibrationHit * h ) const

inline

Definition at line 162 of file CaloCalibrationHit.h.

                                                  {
     return Equals (*h);
   }

◆ Less()

bool CaloCalibrationHit::Less ( const CaloCalibrationHit * h ) const

inline

Calibration hits are ordered by values of their identifiers.

Definition at line 148 of file CaloCalibrationHit.h.

   {
     if(m_ID != h->m_ID){
       return m_ID < h->m_ID; 
     }else{
       return m_particleID < h->m_particleID; 
     }
   }

◆ operator()()

double CaloCalibrationHit::operator() ( unsigned int i ) const

inline

Returns: energy deposits by specifying input type, same as above method

Definition at line 145 of file CaloCalibrationHit.h.

145 { return energy(i); }

◆ operator=()

CaloCalibrationHit& CaloCalibrationHit::operator= ( const CaloCalibrationHit & cchSource )

inline

Assignment operator.

Definition at line 88 of file CaloCalibrationHit.h.

   {
     if (this == &cchSource) return *this;
     m_ID = cchSource.m_ID;
     m_energy0 = cchSource.m_energy0;
     m_energy1 = cchSource.m_energy1;
     m_energy2 = cchSource.m_energy2;
     m_energy3 = cchSource.m_energy3;
     m_particleID = cchSource.m_particleID;
     return *this;
   }

◆ particleID()

unsigned int CaloCalibrationHit::particleID ( ) const

inline

Returns: primary particle identifier which caused his hit

Definition at line 142 of file CaloCalibrationHit.h.

142 { return m_particleID; }

Member Data Documentation

◆ m_energy0

double CaloCalibrationHit::m_energy0

private

energies (in MeV) deposited in this hit.

In order, they represent: EM energy deposited non-EM energy deposited "invisible" energy deposited escaped energy Energies are accumulated in double precision and stored as floats

Definition at line 186 of file CaloCalibrationHit.h.

◆ m_energy1

double CaloCalibrationHit::m_energy1

private

Definition at line 187 of file CaloCalibrationHit.h.

◆ m_energy2

double CaloCalibrationHit::m_energy2

private

Definition at line 188 of file CaloCalibrationHit.h.

◆ m_energy3

double CaloCalibrationHit::m_energy3

private

Definition at line 189 of file CaloCalibrationHit.h.

◆ m_ID

Identifier CaloCalibrationHit::m_ID

private

identifier of the cell in which this hit occured.

Definition at line 178 of file CaloCalibrationHit.h.

◆ m_particleID

unsigned int CaloCalibrationHit::m_particleID

private

identifier of Primary Particle which caused this hit

Definition at line 192 of file CaloCalibrationHit.h.

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

CaloCalibrationHit.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CaloCalibrationHit() [1/4]

◆ CaloCalibrationHit() [2/4]

◆ CaloCalibrationHit() [3/4]

◆ CaloCalibrationHit() [4/4]

◆ ~CaloCalibrationHit()

Member Function Documentation

◆ Add()

◆ cellID()

◆ energy()

◆ energyEM()

◆ energyEscaped()

◆ energyInvisible()

◆ energyNonEM()

◆ energyTotal()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ Less()

◆ operator()()

◆ operator=()

◆ particleID()

Member Data Documentation

◆ m_energy0

◆ m_energy1

◆ m_energy2

◆ m_energy3

◆ m_ID

◆ m_particleID