ATLAS Offline Software
Public Types | Public Member Functions | Private Attributes | List of all members
CaloEnergy Class Reference

class extending the basic Trk::EnergyLoss to describe the measured or parameterised muon energy loss in the ATLAS calorimeters More...

#include <CaloEnergy.h>

Inheritance diagram for CaloEnergy:
Collaboration diagram for CaloEnergy:

Public Types

enum  EnergyLossType {
  Parametrized =0, NotIsolated =1, MOP =2, Tail =3,
  FSRcandidate =4
}
 Calo Energy Loss Type Parametrized : reconstruction configured to use the parametrization w/o looking in the calo (eg calo off) NotIsolated : the measurement in the calorimeter is not reliable due to additional energy around the muon --> the parametrized value isused. More...
 

Public Member Functions

 CaloEnergy (void)
 default constructor - to be used only for persistency More...
 
 CaloEnergy (const Trk::EnergyLoss &eloss)
 full constructor More...
 
 CaloEnergy (float deltaE, float sigmaDeltaE, float sigmaMinusDeltaE=0.0, float sigmaPlusDeltaE=0.0, unsigned short energyLossType=0, float likelihood=0, unsigned short tag=0)
 
 CaloEnergy (float deltaE, float sigmaDeltaE, float sigmaMinusDeltaE, float sigmaPlusDeltaE, unsigned short energyLossType, float likelihood, unsigned short tag, const std::vector< DepositInCalo > &deposits)
 full constructor with the detailed deposits in Calo More...
 
 ~CaloEnergy ()
 destructor More...
 
 CaloEnergy (const CaloEnergy &)
 copy constructor More...
 
CaloEnergyclone () const
 Virtual constructor. More...
 
CaloEnergyoperator= (const CaloEnergy &)
 assignment operator More...
 
CaloEnergy::EnergyLossType energyLossType (void) const
 Accessor methods. More...
 
unsigned short caloMuonIdTag () const
 the Calo Muon Identification tag More...
 
double caloLRLikelihood () const
 the calo Muon Identification likehood More...
 
const std::vector< DepositInCalo > & depositInCalo () const
 the vector of detailed deposits in calo layers More...
 
float fsrCandidateEnergy () const
 FSR Candidate Energy. More...
 
float etCore () const
 isolation ET in core deltaR More...
 
void set_energyLossType (const CaloEnergy::EnergyLossType lossType)
 set methods More...
 
void set_caloLRLikelihood (const float likelihood)
 set the likelihood More...
 
void set_caloMuonIdTag (unsigned short tag)
 set the tag More...
 
void set_deposits (const std::vector< DepositInCalo > &deposits)
 set the detailed energy deposits in the calorimeter layers More...
 
void set_deposits (std::vector< DepositInCalo > &&deposits)
 
void insert_deposit (const DepositInCalo &deposit)
 insert a deposit More...
 
void set_fsrCandidateEnergy (const float fs)
 FSR Candidate Energy. More...
 
void set_etCore (const float etcore)
 isolation ET in core deltaR More...
 
void set_measEnergyLoss (const double deltaE, const double sigmaDeltaE)
 set measured energy loss More...
 
double deltaEMeas () const
 get measured energy loss More...
 
double sigmaDeltaEMeas () const
 get measured energy loss error More...
 
void set_paramEnergyLoss (const double deltaE, const double sigmaMinusDeltaE, const double sigmaPlusDeltaE)
 set parametrised energy loss More...
 
double deltaEParam () const
 get parametrised energy loss More...
 
double sigmaMinusDeltaEParam () const
 get parametrised energy loss minus error More...
 
double sigmaPlusDeltaEParam () const
 get parametrised energy loss plus error More...
 
double deltaE () const
 returns the \( \Delta E \) More...
 
double sigmaDeltaE () const
 returns the symmatric error \( \sigma(\Delta E) \) More...
 
double sigmaMinusDeltaE () const
 returns the negative side \( \sigma(\Delta E) \) More...
 
double sigmaPlusDeltaE () const
 returns the positive side \( \sigma(\Delta E) \) More...
 
