Evaluate cluster kinematics with a different vertex / signal state. More...

#include <CaloVertexedClusterBase.h>

Inheritance diagram for xAOD::CaloVertexedClusterBase:

Collaboration diagram for xAOD::CaloVertexedClusterBase:

Public Types
Functions describing the 4-momentum of the object
typedef TLorentzVector	FourMom_t
	Definition of the 4-momentum type.

Public Member Functions
	CaloVertexedClusterBase (const CaloCluster &cl)
	Constructor.
	CaloVertexedClusterBase (const CaloCluster &cl, CaloCluster::State s)
	Constructor.
const CaloCluster &	clust () const
	Return the cluster being proxied,.
virtual Type::ObjectType	type () const final
	The type of the object as a simple enumeration.
Functions describing the 4-momentum of the object
virtual double	pt () const final
	The transverse momentum ( \(p_T\)) of the particle.
virtual double	eta () const final
	The pseudorapidity ( \(\eta\)) of the particle.
virtual double	phi () const final
	The azimuthal angle ( \(\phi\)) of the particle.
virtual double	m () const final
	The invariant mass of the particle.
virtual double	e () const final
	The total energy of the particle.
virtual double	rapidity () const final
	The true rapidity (y) of the particle.
virtual FourMom_t	p4 () const final
	The full 4-momentum of the particle.
Functions for getting and setting user properties
template<class T>
XAOD_AUXDATA_DEPRECATED T &	auxdata (const std::string &name, const std::string &clsname="")
	Fetch an aux data variable, as a non-const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED const T &	auxdata (const std::string &name, const std::string &clsname="") const
	Fetch an aux data variable, as a const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for reading or not.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for writing or not.

Protected Member Functions
void	computeVertexCorr (const Amg::Vector3D &vx, double radius)
	Calculate cluster kinematics for a given vertex.

Protected Attributes
const CaloCluster *	m_cl
	The cluster being proxied.
double	m_eta
	The recalculated cluster eta.
double	m_phi
	The recalculated cluster phi.
FourMom_t	m_p4
	The recalculated cluster 4-momentum.

Detailed Description

Evaluate cluster kinematics with a different vertex / signal state.

A base for classes acting as a proxy for a cluster object. Concrete classes are

CaloVertexedCluster : vertex correction uses the EM layer information. Available only in athena, since geometry is required.
CaloVertexedTopoCluster : vertex correction uses the "" It provides the same IParticle interface, except that the cluster kinematics are recalculated for a different vertex, and optionally a different signal state.

Definition at line 39 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

Member Typedef Documentation

◆ FourMom_t

typedef TLorentzVector xAOD::IParticle::FourMom_t

inherited

Definition of the 4-momentum type.

Definition at line 69 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

Constructor & Destructor Documentation

◆ CaloVertexedClusterBase() [1/2]

xAOD::CaloVertexedClusterBase::CaloVertexedClusterBase ( const CaloCluster & cl )

Constructor.

Parameters

cl	The cluster to proxy.

In this case, we'll return unchanged the kinematics of the cluster for the default signal state.

Definition at line 33 of file CaloVertexedClusterBase.cxx.

  : m_cl (&cl),
    m_eta (cl.eta()),
    m_phi (cl.phi()),
    m_p4 (cl.p4())
{
}

◆ CaloVertexedClusterBase() [2/2]

xAOD::CaloVertexedClusterBase::CaloVertexedClusterBase	(	const CaloCluster &	cl,
		CaloCluster::State	s )

Constructor.

Parameters

cl	The cluster to proxy.
s	The desired signal state.

In this case, we'll return unchanged the kinematics of the cluster for signal state S.

Definition at line 50 of file CaloVertexedClusterBase.cxx.

  : m_cl (&cl),
    m_eta (cl.eta(s)),
    m_phi (cl.phi(s)),
    m_p4 (cl.p4(s))
{
}

Member Function Documentation

◆ auxdata() [1/2]

template<class T>

XAOD_AUXDATA_DEPRECATED T & xAOD::IParticle::auxdata	(	const std::string &	name,
		const std::string &	clsname = "" )

inlineinherited

Fetch an aux data variable, as a non-const reference.

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns: A modifiable reference to the decoration

Definition at line 98 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                {
 
         return SG::Accessor< T >(name, clsname)(*this);
      }

◆ auxdata() [2/2]

template<class T>

XAOD_AUXDATA_DEPRECATED const T & xAOD::IParticle::auxdata	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

Fetch an aux data variable, as a const reference.

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns: A constant reference to the decoration

Definition at line 118 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
        
         return SG::ConstAccessor< T >( name, clsname )( *this );
      }

◆ clust()

const CaloCluster & xAOD::CaloVertexedClusterBase::clust ( ) const

inline

Return the cluster being proxied,.

Definition at line 69 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

69{ return *m_cl; }

◆ computeVertexCorr()

void xAOD::CaloVertexedClusterBase::computeVertexCorr	(	const Amg::Vector3D &	vx,
		double	radius )

protected

Calculate cluster kinematics for a given vertex.

Parameters

vx	The vertex to use for calculating cluster kinematics.

Definition at line 67 of file CaloVertexedClusterBase.cxx.

{
 
  if (radius<1.) return;
 
  double eta = m_eta;
  double phi = m_phi;
 
  if (std::fabs(eta)>10. || std::fabs(phi)>10.) return;
 
  CxxUtils::sincos sc (phi);
  double iradius = 1 / radius;
  m_eta += (-vx[2]/cosh(m_eta) + sc.apply (vx[1], vx[0])*tanh(m_eta)) * iradius;
  m_phi += sc.apply (vx[0], -vx[1]) * iradius;
  m_phi = CxxUtils::wrapToPi(m_phi);
 
  double pt = m_p4.P() / cosh (m_eta);
  m_p4.SetPtEtaPhiE (pt, m_eta, m_phi, m_p4.E());
}

◆ e()

virtual double xAOD::CaloVertexedClusterBase::e ( ) const

inlinefinalvirtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 83 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

83{ return m_p4.E(); }

◆ eta()

virtual double xAOD::CaloVertexedClusterBase::eta ( ) const

inlinefinalvirtual

The pseudorapidity ( \(\eta\)) of the particle.

Implements xAOD::IParticle.

Definition at line 77 of file Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedClusterBase.h.

77{ return m_eta; }

◆ isAvailable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

Check if a user property is available for reading or not.

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns: Whether the decoration exists or not

Definition at line 135 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
 
         return SG::ConstAccessor< T >(name, clsname).isAvailable(*this);
      }

◆ isAvailableWritable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

Check if a user property is available for writing or not.

This function can be used to check whether it will be possible to set a user property on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns: Whether the decoration is possible to set

Definition at line 152 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                                    {
 
         return SG::Accessor< T >(name, clsname).isAvailableWritable(*this);
      }