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
	CaloEnergy (const Trk::EnergyLoss &eloss)
	full constructor
	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
	~CaloEnergy ()
	destructor
	CaloEnergy (const CaloEnergy &)
	copy constructor
CaloEnergy *	clone () const
	Virtual constructor.
CaloEnergy &	operator= (const CaloEnergy &)
	assignment operator
CaloEnergy::EnergyLossType	energyLossType (void) const
	Accessor methods.
unsigned short	caloMuonIdTag () const
	the Calo Muon Identification tag
double	caloLRLikelihood () const
	the calo Muon Identification likehood
const std::vector< DepositInCalo > &	depositInCalo () const
	the vector of detailed deposits in calo layers
float	fsrCandidateEnergy () const
	FSR Candidate Energy.
float	etCore () const
	isolation ET in core deltaR
void	set_energyLossType (const CaloEnergy::EnergyLossType lossType)
	set methods
void	set_caloLRLikelihood (const float likelihood)
	set the likelihood
void	set_caloMuonIdTag (unsigned short tag)
	set the tag
void	set_deposits (const std::vector< DepositInCalo > &deposits)
	set the detailed energy deposits in the calorimeter layers
void	set_deposits (std::vector< DepositInCalo > &&deposits)
void	insert_deposit (const DepositInCalo &deposit)
	insert a deposit
void	set_fsrCandidateEnergy (const float fs)
	FSR Candidate Energy.
void	set_etCore (const float etcore)
	isolation ET in core deltaR
void	set_measEnergyLoss (const double deltaE, const double sigmaDeltaE)
	set measured energy loss
double	deltaEMeas () const
	get measured energy loss
double	sigmaDeltaEMeas () const
	get measured energy loss error
void	set_paramEnergyLoss (const double deltaE, const double sigmaMinusDeltaE, const double sigmaPlusDeltaE)
	set parametrised energy loss
double	deltaEParam () const
	get parametrised energy loss
double	sigmaMinusDeltaEParam () const
	get parametrised energy loss minus error
double	sigmaPlusDeltaEParam () const
	get parametrised energy loss plus error
double	deltaE () const
	returns the \( \Delta E \)
double	sigmaDeltaE () const
	returns the symmatric error \( \sigma(\Delta E) \)
double	sigmaMinusDeltaE () const
	returns the negative side \( \sigma(\Delta E) \)
double	sigmaPlusDeltaE () const
	returns the positive side \( \sigma(\Delta E) \)
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.
virtual std::ostream &	dump (std::ostream &sl) const
	Interface method for output, can be overloaded by child classes.

Private Attributes
EnergyLossType	m_energyLossType
float	m_caloLRLikelihood
unsigned short	m_caloMuonIdTag
float	m_fsrCandidateEnergy
std::vector< DepositInCalo >	m_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
double	m_sigmaDeltaE = 0
	\( \sigma(\Delta E) \) - negative error on the energy loss
double	m_sigmaMinusDeltaE = 0
	\( \sigma(\Delta E) \) - positive error on the energy loss
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

enum CaloEnergy::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.

{ 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.