double meanIoni () const
 
double sigmaIoni () const
 
double meanRad () const
 
double sigmaRad () const
 
double length () const
 
void update (double ioni, double sigi, double rad, double sigr, bool mpv=false)
 
void update (const EnergyLoss &, bool mpv=false)
 
void set (double eLoss, double sigde, double ioni, double sigi, double rad, double sigr)
 
virtual MsgStream & dump (MsgStream &sl) const
 Interface method for output, can be overloaded by child classes. More...
 
virtual std::ostream & dump (std::ostream &sl) const
 Interface method for output, can be overloaded by child classes. More...
 

Private Attributes

EnergyLossType m_energyLossType
 
float m_caloLRLikelihood
 
unsigned short m_caloMuonIdTag
 
float m_fsrCandidateEnergy
 
std::vector< DepositInCalom_deposits
 
float m_etCore
 
double m_deltaE_param
 
double m_sigmaMinusDeltaE_param
 
double m_sigmaPlusDeltaE_param
 
double m_deltaE_meas
 
double m_sigmaDeltaE_meas
 
double m_deltaE = 0
 \( \Delta E \) - the estimated or measured energy loss More...
 
double m_sigmaDeltaE = 0
 \( \sigma(\Delta E) \) - negative error on the energy loss More...
 
double m_sigmaMinusDeltaE = 0
 \( \sigma(\Delta E) \) - positive error on the energy loss More...
 
double m_sigmaPlusDeltaE = 0
 
double m_mean_ioni = 0
 
double m_sig_ioni = 0
 
double m_mean_rad = 0
 
double m_sig_rad = 0
 
double m_length = 0
 

Detailed Description

class extending the basic Trk::EnergyLoss to describe the measured or parameterised muon energy loss in the ATLAS calorimeters

Author
K. Assamagan, G. Ordonez, A. Poppleton

Definition at line 28 of file CaloEnergy.h.

Member Enumeration Documentation

◆ EnergyLossType

Calo Energy Loss Type Parametrized : reconstruction configured to use the parametrization w/o looking in the calo (eg calo off) NotIsolated : the measurement in the calorimeter is not reliable due to additional energy around the muon --> the parametrized value isused.

MOP : measurement found to be compatible with most probable value --> mop used as more reliable at this region of the eloss Tail : measured eloss significantly higher than mop --> the calo measurement used FSRcandidate : in standalone reconstruction the Tail option was used. but an imbalance is observed when comparing Pstandalone and Pinnerdetector (Pstandalone>Pinnerdetector) --> if using the mop resolves the imbalance the excess energy loss is stored as fsrEnergy and the mop is used as the eloss.

Enumerator
Parametrized 
NotIsolated 
MOP 
Tail 
FSRcandidate 

Definition at line 43 of file CaloEnergy.h.

43 { Parametrized=0, NotIsolated=1, MOP=2, Tail=3, FSRcandidate=4 };

Constructor & Destructor Documentation

◆ CaloEnergy() [1/5]

CaloEnergy::CaloEnergy ( void  )

default constructor - to be used only for persistency

constructors

Definition at line 18 of file CaloEnergy.cxx.

19  : EnergyLoss(0,0,0,0),
21  m_caloMuonIdTag (0),
23  m_deposits (),
24  m_etCore (0.0),
25  m_deltaE_param (0.0),
28  m_deltaE_meas (0.0),
29  m_sigmaDeltaE_meas (0.0)
30 { m_energyLossType = static_cast<CaloEnergy::EnergyLossType>(0); }

◆ CaloEnergy() [2/5]

CaloEnergy::CaloEnergy ( const Trk::EnergyLoss eloss)

full constructor

Definition at line 32 of file CaloEnergy.cxx.

33  : EnergyLoss( eloss ),
35  m_caloMuonIdTag (0),
37  m_deposits (),
38  m_etCore (0.0),
39  m_deltaE_param (0.0),
42  m_deltaE_meas (0.0),
43  m_sigmaDeltaE_meas (0.0)
44 { m_energyLossType = static_cast<CaloEnergy::EnergyLossType>(0); }

