ATLAS Offline Software
TileCellsMuonDecorator.cxx
Go to the documentation of this file.
1 
3 /*
4  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
5 */
6 
7 // TileCellsMuonDecorator.cxx
8 // Implementation file for class TileCellsMuonDecorator
10 
11 // Tile includes
12 #include "TileCellsMuonDecorator.h"
13 
14 // Athena
16 #include "StoreGate/ReadHandle.h"
18 #include "CaloGeoHelpers/proxim.h"
19 #include "xAODMuon/MuonContainer.h"
20 
21 #include <string>
22 #include <vector>
23 #include <algorithm>
24 
25 namespace DerivationFramework {
26 
28 
29  ATH_CHECK(m_trackInCalo.retrieve());
30  ATH_CHECK(m_tracksInCone.retrieve());
31  ATH_CHECK(m_cellsDecorator.retrieve());
32 
36 
37  ATH_CHECK( m_selectedMuKey.initialize() );
38  ATH_CHECK( m_econeMuKey.initialize() );
39  ATH_CHECK( m_cellsMuonXKey.initialize() );
40  ATH_CHECK( m_cellsMuonYKey.initialize() );
41  ATH_CHECK( m_cellsMuonZKey.initialize() );
42  ATH_CHECK( m_cellsMuonEtaKey.initialize() );
43  ATH_CHECK( m_cellsMuonPhiKey.initialize() );
44  ATH_CHECK( m_cellsToMuonDxKey.initialize() );
45  ATH_CHECK( m_cellsToMuonDyKey.initialize() );
46  ATH_CHECK( m_cellsToMuonDzKey.initialize() );
47  ATH_CHECK( m_cellsToMuonDetaKey.initialize() );
48  ATH_CHECK( m_cellsToMuonDphiKey.initialize() );
49  ATH_CHECK( m_cellsMuonDxKey.initialize() );
50  ATH_CHECK( m_cellsMuonDeDxKey.initialize() );
52 
53  for (unsigned int layer : m_energyInLayers) {
55  }
56 
57  return StatusCode::SUCCESS;
58  }
59 
60  StatusCode TileCellsMuonDecorator::addBranches(const EventContext& ctx) const {
61 
62 
64  ATH_CHECK( muons.isValid() );
65 
66  const CaloCellContainer* cellContainer = nullptr;
67  if (!m_cellContainerKey.empty()) {
69  ATH_CHECK( caloCells.isValid() );
70  cellContainer = caloCells.cptr();
71  }
72 
73  const xAOD::CaloClusterContainer* clusterContainer = nullptr;
76  ATH_CHECK( caloClusters.isValid() );
77  clusterContainer = caloClusters.cptr();
78  }
79 
94  std::vector<SG::WriteDecorHandle<xAOD::MuonContainer, float>> larEnergyInCones;
96  larEnergyInCones.emplace_back(key, ctx);
97  }
98 
99  std::map<const xAOD::IParticle*, std::vector<const CaloCell*>> muonCellsMap;
100 
101  for ( const xAOD::Muon* mu : *muons ) {
102 
103  std::vector<const CaloCell*> cells;
104 
105  std::vector< float > cells_mu_x;
106  std::vector< float > cells_mu_y;
107  std::vector< float > cells_mu_z;
108  std::vector< float > cells_mu_eta;
109  std::vector< float > cells_mu_phi;
110 
111  std::vector< float > cells_to_mu_dx;
112  std::vector< float > cells_to_mu_dy;
113  std::vector< float > cells_to_mu_dz;
114  std::vector< float > cells_to_mu_deta;
115  std::vector< float > cells_to_mu_dphi;
116 
117  std::vector< float > cells_mu_dx;
118  std::vector< float > cells_mu_dedx;
119  std::vector< float > lar_energy_in_cones;
120 
121  if (m_selectMuons &&
122  (mu->muonType() != xAOD::Muon::Combined
123  || mu->pt() < m_minPt
124  || std::abs(mu->eta()) > m_maxAbsEta)) {
125 
126  selected_mu(*mu) = 0;
127  continue;
128  }
129 
130  const xAOD::TrackParticle* mu_track = mu->trackParticle(xAOD::Muon::InnerDetectorTrackParticle);
131  const xAOD::CaloCluster* mu_cluster = mu->cluster();
132  if (mu_track && mu_cluster && mu_cluster->getCellLinks()) {
133 
134  float e_trk_in_isocone(0.0);
135  std::vector<const xAOD::TrackParticle*> tracks_in_cone;
136  m_tracksInCone->particlesInCone(mu_track->eta(), mu_track->phi(), m_isoCone, tracks_in_cone);
137  for (const xAOD::TrackParticle* track : tracks_in_cone) {
138  if (track != mu_track) e_trk_in_isocone += track->e();
139  }
140 
141  econe_mu(*mu) = e_trk_in_isocone;
142 
143  if (m_selectMuons && (e_trk_in_isocone > m_maxRelEtrkInIsoCone * mu_track->e())) {
144  selected_mu(*mu) = 0;
145  continue;
146  }
147 
148  selected_mu(*mu) = 1;
149 
150  cells.clear();
151  bool addAdditionalGapCrackCells = false;
152  for (const CaloCell* cell : *mu_cluster) {
153  const CaloDetDescrElement* cell_dde = cell->caloDDE();
154  if ((cell_dde->is_tile())) {
155  if (cellContainer && (cell_dde->getSampling() == CaloCell_ID::TileGap3)) {
156  addAdditionalGapCrackCells = true;
157  continue;
158  }
159  cells.push_back(cell);
160  }
161  }
162 
163  if (addAdditionalGapCrackCells) {
164  std::vector<double> coordinates = m_trackInCalo->getXYZEtaPhiInCellSampling(mu_track, CaloCell_ID::TileGap3);
165  if (coordinates.size() == 5 ) {
166  double eta = coordinates[3];
167  double phi = coordinates[4];
168  for (const CaloCell* cell : *cellContainer) {
169  const CaloDetDescrElement* cell_dde = cell->caloDDE();
170  if (cell_dde->getSampling() == CaloCell_ID::TileGap3) {
171  if (std::fabs(eta - cell->eta()) < m_gapCrackCellsInDeltaEta
172  && std::fabs(KinematicUtils::deltaPhi(phi, cell->phi())) < m_gapCrackCellsInDeltaPhi) {
173  cells.push_back(cell);
174  }
175  }
176  }
177  }
178  }
179 
180  for (const CaloCell* cell : cells) {
181 
182  std::vector<double> coordinates = m_trackInCalo->getXYZEtaPhiInCellSampling(mu_track, cell);
183 
184  if (coordinates.size() == 5 ) {
185 
186  float path_length = m_trackInCalo->getPathInsideCell(mu_track, cell);
187  cells_mu_dx.push_back( path_length );
188  cells_mu_dedx.push_back( (path_length > 0 ? (cell->energy() / path_length) : -1.0) );
189 
190  cells_mu_x.push_back(coordinates[0]);
191  cells_mu_y.push_back(coordinates[1]);
192  cells_mu_z.push_back(coordinates[2]);
193  cells_mu_eta.push_back(coordinates[3]);
194  cells_mu_phi.push_back(coordinates[4]);
195 
196  cells_to_mu_dx.push_back(cell->x() - coordinates[0]);
197  cells_to_mu_dy.push_back(cell->y() - coordinates[1]);
198  cells_to_mu_dz.push_back(cell->z() - coordinates[2]);
199  cells_to_mu_deta.push_back(cell->eta() - coordinates[3]);
200  cells_to_mu_dphi.push_back( KinematicUtils::deltaPhi(coordinates[4], cell->phi()) );
201 
202  } else {
203 
204  cells_mu_dx.push_back( 0.0 );
205  cells_mu_dedx.push_back( -2.0 );
206 
207  cells_mu_x.push_back(0.0);
208  cells_mu_y.push_back(0.0);
209  cells_mu_z.push_back(0.0);
210  cells_mu_eta.push_back(0.0);
211  cells_mu_phi.push_back(0.0);
212 
213  cells_to_mu_dx.push_back(0.0);
214  cells_to_mu_dy.push_back(0.0);
215  cells_to_mu_dz.push_back(0.0);
216  cells_to_mu_deta.push_back(0.0);
217  cells_to_mu_dphi.push_back(0.0);
218 
219  }
220  }
221 
222  muonCellsMap[mu] = cells;
223 
224  if (clusterContainer) {
225  lar_energy_in_cones = m_trackInCalo->getEnergyInCones(mu_track, clusterContainer, m_energyInSamplings, m_drCones, ctx);
226  }
227 
228  } else {
229  selected_mu(*mu) = 0;
230  }
231 
232  cellsMuonX(*mu) = std::move(cells_mu_x);
233  cellsMuonY(*mu) = std::move(cells_mu_y);
234  cellsMuonZ(*mu) = std::move(cells_mu_z);
235  cellsMuonEta(*mu) = std::move(cells_mu_eta);
236  cellsMuonPhi(*mu) = std::move(cells_mu_phi);
237  cellsToMuonDx(*mu) = std::move(cells_to_mu_dx);
238  cellsToMuonDy(*mu) = std::move(cells_to_mu_dy);
239  cellsToMuonDz(*mu) = std::move(cells_to_mu_dz);
240  cellsToMuonDeta(*mu) = std::move(cells_to_mu_deta);
241  cellsToMuonDphi(*mu) = std::move(cells_to_mu_dphi);
242  cellsMuonDx(*mu) = std::move(cells_mu_dx);
243  cellsMuonDeDx(*mu) = std::move(cells_mu_dedx);
244 
245  for (unsigned int icone = 0; icone < larEnergyInCones.size(); ++icone) {
246  larEnergyInCones[icone](*mu) = std::move(lar_energy_in_cones[icone]);
247  }
248 
249  }
250 
251  ATH_CHECK( m_cellsDecorator->decorate(muonCellsMap, ctx) );
252 
253  return StatusCode::SUCCESS;
254  }
255 
256 }
DerivationFramework::TileCellsMuonDecorator::m_cellsMuonPhiKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsMuonPhiKey
Definition: TileCellsMuonDecorator.h:79
DerivationFramework::TileCellsMuonDecorator::m_cellsDecorator
ToolHandle< DerivationFramework::TileCellsDecorator > m_cellsDecorator
Definition: TileCellsMuonDecorator.h:98
SG::WriteDecorHandleKey
Property holding a SG store/key/clid/attr name from which a WriteDecorHandle is made.
Definition: StoreGate/StoreGate/WriteDecorHandleKey.h:89
RunTileCalibRec.cells
cells
Definition: RunTileCalibRec.py:281
DerivationFramework::TileCellsMuonDecorator::m_cellContainerKey
SG::ReadHandleKey< CaloCellContainer > m_cellContainerKey
Definition: TileCellsMuonDecorator.h:69
ReadCellNoiseFromCool.cell
cell
Definition: ReadCellNoiseFromCool.py:53
phi
Scalar phi() const
phi method
Definition: AmgMatrixBasePlugin.h:67
SG::ReadHandle::cptr
const_pointer_type cptr()
Dereference the pointer.
DerivationFramework::TileCellsMuonDecorator::m_selectedMuKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_selectedMuKey
Definition: TileCellsMuonDecorator.h:72
eta
Scalar eta() const
pseudorapidity method
Definition: AmgMatrixBasePlugin.h:83
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:67
xAOD::TrackParticle_v1::eta
virtual double eta() const override final
The pseudorapidity ( ) of the particle.
Definition: TrackParticle_v1.cxx:79
DerivationFramework::TileCellsMuonDecorator::m_cellsMuonDeDxKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsMuonDeDxKey
Definition: TileCellsMuonDecorator.h:88
CaloDetDescrElement
This class groups all DetDescr information related to a CaloCell. Provides a generic interface for al...
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:66
DerivationFramework::TileCellsMuonDecorator::m_cellsMuonZKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsMuonZKey
Definition: TileCellsMuonDecorator.h:77
DerivationFramework::TileCellsMuonDecorator::m_clusterContainerKey
SG::ReadHandleKey< xAOD::CaloClusterContainer > m_clusterContainerKey
Definition: TileCellsMuonDecorator.h:70
SG::VarHandleKey::empty
bool empty() const
Test if the key is blank.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:150
DerivationFramework::TileCellsMuonDecorator::initialize
virtual StatusCode initialize() override final
Definition: TileCellsMuonDecorator.cxx:27
DerivationFramework::TileCellsMuonDecorator::m_muonContainerKey
SG::ReadHandleKey< xAOD::MuonContainer > m_muonContainerKey
Definition: TileCellsMuonDecorator.h:68
CaloCell_ID_FCS::TileGap3
@ TileGap3
Definition: FastCaloSim_CaloCell_ID.h:36
xAOD::Muon_v1
Class describing a Muon.
Definition: Muon_v1.h:38
DerivationFramework::TileCellsMuonDecorator::m_trackInCalo
ToolHandle< TileCal::ITrackTools > m_trackInCalo
Definition: TileCellsMuonDecorator.h:92
DerivationFramework::TileCellsMuonDecorator::m_tracksInCone
ToolHandle< xAOD::ITrackParticlesInConeTool > m_tracksInCone
Definition: TileCellsMuonDecorator.h:95
DerivationFramework::TileCellsMuonDecorator::m_energyInLayers
Gaudi::Property< std::set< unsigned int > > m_energyInLayers
Definition: TileCellsMuonDecorator.h:62
proxim.h
xAOD::CaloCluster_v1
Description of a calorimeter cluster.
Definition: CaloCluster_v1.h:62
DerivationFramework::TileCellsMuonDecorator::m_cellsToMuonDyKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsToMuonDyKey
Definition: TileCellsMuonDecorator.h:82
DerivationFramework::TileCellsMuonDecorator::m_gapCrackCellsInDeltaPhi
Gaudi::Property< double > m_gapCrackCellsInDeltaPhi
Definition: TileCellsMuonDecorator.h:66
DerivationFramework::TileCellsMuonDecorator::m_cellsToMuonDphiKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsToMuonDphiKey
Definition: TileCellsMuonDecorator.h:85
DerivationFramework::TileCellsMuonDecorator::m_cellsToMuonDetaKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsToMuonDetaKey
Definition: TileCellsMuonDecorator.h:84
CaloSampling::CaloSample
CaloSample
Definition: Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h:22
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
TRT::Hit::layer
@ layer
Definition: HitInfo.h:79
SG::WriteDecorHandle
Handle class for adding a decoration to an object.
Definition: StoreGate/StoreGate/WriteDecorHandle.h:100
DerivationFramework::TileCellsMuonDecorator::m_isoCone
Gaudi::Property< double > m_isoCone
Definition: TileCellsMuonDecorator.h:59
DerivationFramework::TileCellsMuonDecorator::m_selectMuons
Gaudi::Property< bool > m_selectMuons
Definition: TileCellsMuonDecorator.h:56
WriteDecorHandle.h
Handle class for adding a decoration to an object.
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
DerivationFramework::TileCellsMuonDecorator::m_cellsMuonDxKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsMuonDxKey
Definition: TileCellsMuonDecorator.h:87
DerivationFramework
THE reconstruction tool.
Definition: ParticleSortingAlg.h:24
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:795
DerivationFramework::TileCellsMuonDecorator::m_gapCrackCellsInDeltaEta
Gaudi::Property< double > m_gapCrackCellsInDeltaEta
Definition: TileCellsMuonDecorator.h:65
xAOD::CaloCluster_v1::getCellLinks
const CaloClusterCellLink * getCellLinks() const
Get a pointer to the CaloClusterCellLink object (const version)
Definition: CaloCluster_v1.cxx:829
SG::ReadHandle::isValid
virtual bool isValid() override final
Can the handle be successfully dereferenced?
DerivationFramework::TileCellsMuonDecorator::m_drCones
Gaudi::Property< std::vector< double > > m_drCones
Definition: TileCellsMuonDecorator.h:60
KinematicUtils::deltaPhi
double deltaPhi(double phi1, double phi2)
Definition: D3PDMaker/TileD3PDMaker/src/ITrackTools.h:104
Trk::Combined
@ Combined
Definition: Tracking/TrkTools/TrkTrackSummaryTool/TrkTrackSummaryTool/TrackSummaryTool.h:32
DerivationFramework::TileCellsMuonDecorator::m_maxRelEtrkInIsoCone
Gaudi::Property< double > m_maxRelEtrkInIsoCone
Definition: TileCellsMuonDecorator.h:64
CaloDetDescrElement::is_tile
bool is_tile() const
cell belongs to Tile
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:442
DerivationFramework::TileCellsMuonDecorator::m_minPt
Gaudi::Property< double > m_minPt
Definition: TileCellsMuonDecorator.h:57
DerivationFramework::TileCellsMuonDecorator::m_econeMuKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_econeMuKey
Definition: TileCellsMuonDecorator.h:73
errorcheck.h
Helpers for checking error return status codes and reporting errors.
DerivationFramework::TileCellsMuonDecorator::m_cellsToMuonDxKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsToMuonDxKey
Definition: TileCellsMuonDecorator.h:81
DerivationFramework::TileCellsMuonDecorator::addBranches
virtual StatusCode addBranches(const EventContext &ctx) const override final
Definition: TileCellsMuonDecorator.cxx:60
xAOD::TrackParticle_v1::e
virtual double e() const override final
The total energy of the particle.
Definition: TrackParticle_v1.cxx:111
CaloCellContainer
Container class for CaloCell.
Definition: CaloCellContainer.h:55
MuonContainer.h
DerivationFramework::TileCellsMuonDecorator::m_larEnergyInConeKeyArray
SG::WriteDecorHandleKeyArray< xAOD::MuonContainer > m_larEnergyInConeKeyArray
Definition: TileCellsMuonDecorator.h:89
CaloCell
Data object for each calorimeter readout cell.
Definition: CaloCell.h:57
CaloDetDescrElement::getSampling
CaloCell_ID::CaloSample getSampling() const
cell sampling
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:395
DerivationFramework::TileCellsMuonDecorator::m_cellsToMuonDzKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsToMuonDzKey
Definition: TileCellsMuonDecorator.h:83
DerivationFramework::TileCellsMuonDecorator::m_energyInSamplings
std::set< xAOD::CaloCluster::CaloSample > m_energyInSamplings
Definition: TileCellsMuonDecorator.h:101
DerivationFramework::TileCellsMuonDecorator::m_maxAbsEta
Gaudi::Property< double > m_maxAbsEta
Definition: TileCellsMuonDecorator.h:58
xAOD::track
@ track
Definition: TrackingPrimitives.h:513
xAOD::TrackParticle_v1
Class describing a TrackParticle.
Definition: TrackParticle_v1.h:44
ReadHandle.h
Handle class for reading from StoreGate.
TileCellsMuonDecorator.h
CaloNoise_fillDB.mu
mu
Definition: CaloNoise_fillDB.py:51
SG::AllowEmpty
@ AllowEmpty
Definition: StoreGate/StoreGate/VarHandleKey.h:27
xAOD::TrackParticle_v1::phi
virtual double phi() const override final
The azimuthal angle ( ) of the particle (has range to .)
DerivationFramework::TileCellsMuonDecorator::m_cellsMuonYKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsMuonYKey
Definition: TileCellsMuonDecorator.h:76
mapkey::key
key
Definition: TElectronEfficiencyCorrectionTool.cxx:37
DerivationFramework::TileCellsMuonDecorator::m_cellsMuonEtaKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsMuonEtaKey
Definition: TileCellsMuonDecorator.h:78
DerivationFramework::TileCellsMuonDecorator::m_cellsMuonXKey
SG::WriteDecorHandleKey< xAOD::MuonContainer > m_cellsMuonXKey
Definition: TileCellsMuonDecorator.h:75