    :   EnergyLoss(0,0,0,0),
        m_caloLRLikelihood      (0),
        m_caloMuonIdTag         (0),
        m_fsrCandidateEnergy    (0),
        m_deposits              (),
        m_etCore                (0.0),
    m_deltaE_param           (0.0),
    m_sigmaMinusDeltaE_param (0.0),
    m_sigmaPlusDeltaE_param  (0.0),
    m_deltaE_meas            (0.0),
    m_sigmaDeltaE_meas       (0.0)
{ 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.

  :  EnergyLoss( eloss ),
     m_caloLRLikelihood      (0),
     m_caloMuonIdTag         (0),
     m_fsrCandidateEnergy    (0),
     m_deposits              (),
     m_etCore                (0.0),
     m_deltaE_param           (0.0),
     m_sigmaMinusDeltaE_param (0.0),
     m_sigmaPlusDeltaE_param  (0.0),
     m_deltaE_meas            (0.0),
     m_sigmaDeltaE_meas       (0.0)
{ 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.

    :   EnergyLoss(deltaE, sigmaDeltaE, sigmaMinusDeltaE, sigmaPlusDeltaE ),  
        m_caloLRLikelihood      (likelihood),
        m_caloMuonIdTag         (tag),
        m_deposits              (),
        m_etCore                (0.0),
    m_deltaE_param           (0.0),
    m_sigmaMinusDeltaE_param (0.0),
    m_sigmaPlusDeltaE_param  (0.0),
    m_deltaE_meas            (0.0),
    m_sigmaDeltaE_meas       (0.0)
{
    m_energyLossType = static_cast<CaloEnergy::EnergyLossType>(energyLossType);
        m_fsrCandidateEnergy = 0.0;
}

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.

    :   EnergyLoss(deltaE, sigmaDeltaE, sigmaMinusDeltaE, sigmaPlusDeltaE ),
        m_energyLossType (static_cast<CaloEnergy::EnergyLossType>(energyLossType)),
        m_caloLRLikelihood      (likelihood),
        m_caloMuonIdTag         (tag),
    m_fsrCandidateEnergy    (0.0),
        m_deposits              (deposits),
        m_etCore                (0.0), 
    m_deltaE_param           (0.0),
    m_sigmaMinusDeltaE_param (0.0),
    m_sigmaPlusDeltaE_param  (0.0),
    m_deltaE_meas            (0.0),
    m_sigmaDeltaE_meas       (0.0)
{
}

~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.

{ return  m_caloLRLikelihood; }

caloMuonIdTag()

unsigned short CaloEnergy::caloMuonIdTag ( ) const

inline

the Calo Muon Identification tag

Definition at line 85 of file CaloEnergy.h.

{ return m_caloMuonIdTag; }

clone()

CaloEnergy * CaloEnergy::clone ( ) const

inlinevirtual

Virtual constructor.

Reimplemented from Trk::EnergyLoss.

Definition at line 165 of file CaloEnergy.h.

{ 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.

{ return m_deltaE_meas; }

deltaEParam()

double CaloEnergy::deltaEParam ( ) const

inline

get parametrised energy loss

Definition at line 137 of file CaloEnergy.h.

{ 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.

{ 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.

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

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.

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

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.

{ return m_energyLossType; }

etCore()

float CaloEnergy::etCore ( ) const

inline

isolation ET in core deltaR

Definition at line 97 of file CaloEnergy.h.

{ return m_etCore; }

fsrCandidateEnergy()

float CaloEnergy::fsrCandidateEnergy ( ) const

inline

FSR Candidate Energy.

Definition at line 94 of file CaloEnergy.h.

{ return m_fsrCandidateEnergy; }

insert_deposit()

void CaloEnergy::insert_deposit ( const DepositInCalo & deposit )

inline

insert a deposit

Definition at line 115 of file CaloEnergy.h.

{ 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.

                                                       {
  if ( this != &rhs ) {
     EnergyLoss::operator=( rhs );
     m_energyLossType     = rhs.m_energyLossType;
     m_caloLRLikelihood   = rhs.m_caloLRLikelihood;
     m_caloMuonIdTag      = rhs.m_caloMuonIdTag;
     m_fsrCandidateEnergy = rhs.m_fsrCandidateEnergy;
     m_deposits           = rhs.m_deposits; 
     m_etCore             = rhs.m_etCore;
     m_deltaE_param           = rhs.m_deltaE_param;
     m_sigmaMinusDeltaE_param = rhs.m_sigmaMinusDeltaE_param;
     m_sigmaPlusDeltaE_param  = rhs.m_sigmaPlusDeltaE_param;
     m_deltaE_meas            = rhs.m_deltaE_meas;
     m_sigmaDeltaE_meas       = rhs.m_sigmaDeltaE_meas;
  }
  return *this;
}

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.

{ m_caloLRLikelihood = likelihood; }

set_caloMuonIdTag()

void CaloEnergy::set_caloMuonIdTag ( unsigned short tag )

inline

set the tag

Definition at line 108 of file CaloEnergy.h.

{ 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.

{ m_deposits = deposits; }

set_deposits() [2/2]

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

inline

Definition at line 112 of file CaloEnergy.h.

{ 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.

{ 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.

{ m_etCore=etcore; }

set_fsrCandidateEnergy()

void CaloEnergy::set_fsrCandidateEnergy ( const float fs )

inline

FSR Candidate Energy.

Definition at line 118 of file CaloEnergy.h.

{ m_fsrCandidateEnergy=fs; }

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.

{ m_deltaE_meas=deltaE; m_sigmaDeltaE_meas=sigmaDeltaE;}

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.

    { m_deltaE_param=deltaE; m_sigmaMinusDeltaE_param=sigmaMinusDeltaE; m_sigmaPlusDeltaE_param=sigmaPlusDeltaE;}

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.

{ 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.

{ 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.

{ 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.h
• CaloEnergy.cxx