◆ CaloEnergy() [3/5]

CaloEnergy::CaloEnergy ( float  deltaE,
float  sigmaDeltaE,
float  sigmaMinusDeltaE = 0.0,
float  sigmaPlusDeltaE = 0.0,
unsigned short  energyLossType = 0,
float  likelihood = 0,
unsigned short  tag = 0 
)

Definition at line 46 of file CaloEnergy.cxx.

◆ CaloEnergy() [4/5]

CaloEnergy::CaloEnergy ( float  deltaE,
float  sigmaDeltaE,
float  sigmaMinusDeltaE,
float  sigmaPlusDeltaE,
unsigned short  energyLossType,
float  likelihood,
unsigned short  tag,
const std::vector< DepositInCalo > &  deposits 
)

full constructor with the detailed deposits in Calo

Definition at line 69 of file CaloEnergy.cxx.

80  m_caloLRLikelihood (likelihood),
83  m_deposits (deposits),
84  m_etCore (0.0),
85  m_deltaE_param (0.0),
88  m_deltaE_meas (0.0),
89  m_sigmaDeltaE_meas (0.0)
90 {
91 }

◆ ~CaloEnergy()

CaloEnergy::~CaloEnergy ( )
default

destructor

◆ CaloEnergy() [5/5]

CaloEnergy::CaloEnergy ( const CaloEnergy )
default

copy constructor

Member Function Documentation

◆ caloLRLikelihood()

double CaloEnergy::caloLRLikelihood ( ) const
inline

the calo Muon Identification likehood

Definition at line 88 of file CaloEnergy.h.

88 { return m_caloLRLikelihood; }

◆ caloMuonIdTag()

unsigned short CaloEnergy::caloMuonIdTag ( ) const
inline

the Calo Muon Identification tag

Definition at line 85 of file CaloEnergy.h.

85 { return m_caloMuonIdTag; }

◆ clone()

CaloEnergy * CaloEnergy::clone ( ) const
inlinevirtual

Virtual constructor.

Reimplemented from Trk::EnergyLoss.

Definition at line 165 of file CaloEnergy.h.

166 { return new CaloEnergy(*this); }

◆ deltaE()

double Trk::EnergyLoss::deltaE ( ) const
inherited

returns the \( \Delta E \)

◆ deltaEMeas()

double CaloEnergy::deltaEMeas ( ) const
inline

get measured energy loss

Definition at line 127 of file CaloEnergy.h.

127 { return m_deltaE_meas; }

◆ deltaEParam()

double CaloEnergy::deltaEParam ( ) const
inline

get parametrised energy loss

Definition at line 137 of file CaloEnergy.h.

137 { return m_deltaE_param; }

◆ depositInCalo()

const std::vector<DepositInCalo>& CaloEnergy::depositInCalo ( ) const
inline

the vector of detailed deposits in calo layers

Definition at line 91 of file CaloEnergy.h.

91 { return m_deposits; }

◆ dump() [1/2]

MsgStream & Trk::EnergyLoss::dump ( MsgStream &  sl) const
virtualinherited

Interface method for output, can be overloaded by child classes.

Definition at line 30 of file EnergyLoss.cxx.

31 {
32  sl << "EnergyLoss : ( delta(E), sigma(dE) ) = \t"
33  << "(" << deltaE() << ", \t" << sigmaDeltaE() << ")";
34  return sl;
35 }

◆ dump() [2/2]

std::ostream & Trk::EnergyLoss::dump ( std::ostream &  sl) const
virtualinherited

Interface method for output, can be overloaded by child classes.

Definition at line 38 of file EnergyLoss.cxx.

39 {
40  sl << "EnergyLoss : ( delta(E), sigma(dE) ) = \t"
41  << "(" << deltaE() << ", \t" << sigmaDeltaE() << ")";
42  return sl;
43 }

◆ energyLossType()

CaloEnergy::EnergyLossType CaloEnergy::energyLossType ( void  ) const
inline

Accessor methods.

energy determined from parametrization or not (measured)

Definition at line 162 of file CaloEnergy.h.

163 { return m_energyLossType; }

