ATLAS Offline Software
BadLArRetriever.cxx
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 #include "BadLArRetriever.h"
6 
7 #include "AthenaKernel/Units.h"
8 
11 
12 #include "CaloDetDescr/CaloDetDescrElement.h"
19 
20 using Athena::Units::GeV;
21 
22 namespace JiveXML {
23 
30  BadLArRetriever::BadLArRetriever(const std::string& type,const std::string& name,const IInterface* parent):
32  m_calocell_id(nullptr)
33  {
34  //Only declare the interface
35  declareInterface<IDataRetriever>(this);
36 
37  declareInterface<IDataRetriever>(this);
38  declareProperty("LArlCellThreshold", m_cellThreshold = 50.);
39  declareProperty("RetrieveLAr" , m_lar = true);
40  declareProperty("DoBadLAr", m_doBadLAr = false);
41  declareProperty("CellConditionCut", m_cellConditionCut = false);
42 
43  declareProperty("CellEnergyPrec", m_cellEnergyPrec = 3);
44  }
45 
51 
52  ATH_MSG_DEBUG( "Initialising Tool" );
53  ATH_CHECK( detStore()->retrieve (m_calocell_id, "CaloCell_ID") );
54 
57 
58  return StatusCode::SUCCESS;
59  }
60 
64  StatusCode BadLArRetriever::retrieve(ToolHandle<IFormatTool> &FormatTool) {
65 
66  ATH_MSG_DEBUG( "in retrieve()" );
67 
69  if (!cellContainer.isValid()){
70  ATH_MSG_WARNING( "Could not retrieve Calorimeter Cells " );
71  }
72  else{
73  if(m_lar){
74  DataMap data = getBadLArData(&(*cellContainer));
75  ATH_CHECK( FormatTool->AddToEvent(dataTypeName(), m_sgKey.key(), &data) );
76  ATH_MSG_DEBUG( "Bad LAr retrieved" );
77  }
78  }
79 
80  //LAr cells retrieved okay
81  return StatusCode::SUCCESS;
82  }
83 
84 
90 
91  ATH_MSG_DEBUG( "getBadLArData()" );
92 
94  const auto nCells = cellContainer->size();
95  DataVect phi; phi.reserve(nCells);
96  DataVect eta; eta.reserve(nCells);
97  DataVect energy; energy.reserve(nCells);
98  DataVect idVec; idVec.reserve(nCells);
99  DataVect channel; channel.reserve(nCells);
100  DataVect feedThrough; feedThrough.reserve(nCells);
101  DataVect slot; slot.reserve(nCells);
102 
103 
104  char rndStr[30]; // for rounding (3 digit precision)
108  const LArOnOffIdMapping* cabling{*cablingHdl};
109  const LArOnlineID* onlineId = nullptr;
110  if ( detStore()->retrieve(onlineId, "LArOnlineID").isFailure()) {
111  ATH_MSG_ERROR( "in getBadLArData(),Could not get LArOnlineID!" );
112  }
113 
114  if (m_doBadLAr && cabling) {
115  double energyGeV;
116  ATH_MSG_DEBUG( "Start iterator loop over cells" );
117  for(;it1!=it2;++it1){
118  if( !(*it1)->badcell() ) continue;
119  if ((((*it1)->provenance()&0xFF)!=0xA5)&&m_cellConditionCut) continue; // check full conditions for LAr
120  HWIdentifier LArhwid = cabling->createSignalChannelIDFromHash((*it1)->caloDDE()->calo_hash());
121  energyGeV = (*it1)->energy()*(1./GeV);
122  if (energyGeV == 0) energyGeV = 0.001; // 1 MeV due to LegoCut > 0.0 (couldn't be >= 0.0)
123 
124  energy.emplace_back( gcvt( energyGeV, m_cellEnergyPrec, rndStr) );
125  idVec.emplace_back((Identifier::value_type)(*it1)->ID().get_compact() );
126  phi.emplace_back((*it1)->phi());
127  eta.emplace_back((*it1)->eta());
128  channel.emplace_back(onlineId->channel(LArhwid));
129  feedThrough.emplace_back(onlineId->feedthrough(LArhwid));
130  slot.emplace_back(onlineId->slot(LArhwid));
131  } // end cell iterator
132  } // doBadLAr
133  // write values into DataMap
134  const auto nEntries = phi.size();
135  DataMap["phi"] = std::move(phi);
136  DataMap["eta"] = std::move(eta);
137  DataMap["energy"] = std::move(energy);
138  DataMap["id"] = std::move(idVec);
139  DataMap["channel"] = std::move(channel);
140  DataMap["feedThrough"] = std::move(feedThrough);
141  DataMap["slot"] = std::move(slot);
142  //Be verbose
143  ATH_MSG_DEBUG( dataTypeName() << " , collection: " << dataTypeName()
144  << " retrieved with " << nEntries << " entries" );
145 
146  //All collections retrieved okay
147  return DataMap;
148 
149  } // getBadLArData
150 
151  //--------------------------------------------------------------------------
152 
153 } // JiveXML namespace
data
char data[hepevt_bytes_allocation_ATLAS]
Definition: HepEvt.cxx:11
GeV
#define GeV
Definition: PhysicsAnalysis/TauID/TauAnalysisTools/Root/HelperFunctions.cxx:17
DataModel_detail::const_iterator
Const iterator class for DataVector/DataList.
Definition: DVLIterator.h:82
plotting.yearwise_efficiency.channel
channel
Definition: yearwise_efficiency.py:24
SG::ReadCondHandle
Definition: ReadCondHandle.h:44
JiveXML::BadLArRetriever::m_cellEnergyPrec
int m_cellEnergyPrec
Definition: BadLArRetriever.h:64
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:70
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
JiveXML::DataVect
std::vector< DataType > DataVect
Defines a map with a key and a vector of DataType objects e.g.
Definition: DataType.h:58
JiveXML::BadLArRetriever::m_cellThreshold
double m_cellThreshold
Definition: BadLArRetriever.h:63
ReadCellNoiseFromCool.cabling
cabling
Definition: ReadCellNoiseFromCool.py:154
CaloCellContainer::beginConstCalo
CaloCellContainer::const_iterator beginConstCalo(CaloCell_ID::SUBCALO caloNum) const
get const iterators on cell of just one calo
Definition: CaloCellContainer.cxx:119
LArOnlineID_Base::slot
int slot(const HWIdentifier id) const
Return the slot number of a hardware cell identifier: slot = [1,15] Slot-ID in top part of the crat...
Definition: LArOnlineID_Base.cxx:1957
JiveXML::BadLArRetriever::getBadLArData
const DataMap getBadLArData(const CaloCellContainer *cellContainer)
Retrieve LAr bad cell location and details.
Definition: BadLArRetriever.cxx:89
JiveXML::BadLArRetriever::m_calocell_id
const CaloCell_ID * m_calocell_id
Definition: BadLArRetriever.h:58
SG::VarHandleKey::key
const std::string & key() const
Return the StoreGate ID for the referenced object.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:141
JiveXML::DataMap
std::map< std::string, DataVect > DataMap
Definition: DataType.h:59
HWIdentifier
Definition: HWIdentifier.h:13
CaloCell_ID.h
AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore
const ServiceHandle< StoreGateSvc > & detStore() const
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:95
LArOnlineID_Base::channel
int channel(const HWIdentifier id) const
Return the channel number of a hardware cell identifier channel = [0,127] in all FEB.
Definition: LArOnlineID_Base.cxx:1963
JiveXML::BadLArRetriever::m_cablingKey
SG::ReadCondHandleKey< LArOnOffIdMapping > m_cablingKey
Definition: BadLArRetriever.h:59
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
JiveXML::BadLArRetriever::m_cellConditionCut
bool m_cellConditionCut
Definition: BadLArRetriever.h:67
ParticleGun_FastCalo_ChargeFlip_Config.energy
energy
Definition: ParticleGun_FastCalo_ChargeFlip_Config.py:78
xAOD::nCells
setRawEt setRawPhi nCells
Definition: TrigCaloCluster_v1.cxx:33
JiveXML::BadLArRetriever::BadLArRetriever
BadLArRetriever(const std::string &type, const std::string &name, const IInterface *parent)
Standard Constructor.
Definition: BadLArRetriever.cxx:30
DetDescrDictionaryDict::it1
std::vector< HWIdentifier >::iterator it1
Definition: DetDescrDictionaryDict.h:17
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
test_pyathena.parent
parent
Definition: test_pyathena.py:15
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
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
SG::ReadHandle::isValid
virtual bool isValid() override final
Can the handle be successfully dereferenced?
JiveXML
This header is shared inbetween the C-style server thread and the C++ Athena ServerSvc.
Definition: BadLArRetriever.cxx:22
LArRawChannel.h
HWIdentifier.h
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
SG::CondHandleKey::initialize
StatusCode initialize(bool used=true)
LArOnlineID
Definition: LArOnlineID.h:20
Units.h
Wrapper to avoid constant divisions when using units.
JiveXML::BadLArRetriever::m_sgKey
SG::ReadHandleKey< CaloCellContainer > m_sgKey
for properties
Definition: BadLArRetriever.h:62
LArDigitContainer.h
CaloCellContainer
Container class for CaloCell.
Definition: CaloCellContainer.h:55
JiveXML::BadLArRetriever::dataTypeName
virtual std::string dataTypeName() const
Return the name of the data type.
Definition: BadLArRetriever.h:52
JiveXML::BadLArRetriever::m_lar
bool m_lar
Definition: BadLArRetriever.h:65
LArOnlineID_Base::feedthrough
int feedthrough(const HWIdentifier id) const
Return the feedthrough of a hardware cell identifier : feedthrough = [0,31] Barrel - A/C side or H/...
Definition: LArOnlineID_Base.cxx:1944
JiveXML::BadLArRetriever::m_doBadLAr
bool m_doBadLAr
Definition: BadLArRetriever.h:66
ILArPedestal.h
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
JiveXML::BadLArRetriever::retrieve
virtual StatusCode retrieve(ToolHandle< IFormatTool > &FormatTool)
Retrieve all the data.
Definition: BadLArRetriever.cxx:64
CaloCellContainer::endConstCalo
CaloCellContainer::const_iterator endConstCalo(CaloCell_ID::SUBCALO caloNum) const
Definition: CaloCellContainer.cxx:133
Identifier::value_type
unsigned long long value_type
Definition: DetectorDescription/Identifier/Identifier/Identifier.h:27
SelectAllObject.h
AthAlgTool
Definition: AthAlgTool.h:26
CaloCell_Base_ID::LAREM
@ LAREM
Definition: CaloCell_Base_ID.h:46
dqBeamSpot.nEntries
int nEntries
Definition: dqBeamSpot.py:73
BadLArRetriever.h
DataVector::size
size_type size() const noexcept
Returns the number of elements in the collection.
LArRawChannelContainer.h
LArOnlineID.h
JiveXML::BadLArRetriever::initialize
StatusCode initialize()
Default AthAlgTool methods.
Definition: BadLArRetriever.cxx:50
LArOnOffIdMapping
Definition: LArOnOffIdMapping.h:20