CaloCluster_OnTrackBuilder Class Reference

#include <CaloCluster_OnTrackBuilder.h>

Inheritance diagram for CaloCluster_OnTrackBuilder:

Collaboration diagram for CaloCluster_OnTrackBuilder:

Public Member Functions
	CaloCluster_OnTrackBuilder (const std::string &, const std::string &, const IInterface *)
	Constructor with AlgTool parameters.
	CaloCluster_OnTrackBuilder ()
	~CaloCluster_OnTrackBuilder ()=default
virtual StatusCode	initialize () override final
virtual StatusCode	finalize () override final
virtual std::unique_ptr< Trk::CaloCluster_OnTrack >	buildClusterOnTrack (const EventContext &ctx, const xAOD::CaloCluster *cl, int charge=0) const override final
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
std::unique_ptr< Trk::Surface >	getCaloSurface (const xAOD::CaloCluster *cluster, const CaloDetDescrManager *caloDDMgr) const
Trk::LocalParameters	getClusterLocalParameters (const xAOD::CaloCluster *cluster, const Trk::Surface *surf, int charge) const
Amg::MatrixX	getClusterErrorMatrix (const xAOD::CaloCluster *cluster, const Trk::Surface &surf, int charge) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< ICaloSurfaceBuilder >	m_calosurf
	Tool to build calorimeter layer surfaces.
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey
Gaudi::Property< bool >	m_useClusterEnergy { this, "UseClusterEnergy", true }
	Which cluster measurements to use in order to add constraints by default we are interested in the ones that affect the bending plane Energy and phi.
Gaudi::Property< bool >	m_useClusterPhi { this, "UseClusterPhi", true }
Gaudi::Property< bool >	m_useClusterEta { this, "UseClusterEta", false }
std::unique_ptr< eg_resolution >	m_eg_resol {}
	helper for returning energy resolution
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 31 of file CaloCluster_OnTrackBuilder.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

CaloCluster_OnTrackBuilder() [1/2]

CaloCluster_OnTrackBuilder::CaloCluster_OnTrackBuilder	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Constructor with AlgTool parameters.

Definition at line 67 of file CaloCluster_OnTrackBuilder.cxx.

  : AthAlgTool(t, n, p)
{
  declareInterface<ICaloCluster_OnTrackBuilder>(this);
}

CaloCluster_OnTrackBuilder() [2/2]

CaloCluster_OnTrackBuilder::CaloCluster_OnTrackBuilder

(

)

~CaloCluster_OnTrackBuilder()

CaloCluster_OnTrackBuilder::~CaloCluster_OnTrackBuilder ( )

default

Member Function Documentation

buildClusterOnTrack()

std::unique_ptr< Trk::CaloCluster_OnTrack > CaloCluster_OnTrackBuilder::buildClusterOnTrack ( const EventContext & ctx, const xAOD::CaloCluster * cl, int charge = 0 ) const

finaloverridevirtual

Implements ICaloCluster_OnTrackBuilder.

Definition at line 91 of file CaloCluster_OnTrackBuilder.cxx.