◆ etCore()

float CaloEnergy::etCore ( ) const
inline

isolation ET in core deltaR

Definition at line 97 of file CaloEnergy.h.

97 { return m_etCore; }

◆ fsrCandidateEnergy()

float CaloEnergy::fsrCandidateEnergy ( ) const
inline

FSR Candidate Energy.

Definition at line 94 of file CaloEnergy.h.

94 { return m_fsrCandidateEnergy; }

◆ insert_deposit()

void CaloEnergy::insert_deposit ( const DepositInCalo deposit)
inline

insert a deposit

Definition at line 115 of file CaloEnergy.h.

115 { m_deposits.push_back( deposit ); }

◆ length()

double Trk::EnergyLoss::length ( ) const
inherited

◆ meanIoni()

double Trk::EnergyLoss::meanIoni ( ) const
inherited

◆ meanRad()

double Trk::EnergyLoss::meanRad ( ) const
inherited

◆ operator=()

CaloEnergy & CaloEnergy::operator= ( const CaloEnergy rhs)

assignment operator

Assignment operator.

Definition at line 103 of file CaloEnergy.cxx.

103  {
104  if ( this != &rhs ) {
105  EnergyLoss::operator=( rhs );
110  m_deposits = rhs.m_deposits;
111  m_etCore = rhs.m_etCore;
117  }
118  return *this;
119 }

◆ set()

void Trk::EnergyLoss::set ( double  eLoss,
double  sigde,
double  ioni,
double  sigi,
double  rad,
double  sigr 
)
inherited

◆ set_caloLRLikelihood()

void CaloEnergy::set_caloLRLikelihood ( const float  likelihood)
inline

set the likelihood

Definition at line 105 of file CaloEnergy.h.

105 { m_caloLRLikelihood = likelihood; }

◆ set_caloMuonIdTag()

void CaloEnergy::set_caloMuonIdTag ( unsigned short  tag)
inline

set the tag

Definition at line 108 of file CaloEnergy.h.

108 { m_caloMuonIdTag = tag; }

◆ set_deposits() [1/2]

void CaloEnergy::set_deposits ( const std::vector< DepositInCalo > &  deposits)
inline

set the detailed energy deposits in the calorimeter layers

Definition at line 111 of file CaloEnergy.h.

111 { m_deposits = deposits; }

◆ set_deposits() [2/2]

void CaloEnergy::set_deposits ( std::vector< DepositInCalo > &&  deposits)
inline

Definition at line 112 of file CaloEnergy.h.

112 { m_deposits = std::move(deposits); }

◆ set_energyLossType()

void CaloEnergy::set_energyLossType ( const CaloEnergy::EnergyLossType  lossType)
inline

set methods

set is_parametrized or measured energy loss

Definition at line 102 of file CaloEnergy.h.

102 { m_energyLossType = lossType; }

◆ set_etCore()

void CaloEnergy::set_etCore ( const float  etcore)
inline

isolation ET in core deltaR

Definition at line 121 of file CaloEnergy.h.

121 { m_etCore=etcore; }

◆ set_fsrCandidateEnergy()

void CaloEnergy::set_fsrCandidateEnergy ( const float  fs)
inline

FSR Candidate Energy.

Definition at line 118 of file CaloEnergy.h.

◆ set_measEnergyLoss()

void CaloEnergy::set_measEnergyLoss ( const double  deltaE,
const double  sigmaDeltaE 
)
inline

set measured energy loss

Definition at line 124 of file CaloEnergy.h.

◆ set_paramEnergyLoss()

void CaloEnergy::set_paramEnergyLoss ( const double  deltaE,
const double  sigmaMinusDeltaE,
const double  sigmaPlusDeltaE 
)
inline

set parametrised energy loss

Definition at line 133 of file CaloEnergy.h.

◆ sigmaDeltaE()

double Trk::EnergyLoss::sigmaDeltaE ( ) const
inherited

returns the symmatric error \( \sigma(\Delta E) \)

◆ sigmaDeltaEMeas()

double CaloEnergy::sigmaDeltaEMeas ( ) const
inline

get measured energy loss error

