|
ATLAS Offline Software
|
#include <MmFastDigiTool.h>
|
StatusCode | digitize (const EventContext &ctx, const TimedHits &hitsToDigit, xAOD::MuonSimHitContainer *sdoContainer) const override final |
| Digitize the time ordered hits and write them to the digit format specific for the detector technology. More...
|
|
CLHEP::HepRandomEngine * | getRandomEngine (const EventContext &ctx) const |
|
xAOD::MuonSimHit * | addSDO (const TimedHit &hit, xAOD::MuonSimHitContainer *sdoContainer) const |
| Adds the timed simHit to the output SDO container. More...
|
|
const ActsGeometryContext & | getGeoCtx (const EventContext &ctx) const |
| Returns the reference to the ActsGeometryContext needed to fetch global positions from the Readout geometry. More...
|
|
template<class Container > |
StatusCode | retrieveContainer (const EventContext &ctx, const SG::ReadHandleKey< Container > &key, const Container *&contPtr) const |
| Helper function to retrieve a container from StoreGate. More...
|
|
template<class Container > |
StatusCode | retrieveConditions (const EventContext &ctx, const SG::ReadCondHandleKey< Container > &key, const Container *&contPtr) const |
| Helper function to access the conditions data. More...
|
|
template<class DigitColl > |
DigitColl * | fetchCollection (const Identifier &hitId, OutDigitCache_t< DigitColl > &digitCache) const |
| Helper function that provides fetches the proper DigitCollection from the DigitCache for a given hit identifier If the Collection is fetched for the first time, it's inserted into the cache first. More...
|
|
template<class DigitCont , class DigitColl > |
StatusCode | writeDigitContainer (const EventContext &ctx, const SG::WriteHandleKey< DigitCont > &key, OutDigitCache_t< DigitColl > &&digitCache, unsigned int hashMax) const |
| Helper function to move the collected digits into the final DigitContainer. More...
|
|
|
SG::WriteHandleKey< MmDigitContainer > | m_writeKey {this, "OutputObjectName", "MM_DIGITS"} |
|
SG::ReadCondHandleKey< Muon::DigitEffiData > | m_effiDataKey |
|
SG::ReadCondHandleKey< NswErrorCalibData > | m_uncertCalibKey |
|
std::array< std::atomic< unsigned >, 8 > m_allHits | ATLAS_THREAD_SAFE {} |
|
std::array< std::atomic< unsigned >, 8 > m_acceptedHits | ATLAS_THREAD_SAFE {} |
|
Gaudi::Property< double > | m_deadTime {this, "deadTime", 300. * Gaudi::Units::ns} |
|
Gaudi::Property< bool > | m_digitizeMuonOnly |
|
SG::ReadHandleKey< xAOD::MuonSimHitContainer > | m_simHitKey {this, "SimHitKey", ""} |
|
SG::ReadHandleKey< ActsGeometryContext > | m_geoCtxKey |
|
ServiceHandle< PileUpMergeSvc > | m_mergeSvc {this, "PileUpMergeSvc", "PileUpMergeSvc", ""} |
|
Gaudi::Property< std::string > | m_streamName {this, "StreamName", ""} |
|
ServiceHandle< IAthRNGSvc > | m_rndmSvc {this, "RndmSvc", "AthRNGSvc", ""} |
|
SG::WriteHandleKey< xAOD::MuonSimHitContainer > | m_sdoKey {this, "OutputSDOName", ""} |
|
Gaudi::Property< bool > | m_onlyUseContainerName |
|
Gaudi::Property< bool > | m_includePileUpTruth {this, "IncludePileUpTruth", true, "Include pile-up truth info"} |
|
std::string | m_inputObjectName {""} |
|
TimedHits | m_timedHits {} |
|
std::vector< SimHitLocalCopy > | m_simHits {} |
|
Definition at line 18 of file MmFastDigiTool.h.
◆ DeadTimeMap
◆ DigiCache
◆ OutDigitCache_t
DigitContainers are sorted by DigitCollections which are the ensemble of all hits in a given MuonChamber.
To fill the final DigitContainer thread-safely, the DigitCollections shall be cached pre cached in a OutDigitCache_t vector which is later moved to the final DigitContainer
Definition at line 109 of file MuonDigitizationTool.h.
◆ PileUpHits
◆ SimHitLocalCopy
Create a local copy of the sim hits to ensure overlayed hits across the events remain valid.
Definition at line 172 of file MuonDigitizationTool.h.
◆ TimedHit
◆ TimedHits
◆ MmFastDigiTool()
MuonR4::MmFastDigiTool::MmFastDigiTool |
( |
const std::string & |
type, |
|
|
const std::string & |
name, |
|
|
const IInterface * |
pIID |
|
) |
| |
◆ addSDO()
Adds the timed simHit to the output SDO container.
The hit may be rejected if it's originating from pile-up and the pile-up truth skimming strategy is applied
Definition at line 148 of file MuonDigitizationTool.cxx.
164 acc_eventTime(*sdoHit) = hit.eventTime();
165 acc_eventID(*sdoHit) = hit.eventId();
166 acc_puType(*sdoHit) = hit.pileupType();
◆ digitize()
|
finaloverrideprotectedvirtual |
Digitize the time ordered hits and write them to the digit format specific for the detector technology.
A new MuonSimHitContainer pointer is parsed to also create the MuonSDO. If a new SDO should be added to the container plese use the addSDO() method as defined below.
Fetch the conditions for efficiency calculations
Calculate the index for the global hit counter
Reject hit within the dead time interval
Pipe some dummy values to the digit to ensure that the pdo / tdo calibration does not reject any hit downstream. Or in other words how much do you want... All charge
We're using the NSW uncertainty DB to smear the truth-hit positions using the best known uncertainties. In the process of digit -> RDO -> PRD, the smeared hit position is gonna be lost However, recall that the simplest way to generate a MM prd from RAW hits is the clustering by means of center of gravity. On average, a muon passage makes 3-4 strips fire. Assuming 3 strips, the smeared position can be written as
x = w_{1}*(c - p) + w_{2}*c + w_{3}*(c + p),
where c is the strip centre, p the pitch and w_{i} are the induced charge fractions on each strip
1 = w_{1} + w_{2} + w_{3}
x = (w_{1} + w_{2} + w_{3}) * c + (w_{3} - w_{1})*p
--> x = c + (w_{3} - w_{1}) *p --> (x-c) / p = (w_{3} - w_{1})
--> (x-c) / p + w_{1} = w_{3}
1 = 2 * w_{1} + w_{2} + (x-c) / p 1 - (x-c) /p - 2*w_{1} = w_{2}
0< w_{1} < 0.5 - (x-c) / 2p
Write everything at the end into the final digit container
Implements MuonR4::MuonDigitizationTool.
Definition at line 38 of file MmFastDigiTool.cxx.
54 for (
const TimedHit& simHit : viewer) {
61 const Amg::Vector2D locPos{xAOD::toEigen(simHit->localPosition()).block<2,1>(0,0)};
64 const unsigned int hitGapInNsw = (idHelper.multilayer(hitId) -1) * 4 + idHelper.gasGap(hitId) -1;
65 ++m_allHits[hitGapInNsw];
70 int channelNumber = design.stripNumber(locPos);
72 if (!design.insideTrapezoid(locPos)) {
74 <<
" is outside bounds "<<std::endl<<design<<
" rejecting it");
78 const Identifier clusId = idHelper.channelID(hitId,
79 idHelper.multilayer(hitId),
80 idHelper.gasGap(hitId),
85 <<
" channel " << channelNumber <<
" locPos " <<
Amg::toString(locPos));
89 if(efficiencyMap && efficiencyMap->getEfficiency(clusId) < CLHEP::RandFlat::shoot(rndEngine, 0., 1.)){
97 errorCalibInput.
stripId = clusId;
98 errorCalibInput.locTheta =
M_PI- simHit->localDirection().theta();
99 errorCalibInput.clusterAuthor=66;
100 const double uncert = errorCalibDB->clusterUncertainty(errorCalibInput);
106 constexpr
int dummyResponseTime = 100;
107 constexpr
float dummyDepositedCharge = 66666;
109 const double newLocalX = CLHEP::RandGaussZiggurat::shoot(rndEngine, locPos.x(), uncert);
110 const int newChannel = design.stripNumber(newLocalX * Amg::Vector2D::UnitX());
111 if (newChannel < 0) {
115 const Identifier digitId = idHelper.channelID(hitId,
116 idHelper.multilayer(hitId),
117 idHelper.gasGap(hitId),
122 <<
" channel " << newChannel <<
" locPos " <<
Amg::toString(locPos));
147 const double pull = (newLocalX - (*design.center(newChannel)).
x()) / (design.stripPitch() *
std::cos(design.stereoAngle()));
148 const double w1 = CLHEP::RandFlat::shoot(rndEngine, 0., 0.5 *(1. -
pull));
149 const double w2 = 1 -
pull -2*w1;
150 const double w3 =
pull + w1;
153 const Identifier digitIdB = idHelper.channelID(hitId,
154 idHelper.multilayer(hitId),
155 idHelper.gasGap(hitId),
159 outColl->
push_back(std::make_unique<MmDigit>(digitIdB, dummyResponseTime, w1 * dummyDepositedCharge));
161 outColl->
push_back(std::make_unique<MmDigit>(digitId,dummyResponseTime, w2 * dummyDepositedCharge));
163 const Identifier digitIdA = idHelper.channelID(hitId,
164 idHelper.multilayer(hitId),
165 idHelper.gasGap(hitId),
168 outColl->
push_back(std::make_unique<MmDigit>(digitIdA, dummyResponseTime, w3 * dummyDepositedCharge));
173 ++m_acceptedHits[hitGapInNsw];
175 }
while(viewer.next());
178 return StatusCode::SUCCESS;
◆ fetchCollection()
template<class DigitColl >
Helper function that provides fetches the proper DigitCollection from the DigitCache for a given hit identifier If the Collection is fetched for the first time, it's inserted into the cache first.
◆ fillTimedHits()
StatusCode MuonR4::MuonDigitizationTool::fillTimedHits |
( |
PileUpHits && |
hitColl, |
|
|
TimedHits & |
timedHits |
|
) |
| const |
|
privateinherited |
Translates the PileUpHits into the timed hits format.
Definition at line 50 of file MuonDigitizationTool.cxx.
51 for (
const auto& [timeIndex, simHitColl] : hitColl) {
52 timedHits.reserve(timedHits.capacity() + simHitColl->size());
54 timedHits.emplace_back(timeIndex.time(), timeIndex.index(), simHit, timeIndex.type());
57 std::sort(timedHits.begin(), timedHits.end(),
59 if (a->identify() != b->identify()){
60 return a->identify() < b->identify();
62 if (
a.eventId() !=
b.eventId()) {
63 return a.eventId() < b.eventId();
65 return a.eventTime() <
b.eventTime();
67 return StatusCode::SUCCESS;
◆ filterPassed()
virtual bool PileUpToolBase::filterPassed |
( |
| ) |
const |
|
inlineoverridevirtualinherited |
◆ finalize()
StatusCode MuonR4::MmFastDigiTool::finalize |
( |
| ) |
|
|
finaloverride |
Definition at line 26 of file MmFastDigiTool.cxx.
27 std::stringstream statstr{};
29 for (
unsigned int g = 0;
g < m_allHits.size(); ++
g) {
30 allHits += m_allHits[
g];
31 statstr<<
" *** Layer "<<(
g+1)<<
" "<<percentage(m_acceptedHits[
g],m_allHits[
g])
32 <<
"% of "<<m_allHits[
g]<<std::endl;
34 if(!allHits)
return StatusCode::SUCCESS;
35 ATH_MSG_INFO(
"Tried to convert "<<allHits<<
" hits. Successes rate per layer "<<std::endl<<statstr.str());
36 return StatusCode::SUCCESS;
◆ getGeoCtx()
◆ getRandomEngine()
CLHEP::HepRandomEngine * MuonR4::MuonDigitizationTool::getRandomEngine |
( |
const EventContext & |
ctx | ) |
const |
|
protectedinherited |
◆ hitTime()
double MuonR4::MuonDigitizationTool::hitTime |
( |
const TimedHit & |
hit | ) |
|
|
staticprotectedinherited |
Returns the global time of the hit which is the sum of eventTime & individual hit time.
Definition at line 69 of file MuonDigitizationTool.cxx.
70 return hit.eventTime() + hit->globalTime();
◆ initialize()
StatusCode MuonR4::MmFastDigiTool::initialize |
( |
| ) |
|
|
finaloverridevirtual |
◆ mergeEvent()
StatusCode MuonR4::MuonDigitizationTool::mergeEvent |
( |
const EventContext & |
ctx | ) |
|
|
finaloverrideinherited |
Definition at line 98 of file MuonDigitizationTool.cxx.
104 ATH_CHECK(sdoContainer.record(std::make_unique<xAOD::MuonSimHitContainer>(),
105 std::make_unique<xAOD::MuonSimHitAuxContainer>()));
110 return StatusCode::SUCCESS;
◆ passDeadTime()
Returns whether the new digit is within the dead time window.
channelId: Identifier of the fired channel
hitTime: Current hit time
deadTimeWindow: Dead time to pass before the next hit may be accepted
deadTimeMap: Map storing the last hit times from each Identifier
Channel not seen before
Update dead time map & accept hit
Definition at line 169 of file MuonDigitizationTool.cxx.
175 if (insertItr.second) {
178 if (
hitTime - insertItr.first->second < deadTimeWindow) {
182 insertItr.first->second =
hitTime;
◆ prepareEvent()
StatusCode MuonR4::MuonDigitizationTool::prepareEvent |
( |
const EventContext & |
ctx, |
|
|
const unsigned int |
nInputEvents |
|
) |
| |
|
finaloverrideinherited |
When being run from PileUpToolsAlgs, this method is called at the start of the subevts loop.
Not able to access SubEvents
Definition at line 41 of file MuonDigitizationTool.cxx.
44 ATH_MSG_DEBUG(
"prepareEvent() called for " << nInputEvents <<
" input events");
47 return StatusCode::SUCCESS;
◆ processAllSubEvents() [1/3]
StatusCode MuonR4::MuonDigitizationTool::processAllSubEvents |
( |
const EventContext & |
ctx | ) |
const |
|
inherited |
Reentrant version of the digitization tool.
In case of single hits container just load the collection using read handles
Definition at line 77 of file MuonDigitizationTool.cxx.
92 ATH_CHECK(sdoContainer.record(std::make_unique<xAOD::MuonSimHitContainer>(),
93 std::make_unique<xAOD::MuonSimHitAuxContainer>()));
96 return StatusCode::SUCCESS;
◆ processAllSubEvents() [2/3]
StatusCode MuonR4::MuonDigitizationTool::processAllSubEvents |
( |
const EventContext & |
ctx | ) |
|
|
finaloverridevirtualinherited |
◆ processAllSubEvents() [3/3]
virtual StatusCode IPileUpTool::processAllSubEvents |
|
inherited |
dummy implementation to allow compilation while all Digitization packages are migrated to use this new interface.
◆ processBunchXing()
|
finaloverridevirtualinherited |
Reimplemented from PileUpToolBase.
Definition at line 114 of file MuonDigitizationTool.cxx.
121 for (
auto& [hitPtr, hitContainer] : hitList) {
122 auto copyContainer = std::make_unique<xAOD::MuonSimHitContainer>();
123 auto copyAuxContainer = std::make_unique<xAOD::MuonSimHitAuxContainer>();
124 copyContainer->setStore(copyAuxContainer.get());
126 (*copyContainer->push_back(std::make_unique<xAOD::MuonSimHit>())) = (*copyMe);
128 hitListPermanent.emplace_back(hitPtr, copyContainer.get());
129 m_simHits.emplace_back(std::move(copyContainer), std::move(copyAuxContainer));
132 return StatusCode::SUCCESS;
◆ resetFilter()
virtual void PileUpToolBase::resetFilter |
( |
| ) |
|
|
inlineoverridevirtualinherited |
◆ retrieveConditions()
template<class Container >
Helper function to access the conditions data.
If the key is empty, the conditions object is assigned to be a nullptr Otherwise, a failure is returned if the Conditions data are not available in the event.
◆ retrieveContainer()
template<class Container >
Helper function to retrieve a container from StoreGate.
If the readHandleKey is empty, the container is assigned to be a nullptr and the operation is marked as success. Otherwise, a failure is returned if the Container cannot be fetched from StoreGate
◆ toProcess()
virtual bool PileUpToolBase::toProcess |
( |
int |
bunchXing | ) |
const |
|
inlineoverridevirtualinherited |
◆ writeDigitContainer()
template<class DigitCont , class DigitColl >
Helper function to move the collected digits into the final DigitContainer.
The function needs the maximal size of the container in advance which is provided by calling the module_hash_max() function of the corresponding MuonIdHelper.
◆ ATLAS_THREAD_SAFE [1/2]
std::array<std::atomic<unsigned>, 8> m_allHits MuonR4::MmFastDigiTool::ATLAS_THREAD_SAFE {} |
|
mutableprivate |
◆ ATLAS_THREAD_SAFE [2/2]
std::array<std::atomic<unsigned>, 8> m_acceptedHits MuonR4::MmFastDigiTool::ATLAS_THREAD_SAFE {} |
|
mutableprivate |
◆ m_deadTime
Gaudi::Property<double> MuonR4::MmFastDigiTool::m_deadTime {this, "deadTime", 300. * Gaudi::Units::ns} |
|
private |
◆ m_detMgr
◆ m_digitizeMuonOnly
Gaudi::Property<bool> MuonR4::MmFastDigiTool::m_digitizeMuonOnly |
|
private |
Initial value:{this, "ProcessTrueMuonsOnly", false,
"If set to true hit with pdgId != 13 are skipped"}
Definition at line 49 of file MmFastDigiTool.h.
◆ m_effiDataKey
Initial value:{this, "EffiDataKey", "MmDigitEff",
"Efficiency constants of the individual Rpc gasGaps"}
Definition at line 36 of file MmFastDigiTool.h.
◆ m_filterPassed
bool PileUpToolBase::m_filterPassed {true} |
|
protectedinherited |
◆ m_firstXing
Gaudi::Property<int> PileUpToolBase::m_firstXing |
|
protectedinherited |
Initial value:{this, "FirstXing", -999,
"First bunch-crossing in which det is live"}
Definition at line 54 of file PileUpToolBase.h.
◆ m_geoCtxKey
Initial value:{this, "AlignmentKey", "ActsAlignment",
"Geometry context"}
Definition at line 152 of file MuonDigitizationTool.h.
◆ m_idHelperSvc
Initial value:{this, "MuonIdHelperSvc",
"Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
Definition at line 142 of file MuonDigitizationTool.h.
◆ m_includePileUpTruth
Gaudi::Property<bool> MuonR4::MuonDigitizationTool::m_includePileUpTruth {this, "IncludePileUpTruth", true, "Include pile-up truth info"} |
|
privateinherited |
◆ m_inputObjectName
std::string MuonR4::MuonDigitizationTool::m_inputObjectName {""} |
|
privateinherited |
◆ m_lastXing
Gaudi::Property<int> PileUpToolBase::m_lastXing |
|
protectedinherited |
Initial value:{this, "LastXing", 999,
"Last bunch-crossing in which det is live"}
Definition at line 56 of file PileUpToolBase.h.
◆ m_mergeSvc
◆ m_onlyUseContainerName
Gaudi::Property<bool> MuonR4::MuonDigitizationTool::m_onlyUseContainerName |
|
privateinherited |
Initial value:{this, "OnlyUseContainerName", false,
"Don't use the ReadHandleKey directly. Just extract the container name from it."}
Definition at line 163 of file MuonDigitizationTool.h.
◆ m_rndmSvc
◆ m_sdoKey
◆ m_simHitKey
◆ m_simHits
◆ m_streamName
Gaudi::Property<std::string> MuonR4::MuonDigitizationTool::m_streamName {this, "StreamName", ""} |
|
privateinherited |
◆ m_timedHits
TimedHits MuonR4::MuonDigitizationTool::m_timedHits {} |
|
privateinherited |
◆ m_uncertCalibKey
Initial value:{this, "ErrorCalibKey", "NswUncertData",
"Key of the parametrized NSW uncertainties"}
Definition at line 39 of file MmFastDigiTool.h.
◆ m_vetoPileUpTruthLinks
Gaudi::Property<int> PileUpToolBase::m_vetoPileUpTruthLinks |
|
protectedinherited |
Initial value:{this, "VetoPileUpTruthLinks", true,
"Ignore links to suppressed pile-up truth"}
Definition at line 58 of file PileUpToolBase.h.
◆ m_writeKey
The documentation for this class was generated from the following files:
void setSeed(const std::string &algName, const EventContext &ctx)
Set the random seed using a string (e.g.
void setIdentifier(const Identifier &id)
Sets the global ATLAS identifier.
Eigen::Matrix< double, 2, 1 > Vector2D
#define ATH_MSG_VERBOSE(x)
bool isValid(const T &p)
Av: we implement here an ATLAS-sepcific convention: all particles which are 99xxxxx are fine.
#define THROW_EXCEPTION(MSG)
bool empty() const
Test if the key is blank.
bool ignoreTruthLink(const T &p, bool vetoPileUp)
Helper function for SDO creation in PileUpTools.
std::string toString(const Translation3D &translation, int precision=4)
GeoPrimitvesToStringConverter.
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
Include the GeoPrimitives which need to be put first.
const StripLayer & stripLayer(const Identifier &measId) const
A wrapper class for event-slot-local random engines.
value_type push_back(value_type pElem)
Add an element to the end of the collection.
StatusCode initialize(bool used=true)
CLHEP::HepRandomEngine * getEngine(const EventContext &ctx) const
Retrieve the random engine corresponding to the provided EventContext.
const StripDesign & design() const
Returns the underlying strip design.
void sort(typename std::reverse_iterator< DataModel_detail::iterator< DVL > > beg, typename std::reverse_iterator< DataModel_detail::iterator< DVL > > end, const Compare &comp)
Specialization of sort for DataVector/List.
#define ATH_MSG_WARNING(x)
a struct encapsulating the identifier of a pile-up event