{
 
  ATH_MSG_DEBUG("Building Trk::CaloCluster_OnTrack");
 
  if (!m_useClusterPhi && !m_useClusterEta && !m_useClusterEnergy) {
    ATH_MSG_WARNING("CaloCluster_OnTrackBuilder is configured incorrectly");
    return nullptr;
  }
 
  if (!cluster) {
    return nullptr;
  }
 
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{ m_caloMgrKey, ctx };
  const CaloDetDescrManager* caloDDMgr = *caloMgrHandle;
  std::unique_ptr<Trk::Surface> surface = getCaloSurface(cluster, caloDDMgr);
 
  if (!surface) {
    return nullptr;
  }
 
  Trk::LocalParameters lp =
    getClusterLocalParameters(cluster, surface.get(), charge);
 
  Amg::MatrixX em = getClusterErrorMatrix(cluster, *surface, charge);
 
  return std::make_unique<Trk::CaloCluster_OnTrack>(std::move(lp), std::move(em), *surface);
 
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

finalize()

StatusCode CaloCluster_OnTrackBuilder::finalize ( )

finaloverridevirtual

Definition at line 85 of file CaloCluster_OnTrackBuilder.cxx.

{
  return StatusCode::SUCCESS;
}

getCaloSurface()

std::unique_ptr< Trk::Surface > CaloCluster_OnTrackBuilder::getCaloSurface ( const xAOD::CaloCluster * cluster, const CaloDetDescrManager * caloDDMgr ) const

private

Definition at line 126 of file CaloCluster_OnTrackBuilder.cxx.

{
 
  std::unique_ptr<Trk::Surface> destinationSurface = nullptr;
 
  // Determine if we want to extrapolate to the barrel or endcap.  If in the
  // crack choose the detector with largest amount of energy in the second
  // sampling layer
  if (xAOD::EgammaHelpers::isBarrel(cluster)) {
    destinationSurface.reset(m_calosurf->CreateUserSurface(
      CaloCell_ID::EMB2, 0., cluster->eta(), caloDDMgr));
  } else {
    destinationSurface.reset(m_calosurf->CreateUserSurface(
      CaloCell_ID::EME2, 0., cluster->eta(), caloDDMgr));
  }
  return destinationSurface;
}

getClusterErrorMatrix()

Amg::MatrixX CaloCluster_OnTrackBuilder::getClusterErrorMatrix ( const xAOD::CaloCluster * cluster, const Trk::Surface & surf, int charge ) const

private

Definition at line 206 of file CaloCluster_OnTrackBuilder.cxx.

{
  int matrixSize = static_cast<int>(m_useClusterEta) +
                   static_cast<int>(m_useClusterPhi) +
                   static_cast<int>(m_useClusterEnergy);
  Amg::MatrixX covMatrix(matrixSize, matrixSize);
  covMatrix.setZero();
 
  const double clusterE = cluster->e();
  const double clusterEta = cluster->eta();
 
  // variance in phi from calorimeter phi resolution
  double phivariance = phiVariance(clusterE, std::abs(clusterEta));
  if (phivariance < 1e-5) {
    // Avoid going too small for  very high E
    phivariance = 1e-5;
  }
 
  // q over p variance from sigmaE/E (calo energy resolution)
  const double sigmaP_over_P = m_eg_resol->getResolution(0, // electron
                                                         clusterE,
                                                         clusterEta,
                                                         2 // 90% quantile
  );
  const double qOverP = 1. / clusterE;
  const double qOverP_variance =
    (qOverP * qOverP) * (sigmaP_over_P * sigmaP_over_P);
 
  // Variance in Z
  // sigma ~ 20 mm large error
  // As currently we do not want to rely
  // on the eta side of the cluster.
  constexpr double zvariance = 400;
 
  if (xAOD::EgammaHelpers::isBarrel(cluster)) {
    // The two coordinates for a cyclinder are
    // Trk::locRPhi = 0 (ie phi)
    // Trk::locZ    = 1(ie z)
    const Amg::Vector3D& surfRefPoint = surf.globalReferencePoint();
    double r = surfRefPoint.perp();
    double r2 = r * r;
    int indexCount(0);
    if (m_useClusterPhi) {
      covMatrix(indexCount, indexCount) = phivariance * r2;
      ++indexCount;
    }
    if (m_useClusterEta) {
      covMatrix(indexCount, indexCount) = zvariance;
      ++indexCount;
    }
    if (m_useClusterEnergy) {
      covMatrix(indexCount, indexCount) = qOverP_variance;
      ++indexCount;
    }
  } else {
    // Local paramters of a disk are
    // Trk::locR   = 0
    // Trk::locPhi = 1
    int indexCount(0);
 
    if (m_useClusterEta) {
      covMatrix(indexCount, indexCount) = zvariance;
      ++indexCount;
    }
    if (m_useClusterPhi) {
      covMatrix(indexCount, indexCount) = phivariance;
      ++indexCount;
    }
    if (m_useClusterEnergy) {
      covMatrix(indexCount, indexCount) = qOverP_variance;
      ++indexCount;
    }
  }
 
  return covMatrix;
}

getClusterLocalParameters()

Trk::LocalParameters CaloCluster_OnTrackBuilder::getClusterLocalParameters ( const xAOD::CaloCluster * cluster, const Trk::Surface * surf, int charge ) const

private

Definition at line 147 of file CaloCluster_OnTrackBuilder.cxx.

{
 
  Amg::Vector3D surfRefPoint = surf->globalReferencePoint();
  double eta = cluster->eta();
  double phi = cluster->phi();
  double clusterQoverE = cluster->e() != 0 ? (double)charge / cluster->e() : 0;
 
  if (xAOD::EgammaHelpers::isBarrel(cluster)) {
    // Two corindate in a cyclinder are
    // Trk::locRPhi = 0 (ie phi)
    // Trk::locZ    = 1(ie z)
    double r = surfRefPoint.perp();
    std::vector<Trk::DefinedParameter> defPar;
    if (m_useClusterPhi) {
      Trk::DefinedParameter locRPhi(r * phi, Trk::locRPhi);
      defPar.push_back(locRPhi);
    }
    if (m_useClusterEta) {
      double theta = 2 * atan(exp(-eta)); //  -log(tan(theta/2));
      double tantheta = tan(theta);
      double z = tantheta == 0 ? 0. : r / tantheta;
      Trk::DefinedParameter locZ(z, Trk::locZ);
      defPar.push_back(locZ);
    }
    if (m_useClusterEnergy) {
      Trk::DefinedParameter qOverP(clusterQoverE, Trk::qOverP);
      defPar.push_back(qOverP);
    }
    return {defPar};
  }
  // Local paramters of a disk are
  // Trk::locR   = 0
  // Trk::locPhi = 1
  double z = surfRefPoint.z();
  std::vector<Trk::DefinedParameter> defPar;
  if (m_useClusterEta) {
    double theta = 2 * atan(exp(-eta)); //  -log(tan(theta/2));
    double tantheta = tan(theta);
    double r = z * tantheta;
    Trk::DefinedParameter locR(r, Trk::locR);
    defPar.push_back(locR);
  }
  if (m_useClusterPhi) {
    Trk::DefinedParameter locPhi(phi, Trk::locPhi);
    defPar.push_back(locPhi);
  }
  if (m_useClusterEnergy) {
    Trk::DefinedParameter qOverP(clusterQoverE, Trk::qOverP);
    defPar.push_back(qOverP);
  }
 
  return {defPar};
}

initialize()

StatusCode CaloCluster_OnTrackBuilder::initialize ( )

finaloverridevirtual

Definition at line 76 of file CaloCluster_OnTrackBuilder.cxx.

{
  m_eg_resol = std::make_unique<eg_resolution>("run2_R21_v1");
  ATH_CHECK(m_calosurf.retrieve());
  ATH_CHECK(m_caloMgrKey.initialize());
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & ICaloCluster_OnTrackBuilder::interfaceID ( )

inlinestaticinherited

Definition at line 22 of file ICaloCluster_OnTrackBuilder.h.

  {
    return IID_caloCluster_OnTrackBuilder;
  };

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> CaloCluster_OnTrackBuilder::m_caloMgrKey

private

Initial value:

{
    this,
    "CaloDetDescrManager",
    "CaloDetDescrManager"
  }

Definition at line 75 of file CaloCluster_OnTrackBuilder.h.

                                                       {
    this,
    "CaloDetDescrManager",
    "CaloDetDescrManager"
  };

m_calosurf

ToolHandle<ICaloSurfaceBuilder> CaloCluster_OnTrackBuilder::m_calosurf

private

Initial value:

{
    this,
    "CaloSurfaceBuilder",
    "CaloSurfaceBuilder",
    "Tool to build calorimeter layer surfaces"
  }

Tool to build calorimeter layer surfaces.

Definition at line 69 of file CaloCluster_OnTrackBuilder.h.

                                            {
    this,
    "CaloSurfaceBuilder",
    "CaloSurfaceBuilder",
    "Tool to build calorimeter layer surfaces"
  };

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_eg_resol

std::unique_ptr<eg_resolution> CaloCluster_OnTrackBuilder::m_eg_resol {}

private

helper for returning energy resolution

Definition at line 89 of file CaloCluster_OnTrackBuilder.h.

{};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_useClusterEnergy

Gaudi::Property<bool> CaloCluster_OnTrackBuilder::m_useClusterEnergy { this, "UseClusterEnergy", true }

private

Which cluster measurements to use in order to add constraints by default we are interested in the ones that affect the bending plane Energy and phi.

Definition at line 84 of file CaloCluster_OnTrackBuilder.h.

{ this, "UseClusterEnergy", true };

m_useClusterEta

Gaudi::Property<bool> CaloCluster_OnTrackBuilder::m_useClusterEta { this, "UseClusterEta", false }

private

Definition at line 86 of file CaloCluster_OnTrackBuilder.h.

{ this, "UseClusterEta", false };

m_useClusterPhi

Gaudi::Property<bool> CaloCluster_OnTrackBuilder::m_useClusterPhi { this, "UseClusterPhi", true }

private

Definition at line 85 of file CaloCluster_OnTrackBuilder.h.

{ this, "UseClusterPhi", true };

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• CaloCluster_OnTrackBuilder.h
• CaloCluster_OnTrackBuilder.cxx