Definition at line 130 of file CaloEnergy.h.

130 { return m_sigmaDeltaE_meas; }

◆ sigmaIoni()

double Trk::EnergyLoss::sigmaIoni ( ) const
inherited

◆ sigmaMinusDeltaE()

double Trk::EnergyLoss::sigmaMinusDeltaE ( ) const
inherited

returns the negative side \( \sigma(\Delta E) \)

◆ sigmaMinusDeltaEParam()

double CaloEnergy::sigmaMinusDeltaEParam ( ) const
inline

get parametrised energy loss minus error

Definition at line 140 of file CaloEnergy.h.

140 { return m_sigmaMinusDeltaE_param; }

◆ sigmaPlusDeltaE()

double Trk::EnergyLoss::sigmaPlusDeltaE ( ) const
inherited

returns the positive side \( \sigma(\Delta E) \)

◆ sigmaPlusDeltaEParam()

double CaloEnergy::sigmaPlusDeltaEParam ( ) const
inline

get parametrised energy loss plus error

Definition at line 143 of file CaloEnergy.h.

143 { return m_sigmaPlusDeltaE_param; }

◆ sigmaRad()

double Trk::EnergyLoss::sigmaRad ( ) const
inherited

◆ update() [1/2]

void Trk::EnergyLoss::update ( const EnergyLoss ,
bool  mpv = false 
)
inherited

◆ update() [2/2]

void Trk::EnergyLoss::update ( double  ioni,
double  sigi,
double  rad,
double  sigr,
bool  mpv = false 
)
inherited

Member Data Documentation

◆ m_caloLRLikelihood

float CaloEnergy::m_caloLRLikelihood
private

Definition at line 148 of file CaloEnergy.h.

◆ m_caloMuonIdTag

unsigned short CaloEnergy::m_caloMuonIdTag
private

Definition at line 149 of file CaloEnergy.h.

◆ m_deltaE

double Trk::EnergyLoss::m_deltaE = 0
privateinherited

\( \Delta E \) - the estimated or measured energy loss

\( \sigma(\Delta E) \) - error on the energy loss

Definition at line 117 of file EnergyLoss.h.

◆ m_deltaE_meas

double CaloEnergy::m_deltaE_meas
private

Definition at line 157 of file CaloEnergy.h.

◆ m_deltaE_param

double CaloEnergy::m_deltaE_param
private

Definition at line 154 of file CaloEnergy.h.

◆ m_deposits

std::vector<DepositInCalo> CaloEnergy::m_deposits
private

Definition at line 151 of file CaloEnergy.h.

◆ m_energyLossType

EnergyLossType CaloEnergy::m_energyLossType
private

Definition at line 147 of file CaloEnergy.h.

◆ m_etCore

float CaloEnergy::m_etCore
private

Definition at line 152 of file CaloEnergy.h.

◆ m_fsrCandidateEnergy

float CaloEnergy::m_fsrCandidateEnergy
private

Definition at line 150 of file CaloEnergy.h.

◆ m_length

double Trk::EnergyLoss::m_length = 0
privateinherited

Definition at line 129 of file EnergyLoss.h.

◆ m_mean_ioni

double Trk::EnergyLoss::m_mean_ioni = 0
privateinherited

Definition at line 125 of file EnergyLoss.h.

◆ m_mean_rad

double Trk::EnergyLoss::m_mean_rad = 0
privateinherited

Definition at line 127 of file EnergyLoss.h.

◆ m_sig_ioni

double Trk::EnergyLoss::m_sig_ioni = 0
privateinherited

Definition at line 126 of file EnergyLoss.h.

◆ m_sig_rad

double Trk::EnergyLoss::m_sig_rad = 0
privateinherited

Definition at line 128 of file EnergyLoss.h.

◆ m_sigmaDeltaE

double Trk::EnergyLoss::m_sigmaDeltaE = 0
privateinherited

\( \sigma(\Delta E) \) - negative error on the energy loss

Definition at line 119 of file EnergyLoss.h.

◆ m_sigmaDeltaE_meas

double CaloEnergy::m_sigmaDeltaE_meas
private

