ATLAS Offline Software
CVFAlg.cxx
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
3  */
4 
5 #include "CVFAlg.h"
7 #include "StoreGate/ReadHandle.h"
10 
11 // NB: We should try and get something like the faster binned phi approach used
12 // in the PFlow construction. Of course, we might *really* want to just find a
13 // way of sharing that information? (for the track <-> cluster association)
14 namespace
15 {
16  bool fastDR(
17  double eta,
18  double phi,
20  double dr,
21  double dr2)
22  {
23  double dEta = std::abs(eta - track.eta);
24  if (dEta > dr)
25  return false;
26  double dPhi = std::abs(phi - track.phi);
27  if (dPhi > dr)
28  return false;
29  return (dEta * dEta + dPhi * dPhi) < dr2;
30  }
31 } // namespace
32 
33 namespace HLT
34 {
35  namespace MET
36  {
37  CVFAlg::CVFAlg(const std::string &name, ISvcLocator *pSvcLocator)
38  : AthReentrantAlgorithm(name, pSvcLocator)
39  {
40  }
41 
43  {
44  ATH_MSG_DEBUG("Initializing " << name());
45  CHECK(m_extensionTool.retrieve());
46  if (!m_trackSelTool.empty())
47  {
48  CHECK(m_trackSelTool.retrieve());
49  m_useTrackSelTool = true;
50  }
51  CHECK(m_tvaTool.retrieve());
54  CHECK(m_inputVertexKey.initialize());
55  if (m_outputCVFKey.key().find(".") == std::string::npos)
58  {
59  ATH_MSG_ERROR("CVF key does not match input cluster key!");
60  return StatusCode::FAILURE;
61  }
62  CHECK(m_outputCVFKey.initialize());
63  return StatusCode::SUCCESS;
64  }
65 
66  StatusCode CVFAlg::execute(const EventContext &ctx) const
67  {
68  using TrackExtension = IExtendTrackToLayerTool::TrackExtension;
69 
71  if (!clusters.isValid())
72  {
73  ATH_MSG_ERROR("Failed to retrieve " << m_inputClusterKey);
74  return StatusCode::FAILURE;
75  }
76  auto tracks = SG::makeHandle(m_inputTrackKey, ctx);
77  if (!tracks.isValid())
78  {
79  ATH_MSG_ERROR("Failed to retrieve " << m_inputTrackKey);
80  return StatusCode::FAILURE;
81  }
82  auto vertexHandle = SG::makeHandle(m_inputVertexKey, ctx);
83  if (!vertexHandle.isValid())
84  {
85  ATH_MSG_ERROR("Failed to retrieve " << m_inputVertexKey);
86  return StatusCode::FAILURE;
87  }
88  auto decCVF = SG::makeHandle<float>(m_outputCVFKey, ctx);
89 
90  // Find the primary vertex
91  const xAOD::Vertex *priVtx = nullptr;
92  std::vector<const xAOD::Vertex *> vertices;
93  vertices.reserve(vertexHandle->size());
94  for (const xAOD::Vertex *vtx : *vertexHandle)
95  {
96  if (!priVtx && vtx->vertexType() == xAOD::VxType::PriVtx)
97  priVtx = vtx;
98  vertices.push_back(vtx);
99  }
100  if (!priVtx)
101  {
102  // If we fail to find a primary vertex then we give every cluster a
103  // CVF value of -1
104  for (const xAOD::CaloCluster *iclus : *clusters)
105  decCVF(*iclus) = -1;
106  return StatusCode::SUCCESS;
107  }
108 
109  const xAOD::TrackParticleContainer *filteredTracks = nullptr;
111  if (m_useTrackSelTool)
112  {
113  for (const xAOD::TrackParticle *track : *tracks)
114  if (m_trackSelTool->accept(*track))
115  viewTracks.push_back(track);
116  filteredTracks = viewTracks.asDataVector();
117  }
118  else
119  filteredTracks = tracks.ptr();
120 
121  // To speed things up later, check the maximum positive and negative range of
122  // the track etas. This means we can avoid too many loops and dR comparisons
123  // later on.
124  double minTrkEta = std::numeric_limits<double>::infinity();
125  double maxTrkEta = -std::numeric_limits<double>::infinity();
126  ATH_MSG_DEBUG("Building extrapolation");
127  std::vector<std::tuple<bool, const xAOD::TrackParticle *, TrackExtension>> extensions;
128  extensions.reserve(filteredTracks->size());
129  for (const xAOD::TrackParticle *track : *filteredTracks)
130  {
131  TrackExtension ext = m_extensionTool->extendTrack(ctx, *track);
132  if (!ext.isValid())
133  continue;
134  minTrkEta = std::min(minTrkEta, ext.eta);
135  maxTrkEta = std::max(maxTrkEta, ext.eta);
136  bool isPV;
137  if (m_useCompatible)
138  isPV = m_tvaTool->isCompatible(*track, *priVtx);
139  else
140  isPV = m_tvaTool->getUniqueMatchVertex(*track, vertices) == priVtx;
141  extensions.push_back(std::make_tuple(isPV, track, ext));
142  }
143 
144  double DR2 = m_clusterMatchDR.value() * m_clusterMatchDR.value();
145  for (const xAOD::CaloCluster *iclus : *clusters)
146  {
147  double eta = iclus->eta();
148  if (iclus->e() < 0.0 ||
149  eta - m_clusterMatchDR > maxTrkEta ||
150  eta + m_clusterMatchDR < minTrkEta)
151  {
152  decCVF(*iclus) = -1;
153  continue;
154  }
155 
156  double phi = iclus->phi();
157  double totalSum = 0;
158  double PVSum = 0;
159  for (const std::tuple<bool, const xAOD::TrackParticle *, TrackExtension> &ext : extensions)
160  {
161  // match the cluster to the track
162  if (!fastDR(eta, phi, std::get<2>(ext), m_clusterMatchDR, DR2))
163  continue;
164  totalSum += std::get<1>(ext)->pt();
165  if (std::get<0>(ext))
166  PVSum += std::get<1>(ext)->pt();
167  }
168  decCVF(*iclus) = totalSum == 0 ? -1 : PVSum / totalSum;
169  }
170  return StatusCode::SUCCESS;
171  }
172  } // namespace MET
173 } // namespace HLT
HLT::MET::CVFAlg::CVFAlg
CVFAlg(const std::string &name, ISvcLocator *pSvcLocator)
Constructor.
Definition: CVFAlg.cxx:37
HLT::MET::CVFAlg::initialize
virtual StatusCode initialize() override
Initialise the algorithm.
Definition: CVFAlg.cxx:42
SG::contKeyFromKey
std::string contKeyFromKey(const std::string &key)
Extract the container part of key.
Definition: DecorKeyHelpers.cxx:26
HLT::MET::CVFAlg::m_clusterMatchDR
Gaudi::Property< double > m_clusterMatchDR
Definition: CVFAlg.h:73
HLT::MET::CVFAlg::m_trackSelTool
ToolHandle< InDet::IInDetTrackSelectionTool > m_trackSelTool
Definition: CVFAlg.h:61
phi
Scalar phi() const
phi method
Definition: AmgMatrixBasePlugin.h:67
HLT::MET::CVFAlg::execute
virtual StatusCode execute(const EventContext &ctx) const override
Run the algorithm.
Definition: CVFAlg.cxx:66
HLT::MET::CVFAlg::m_useTrackSelTool
bool m_useTrackSelTool
Is a track selection tool being used?
Definition: CVFAlg.h:81
SG::VIEW_ELEMENTS
@ VIEW_ELEMENTS
this data object is a view, it does not own its elmts
Definition: OwnershipPolicy.h:18
eta
Scalar eta() const
pseudorapidity method
Definition: AmgMatrixBasePlugin.h:83
ConstDataVector.h
DataVector adapter that acts like it holds const pointers.
CVFAlg.h
max
constexpr double max()
Definition: ap_fixedTest.cxx:33
min
constexpr double min()
Definition: ap_fixedTest.cxx:26
HLT::MET::CVFAlg::m_outputCVFKey
SG::WriteDecorHandleKey< xAOD::CaloClusterContainer > m_outputCVFKey
Definition: CVFAlg.h:71
HLT::MET::CVFAlg::m_inputClusterKey
SG::ReadHandleKey< xAOD::CaloClusterContainer > m_inputClusterKey
Definition: CVFAlg.h:65
python.TurnDataReader.dr
dr
Definition: TurnDataReader.py:112
SG::VarHandleKey::key
const std::string & key() const
Return the StoreGate ID for the referenced object.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:141
DecorKeyHelpers.h
Some common helper functions used by decoration handles.
xAOD::Vertex_v1::vertexType
VxType::VertexType vertexType() const
The type of the vertex.
ConstDataVector::asDataVector
const DV * asDataVector() const
Return a pointer to this object, as a const DataVector.
IExtendTrackToLayerTool::TrackExtension
Helper struct to hold track extrapolation information.
Definition: IExtendTrackToLayerTool.h:27
AthReentrantAlgorithm
An algorithm that can be simultaneously executed in multiple threads.
Definition: AthReentrantAlgorithm.h:83
SG::makeHandle
SG::ReadCondHandle< T > makeHandle(const SG::ReadCondHandleKey< T > &key, const EventContext &ctx=Gaudi::Hive::currentContext())
Definition: ReadCondHandle.h:270
xAOD::CaloCluster_v1
Description of a calorimeter cluster.
Definition: CaloCluster_v1.h:59
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
HLT
It used to be useful piece of code for replacing actual SG with other store of similar functionality ...
Definition: HLTResultReader.h:26
HLT::MET::CVFAlg::m_inputTrackKey
SG::ReadHandleKey< xAOD::TrackParticleContainer > m_inputTrackKey
Definition: CVFAlg.h:67
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
HLT::MET::CVFAlg::m_extensionTool
ToolHandle< IExtendTrackToLayerTool > m_extensionTool
Definition: CVFAlg.h:59
TauGNNUtils::Variables::Track::dPhi
bool dPhi(const xAOD::TauJet &tau, const xAOD::TauTrack &track, double &out)
Definition: TauGNNUtils.cxx:538
WriteDecorHandle.h
Handle class for adding a decoration to an object.
xAOD::VxType::PriVtx
@ PriVtx
Primary vertex.
Definition: TrackingPrimitives.h:571
CHECK
#define CHECK(...)
Evaluate an expression and check for errors.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:422
MakeFileForMJB.ext
string ext
Definition: Moriond2016/MakeFileForMJB.py:41
SG::VarHandleKey::initialize
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:103
DataVector
Derived DataVector<T>.
Definition: DataVector.h:794
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
MET
Definition: MET.py:1
ConstDataVector::push_back
value_type push_back(value_type pElem)
Add an element to the end of the collection.
plot.extensions
string extensions
Definition: PhysicsAnalysis/ElectronPhotonID/ElectronPhotonFourMomentumCorrection/python/plot.py:61
xAOD::Vertex_v1
Class describing a Vertex.
Definition: Vertex_v1.h:42
ConstDataVector
DataVector adapter that acts like it holds const pointers.
Definition: ConstDataVector.h:76
RunTileMonitoring.clusters
clusters
Definition: RunTileMonitoring.py:133
xAOD::track
@ track
Definition: TrackingPrimitives.h:512
xAOD::TrackParticle_v1
Class describing a TrackParticle.
Definition: TrackParticle_v1.h:43
ReadHandle.h
Handle class for reading from StoreGate.
TauGNNUtils::Variables::Track::dEta
bool dEta(const xAOD::TauJet &tau, const xAOD::TauTrack &track, double &out)
Definition: TauGNNUtils.cxx:527
HLT::MET::CVFAlg::m_inputVertexKey
SG::ReadHandleKey< xAOD::VertexContainer > m_inputVertexKey
Definition: CVFAlg.h:69
DataVector::size
size_type size() const noexcept
Returns the number of elements in the collection.
HLT::MET::CVFAlg::m_useCompatible
Gaudi::Property< bool > m_useCompatible
Definition: CVFAlg.h:75
HLT::MET::CVFAlg::m_tvaTool
ToolHandle< CP::ITrackVertexAssociationTool > m_tvaTool
Definition: CVFAlg.h:63