ATLAS Offline Software
TRT_PrepDataToxAOD.cxx
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
3 */
4 
6 // TRT_PrepDataToxAOD.cxx
7 // Implementation file for class TRT_PrepDataToxAOD
9 
10 #include "TRT_PrepDataToxAOD.h"
11 
13 //#include "EventPrimitives/EventPrimitivesHelpers.h"
14 
18 
19 
20 #include "Identifier/Identifier.h"
21 #include "InDetIdentifier/TRT_ID.h"
22 
23 
24 #include "TrkSurfaces/Surface.h"
25 
29 
30 #include "StoreGate/ReadHandle.h"
31 #include "StoreGate/WriteHandle.h"
32 
33 #define AUXDATA(OBJ, TYP, NAME) \
34  static const SG::AuxElement::Accessor<TYP> acc_##NAME (#NAME); acc_##NAME(*(OBJ))
35 
37 //
38 // Constructor with parameters:
39 //
41 TRT_PrepDataToxAOD::TRT_PrepDataToxAOD(const std::string &name, ISvcLocator *pSvcLocator) :
42  AthAlgorithm(name,pSvcLocator)
43 {
44 }
45 
47 //
48 // Initialize method:
49 //
52 {
53  ATH_MSG_DEBUG("Initialize");
54 
55  //Initialize VarHandleKeys
59  ATH_CHECK(m_xAodContainer.initialize());
61 
62  // --- Retrieve services and tools
63  CHECK ( detStore()->retrieve(m_TRTHelper, "TRT_ID") );
64 
65  CHECK ( detStore()->retrieve(m_trtman, "TRT") );
66 
67  CHECK ( m_neighbourSvc.retrieve() );
68 
69  CHECK ( m_trtcaldbTool.retrieve() );
70 
71  CHECK ( m_TRTStrawSummaryTool.retrieve() );
72 
73  CHECK( m_driftFunctionTool.retrieve() );
74 
75  return StatusCode::SUCCESS;
76 }
77 
79 //
80 // Execute method:
81 //
84 {
85  //This is needed for the algorithm. If not there, it fails
86 
88  if (not h_trtPrds.isValid()) {
89  ATH_MSG_ERROR("Cannot retrieve TRT PrepDataContainer " << m_driftcirclecontainer.key());
90  return StatusCode::FAILURE;
91  }
92 
93  //This is optional for the algorithm. If not there, just print a one-time warning
94  // On ESD
95 
96  const PRD_MultiTruthCollection* prdmtColl = nullptr; // to be used in the loop later
97  if (m_useTruthInfo && (!m_multiTruth.key().empty()) ) {
99  if (not h_prdmtColl.isValid()){
100  if (m_firstEventWarnings) {
101  ATH_MSG_WARNING("PRD MultiTruth collection not available (" << m_multiTruth.key() << "). Skipping this info although requested.");}
102  } else {
103  prdmtColl = h_prdmtColl.cptr();
104  }
105  }
106 
107  //This is optional for the algorithm. If not there, just print a one-time warning
108  // On RDO
109 
110  const InDetSimDataCollection* sdoCollection = nullptr; // to be used in the loop later
111  if (m_writeSDOs && m_useTruthInfo && (!m_SDOcontainer.key().empty()) ) {
113  if (not h_sdoCollection.isValid()) {
115  ATH_MSG_WARNING("SDO Collection not available (" << m_SDOcontainer.key() << "). Skipping this info although requested.");}
116  } else{
117  sdoCollection = h_sdoCollection.cptr();
118  }
119  }
120 
121 
122  // Create the xAOD container and its auxiliary store:
124  ATH_CHECK(xaod.record(std::make_unique<xAOD::TrackMeasurementValidationContainer>(),std::make_unique<xAOD::TrackMeasurementValidationAuxContainer>() ) );
125 
127  ATH_CHECK(offsets.record(std::make_unique<std::vector<unsigned int>>(m_TRTHelper->straw_layer_hash_max() , 0) ));
128 
129  InDet::TRT_DriftCircleContainer::const_iterator it = h_trtPrds->begin();
130  InDet::TRT_DriftCircleContainer::const_iterator it_end = h_trtPrds->end();
131  unsigned int counter(0);
132  for( ; it!=it_end; ++it ) {
133 
134  //Fill Offset container
135  if( m_TRTHelper->straw_layer_hash_max() <= (*it)->identifyHash() )
136  ATH_MSG_ERROR("My assumption about the maximum size of the hash was wrong");
137  (*offsets)[ (*it)->identifyHash() ] = counter;
138 
139  // skip empty collections
140  if( (*it)->empty() ) continue;
141 
142  // loop over collection and convert to xAOD
143  for( const auto prd : **it ){
144 
145  ++counter;
146 
147  // create and add xAOD object
149  xaod->push_back(xprd);
150 
151  Identifier surfaceID = prd->identify();
152 
153  xprd->setIdentifier(surfaceID.get_compact());
154 
155 
156  // Save ID info:
157  AUXDATA(xprd, int, bec) = m_TRTHelper->barrel_ec( surfaceID ) ;
158  AUXDATA(xprd, int, layer) = m_TRTHelper->layer_or_wheel(surfaceID ) ;
159  AUXDATA(xprd, int, phi_module) = m_TRTHelper->phi_module( surfaceID ) ;
160  AUXDATA(xprd, int, strawlayer) = m_TRTHelper->straw_layer( surfaceID ) ;
161  AUXDATA(xprd, int, strawnumber) = m_TRTHelper->straw( surfaceID ) ;
162  const InDetDD::TRT_BaseElement* element = m_trtman->getElement(surfaceID);
163  AUXDATA(xprd, float, strawphi) = element->center(surfaceID).phi();
164 
165  int chip=0;
166  int board=-1;
167  m_neighbourSvc->getChip(surfaceID,chip);
168  if(abs(m_TRTHelper->barrel_ec(surfaceID))<2)
169  board=m_neighbourSvc->chipToBoardBarrel(chip,m_TRTHelper->layer_or_wheel(surfaceID));
170  else if (chip<12)
171  board=0;
172  else {
173  chip=chip-20;
174  board=1;
175  }
176  AUXDATA(xprd, int, TRTboard) = board ;
177  AUXDATA(xprd, int, TRTchip) = chip ;
178 
179 
180  //Set Local Position
181  const Amg::Vector2D& locpos = prd->localPosition();
182  float locY(0.);
183  float locX = locpos.x();
184  if ( !(std::isinf(locpos.y()) || std::isnan(locpos.y())) ){
185  if (locpos.y()>=1e-07)
186  locY=locpos.y();
187  } else {
188  locY = -9999.;
189  }
190 
191  // Set local error matrix
192  xprd->setLocalPosition(locX,locY);
193 
194  const Amg::MatrixX& localCov = prd->localCovariance();
195  if(localCov.size() == 1){
196  xprd->setLocalPositionError( sqrt(localCov(0,0)), 0., 0. );
197  } else if(localCov.size() == 2){
198  xprd->setLocalPositionError( sqrt(localCov(0,0)), sqrt(localCov(1,1)), sqrt(localCov(0,1)) );
199  } else {
200  xprd->setLocalPositionError(0.,0.,0.);
201  }
202 
203 
204  //Set Global position
205  const Amg::Vector3D gpos = prd->detectorElement()->surface(surfaceID).localToGlobal(prd->localPosition());
206  xprd->setGlobalPosition(gpos.x(),gpos.y(),gpos.z());
207 
208 
209  //TRT hit bit word
210  unsigned int word = prd->getWord();
211 
212 
213  double tot = prd->timeOverThreshold();
214  bool isvalid=false;
215  AUXDATA(xprd, float, drifttime) = prd->driftTime(isvalid) ;
216  AUXDATA(xprd, int, status) = isvalid;
217  AUXDATA(xprd, float, tot) = tot ;
218  AUXDATA(xprd, char, isHT) = prd->highLevel() ;
219  AUXDATA(xprd, float, T0) = m_trtcaldbTool->getT0(surfaceID) ;
220 
221 
222  // Save time info:
223  AUXDATA(xprd, float, leadingEdge) = prd->rawDriftTime();
224 
225  //Drift Time corrections
226  AUXDATA(xprd, float, driftTimeToTCorrection) = m_driftFunctionTool->driftTimeToTCorrection(tot,surfaceID);
227  if(prd->highLevel()) {
228  AUXDATA(xprd, float, driftTimeHTCorrection) = m_driftFunctionTool->driftTimeHTCorrection(surfaceID);
229  }
230  else {
231  AUXDATA(xprd, float, driftTimeHTCorrection) = 0;
232  }
233 
234 
235  //HT Bit patterens
236  unsigned int theWord = word & 0x04020100; //HT bits mask
237  char highThreshold = 0;
238  //this is the agreed-upon binning for HT bit patterns...
239  if (theWord == 0x04000000) //pattern 1
240  highThreshold = 1;
241  else if (theWord == 0x00020000) //pattern 2
242  highThreshold = 2;
243  else if (theWord == 0x00000100) //pattern 3
244  highThreshold = 3;
245  else if (theWord == 0x04020000) //pattern 4
246  highThreshold = 4;
247  else if (theWord == 0x00020100) //pattern 5
248  highThreshold = 5;
249  else if (theWord == 0x04000100) //pattern 6
250  highThreshold = 6;
251  else if (theWord == 0x04020100) //pattern 7
252  highThreshold = 7;
253 
254  AUXDATA(xprd, char, highThreshold) = highThreshold;
255 
256  //Full bit patternword from the TRT
257  AUXDATA(xprd, unsigned int, bitPattern) = word;
258 
259  char gas_type = kUnset;
260  if (!m_TRTStrawSummaryTool.empty()) {
261  int stat = m_TRTStrawSummaryTool->getStatusHT(surfaceID, Gaudi::Hive::currentContext());
262 
263  if ( stat==1 || stat==4 ) { gas_type = kArgon; }
264  else if ( stat==5 ) { gas_type = kKrypton; }
265  else if ( stat==2 || stat==3 ) { gas_type = kXenon; }
266  else if ( stat==6 ) gas_type = kEmAr;
267  else if ( stat==7 ) gas_type = kEmKr;
268  }
269  AUXDATA(xprd, char, gasType) = gas_type;
270 
271  // Use the MultiTruth Collection to get a list of all true particle contributing to the DC
272  if (m_useTruthInfo){
273  if(prdmtColl){
274  std::vector<int> uniqueIDs;
275  auto range = prdmtColl->equal_range(surfaceID);
276  for (auto i = range.first; i != range.second; ++i) {
277  uniqueIDs.push_back( HepMC::uniqueID(i->second) );
278  }
279  AUXDATA(xprd, std::vector<int> , truth_barcode) = uniqueIDs; // TODO rename variable to be consistent?
280  }
281  }
282  if (m_writeSDOs) {
283  if(sdoCollection){
284  // find hit
285  auto pos = sdoCollection->find(surfaceID);
286  int sdo_word = -1000000;
287  if( pos != sdoCollection->end() ) {
288  sdo_word = pos->second.word();
289  }
290  AUXDATA(xprd, int, sdo_word) = sdo_word;
291  }
292  }
293 
294  }
295  }
296  ATH_MSG_DEBUG( " recorded TRT_PrepData obejcts: size " << xaod->size() );
297 
298 
299 
300  // Code to test that something was added to SG:
301  StatusCode sc = StatusCode::SUCCESS;
302 
303  // --- end of event. Disable one-time warnings
304  m_firstEventWarnings = false;
305 
306  return sc;
307 }
308 
310 //
311 // Finalize method:
312 //
315 {
316  return StatusCode::SUCCESS;
317 }
TRT_PrepDataToxAOD::TRT_PrepDataToxAOD
TRT_PrepDataToxAOD(const std::string &name, ISvcLocator *pSvcLocator)
Definition: TRT_PrepDataToxAOD.cxx:41
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
AllowedVariables::e
e
Definition: AsgElectronSelectorTool.cxx:37
Amg::MatrixX
Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > MatrixX
Dynamic Matrix - dynamic allocation.
Definition: EventPrimitives.h:27
Trk::locX
@ locX
Definition: ParamDefs.h:37
Trk::locY
@ locY
local cartesian
Definition: ParamDefs.h:38
SG::ReadHandle::cptr
const_pointer_type cptr()
Dereference the pointer.
Surface.h
TRT_PrepDataToxAOD::m_driftcirclecontainer
SG::ReadHandleKey< InDet::TRT_DriftCircleContainer > m_driftcirclecontainer
Definition: TRT_PrepDataToxAOD.h:59
ParticleGun_SamplingFraction.bec
int bec
Definition: ParticleGun_SamplingFraction.py:89
make_unique
std::unique_ptr< T > make_unique(Args &&... args)
Definition: SkimmingToolEXOT5.cxx:23
Amg::Vector2D
Eigen::Matrix< double, 2, 1 > Vector2D
Definition: GeoPrimitives.h:48
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:67
TrackMeasurementValidationAuxContainer.h
xAOD::TrackMeasurementValidation
TrackMeasurementValidation_v1 TrackMeasurementValidation
Reference the current persistent version:
Definition: TrackMeasurementValidation.h:13
TRT_PrepDataToxAOD::m_firstEventWarnings
bool m_firstEventWarnings
Definition: TRT_PrepDataToxAOD.h:75
PRD_MultiTruthCollection
A PRD is mapped onto all contributing particles.
Definition: PRD_MultiTruthCollection.h:24
TRT_PrepDataToxAOD::m_trtman
const InDetDD::TRT_DetectorManager * m_trtman
Definition: TRT_PrepDataToxAOD.h:72
AUXDATA
#define AUXDATA(OBJ, TYP, NAME)
Definition: TRT_PrepDataToxAOD.cxx:33
skel.it
it
Definition: skel.GENtoEVGEN.py:407
TRT_ID.h
This is an Identifier helper class for the TRT subdetector. This class is a factory for creating comp...
Identifier::get_compact
value_type get_compact() const
Get the compact id.
InDetSimDataCollection
Definition: InDetSimDataCollection.h:25
TRT_PrepDataToxAOD::m_TRTHelper
const TRT_ID * m_TRTHelper
Definition: TRT_PrepDataToxAOD.h:71
SG::VarHandleKey::key
const std::string & key() const
Return the StoreGate ID for the referenced object.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:141
TRT_PrepDataToxAOD::m_multiTruth
SG::ReadHandleKey< PRD_MultiTruthCollection > m_multiTruth
Definition: TRT_PrepDataToxAOD.h:60
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore
const ServiceHandle< StoreGateSvc > & detStore() const
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:95
TRT_PrepDataToxAOD::m_SDOcontainer
SG::ReadHandleKey< InDetSimDataCollection > m_SDOcontainer
Definition: TRT_PrepDataToxAOD.h:61
TRT_PrepDataToxAOD::m_neighbourSvc
ServiceHandle< ITRT_StrawNeighbourSvc > m_neighbourSvc
Definition: TRT_PrepDataToxAOD.h:69
xAOD::TrackMeasurementValidation_v1
Class describing a TrackMeasurementValidation.
Definition: TrackMeasurementValidation_v1.h:27
WriteHandle.h
Handle class for recording to StoreGate.
TRT_PrepDataToxAOD::kXenon
@ kXenon
Definition: TRT_PrepDataToxAOD.h:43
TRT_ID::straw
int straw(const Identifier &id) const
Definition: TRT_ID.h:896
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
xAOD::TrackMeasurementValidation_v1::setLocalPosition
void setLocalPosition(float localX, float localY)
Sets the local position.
lumiFormat.i
int i
Definition: lumiFormat.py:85
TRT_PrepDataToxAOD::initialize
virtual StatusCode initialize()
Definition: TRT_PrepDataToxAOD.cxx:51
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
TRT_PrepDataToxAOD::m_TRTStrawSummaryTool
ToolHandle< ITRT_StrawStatusSummaryTool > m_TRTStrawSummaryTool
Definition: TRT_PrepDataToxAOD.h:70
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
TRT::Hit::layer
@ layer
Definition: HitInfo.h:79
TRT_PrepDataToxAOD::kEmKr
@ kEmKr
Definition: TRT_PrepDataToxAOD.h:43
HepMC::uniqueID
int uniqueID(const T &p)
Definition: MagicNumbers.h:116
plotBeamSpotVxVal.range
range
Definition: plotBeamSpotVxVal.py:194
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
CHECK
#define CHECK(...)
Evaluate an expression and check for errors.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:422
TRT_PrepDataToxAOD::finalize
virtual StatusCode finalize()
Definition: TRT_PrepDataToxAOD.cxx:314
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
TRT_ID::barrel_ec
int barrel_ec(const Identifier &id) const
Values of different levels (failure returns 0)
Definition: TRT_ID.h:860
TRT_ID::straw_layer
int straw_layer(const Identifier &id) const
Definition: TRT_ID.h:887
xAOD::TrackMeasurementValidation_v1::setIdentifier
void setIdentifier(uint64_t identifier)
Sets the identifier.
TRT_PrepDataToxAOD::execute
virtual StatusCode execute()
Definition: TRT_PrepDataToxAOD.cxx:83
TRT_ID::layer_or_wheel
int layer_or_wheel(const Identifier &id) const
Definition: TRT_ID.h:878
beamspotman.stat
stat
Definition: beamspotman.py:264
AthAlgorithm
Definition: AthAlgorithm.h:47
SG::ReadHandle::isValid
virtual bool isValid() override final
Can the handle be successfully dereferenced?
TRT_PrepDataToxAOD::m_useTruthInfo
Gaudi::Property< bool > m_useTruthInfo
Definition: TRT_PrepDataToxAOD.h:55
TRT_PrepDataToxAOD::m_xAodOffset
SG::WriteHandleKey< std::vector< unsigned int > > m_xAodOffset
Definition: TRT_PrepDataToxAOD.h:63
TRT_DriftCircleContainer.h
xAOD::TrackMeasurementValidation_v1::setGlobalPosition
void setGlobalPosition(float globalX, float globalY, float globalZ)
Sets the global position.
Definition: TrackMeasurementValidation_v1.cxx:50
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
InDetDD::TRT_DetectorManager::getElement
const TRT_BaseElement * getElement(Identifier id) const
Access Elements Generically---------------------------------------------—.
Definition: TRT_DetectorManager.cxx:145
xAOD::TrackMeasurementValidation_v1::setLocalPositionError
void setLocalPositionError(float localXError, float localYError, float localXYCorrelation)
Sets the local position error.
Definition: TrackMeasurementValidation_v1.cxx:37
DataVector::push_back
value_type push_back(value_type pElem)
Add an element to the end of the collection.
Amg::Vector3D
Eigen::Matrix< double, 3, 1 > Vector3D
Definition: GeoPrimitives.h:47
TRT_ID::phi_module
int phi_module(const Identifier &id) const
Definition: TRT_ID.h:869
TRT_PrepDataToxAOD::kEmAr
@ kEmAr
Definition: TRT_PrepDataToxAOD.h:43
python.LumiBlobConversion.pos
pos
Definition: LumiBlobConversion.py:16
TRT_PrepDataToxAOD::m_trtcaldbTool
ToolHandle< ITRT_CalDbTool > m_trtcaldbTool
Definition: TRT_PrepDataToxAOD.h:68
SG::WriteHandle
Definition: StoreGate/StoreGate/WriteHandle.h:73
TRTUncompressedHitCollection.h
SG::WriteHandle::record
StatusCode record(std::unique_ptr< T > data)
Record a const object to the store.
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
InDetSimDataCollection.h
InDetDD::TRT_BaseElement::center
virtual const Amg::Vector3D & center() const override final
Element Surface: center of a straw layer.
TrackMeasurementValidation.h
TRT_PrepDataToxAOD::m_xAodContainer
SG::WriteHandleKey< xAOD::TrackMeasurementValidationContainer > m_xAodContainer
Definition: TRT_PrepDataToxAOD.h:62
PRD_MultiTruthCollection.h
TRT_PrepDataToxAOD::kArgon
@ kArgon
Definition: TRT_PrepDataToxAOD.h:43
TrackMeasurementValidationContainer.h
merge.status
status
Definition: merge.py:16
ReadHandle.h
Handle class for reading from StoreGate.
TRT_PrepDataToxAOD::m_driftFunctionTool
ToolHandle< ITRT_DriftFunctionTool > m_driftFunctionTool
Definition: TRT_PrepDataToxAOD.h:67
TRT_ID::straw_layer_hash_max
size_type straw_layer_hash_max() const
Definition: TRT_ID.h:914
TRT_PrepDataToxAOD.h
test_pyathena.counter
counter
Definition: test_pyathena.py:15
TRT_PrepDataToxAOD::m_writeSDOs
Gaudi::Property< bool > m_writeSDOs
Definition: TRT_PrepDataToxAOD.h:56
DataVector::size
size_type size() const noexcept
Returns the number of elements in the collection.
TRT_PrepDataToxAOD::kUnset
@ kUnset
Definition: TRT_PrepDataToxAOD.h:43
InDetDD::TRT_BaseElement
Definition: TRT_BaseElement.h:52
Identifier
Definition: IdentifierFieldParser.cxx:14
TRT_PrepDataToxAOD::kKrypton
@ kKrypton
Definition: TRT_PrepDataToxAOD.h:43