Definition at line 158 of file CaloEnergy.h.

◆ m_sigmaMinusDeltaE

double Trk::EnergyLoss::m_sigmaMinusDeltaE = 0
privateinherited

\( \sigma(\Delta E) \) - positive error on the energy loss

Definition at line 121 of file EnergyLoss.h.

◆ m_sigmaMinusDeltaE_param

double CaloEnergy::m_sigmaMinusDeltaE_param
private

Definition at line 155 of file CaloEnergy.h.

◆ m_sigmaPlusDeltaE

double Trk::EnergyLoss::m_sigmaPlusDeltaE = 0
privateinherited

Definition at line 123 of file EnergyLoss.h.

◆ m_sigmaPlusDeltaE_param

double CaloEnergy::m_sigmaPlusDeltaE_param
private

Definition at line 156 of file CaloEnergy.h.


The documentation for this class was generated from the following files:
CaloEnergy::Tail
@ Tail
Definition: CaloEnergy.h:43
CaloEnergy::m_energyLossType
EnergyLossType m_energyLossType
Definition: CaloEnergy.h:147
Trk::EnergyLoss::sigmaMinusDeltaE
double sigmaMinusDeltaE() const
returns the negative side
CaloEnergy::CaloEnergy
CaloEnergy(void)
default constructor - to be used only for persistency
Definition: CaloEnergy.cxx:18
CaloEnergy::m_sigmaDeltaE_meas
double m_sigmaDeltaE_meas
Definition: CaloEnergy.h:158
CaloEnergy::EnergyLossType
EnergyLossType
Calo Energy Loss Type Parametrized : reconstruction configured to use the parametrization w/o looking...
Definition: CaloEnergy.h:43
CaloEnergy::m_sigmaPlusDeltaE_param
double m_sigmaPlusDeltaE_param
Definition: CaloEnergy.h:156
CaloEnergy::m_deltaE_meas
double m_deltaE_meas
Definition: CaloEnergy.h:157
CaloEnergy::m_caloLRLikelihood
float m_caloLRLikelihood
Definition: CaloEnergy.h:148
Trk::EnergyLoss::sigmaDeltaE
double sigmaDeltaE() const
returns the symmatric error
Trk::EnergyLoss::EnergyLoss
EnergyLoss()=default
default constructor for POOL
CaloEnergy::m_etCore
float m_etCore
Definition: CaloEnergy.h:152
CaloEnergy::m_deltaE_param
double m_deltaE_param
Definition: CaloEnergy.h:154
CaloEnergy::energyLossType
CaloEnergy::EnergyLossType energyLossType(void) const
Accessor methods.
Definition: CaloEnergy.h:162
Trk::EnergyLoss::deltaE
double deltaE() const
returns the
CaloEnergy::m_deposits
std::vector< DepositInCalo > m_deposits
Definition: CaloEnergy.h:151
CaloEnergy::FSRcandidate
@ FSRcandidate
Definition: CaloEnergy.h:43
CaloEnergy::m_caloMuonIdTag
unsigned short m_caloMuonIdTag
Definition: CaloEnergy.h:149
CaloEnergy::m_fsrCandidateEnergy
float m_fsrCandidateEnergy
Definition: CaloEnergy.h:150
CaloEnergy::Parametrized
@ Parametrized
Definition: CaloEnergy.h:43
CaloEnergy::NotIsolated
@ NotIsolated
Definition: CaloEnergy.h:43
Herwig7_QED_EvtGen_ll.fs
dictionary fs
Definition: Herwig7_QED_EvtGen_ll.py:17
CaloEnergy::m_sigmaMinusDeltaE_param
double m_sigmaMinusDeltaE_param
Definition: CaloEnergy.h:155
CaloCondBlobAlgs_fillNoiseFromASCII.tag
string tag
Definition: CaloCondBlobAlgs_fillNoiseFromASCII.py:24
CaloEnergy::MOP
@ MOP
Definition: CaloEnergy.h:43
Trk::EnergyLoss::sigmaPlusDeltaE
double sigmaPlusDeltaE() const
returns the positive side