L0Muon::TgcL0TruthValidationAlg Class Reference

Calculates event-local TGC truth-validation quantities. More...

#include <TgcL0TruthValidationAlg.h>

Inheritance diagram for L0Muon::TgcL0TruthValidationAlg:

Collaboration diagram for L0Muon::TgcL0TruthValidationAlg:

Public Member Functions
StatusCode	initialize () override
StatusCode	execute (const EventContext &ctx) const override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< TgcL0CandidateContainer >	m_candidateKey
SG::ReadHandleKey< TgcL0SegmentContainer >	m_segmentKey
SG::ReadHandleKey< McEventCollection >	m_truthEventKey
SG::WriteHandleKey< TgcL0ValidationEvent >	m_outputKey
ToolHandle< Trk::IExtrapolator >	m_extrapolator
Gaudi::Property< float >	m_maxMeanDeltaR
Gaudi::Property< float >	m_maxWireSegmentDeltaEta
Gaudi::Property< float >	m_maxStripSegmentDeltaPhi
Gaudi::Property< double >	m_minPt
Gaudi::Property< double >	m_minAbsEta
Gaudi::Property< double >	m_maxAbsEta
Gaudi::Property< int >	m_requiredTruthStatus
Gaudi::Property< int >	m_maxAbsBarcode
Gaudi::Property< int >	m_requiredBcTag
Gaudi::Property< std::vector< double > >	m_stationAbsZ
Gaudi::Property< double >	m_validationMinR
Gaudi::Property< double >	m_validationMaxR
Gaudi::Property< double >	m_validationPlaneToleranceZ
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Calculates event-local TGC truth-validation quantities.

The algorithm has no ROOT or histogram dependency. Its transient output can be consumed by replaceable validation-output backends.

Definition at line 25 of file TgcL0TruthValidationAlg.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode L0Muon::TgcL0TruthValidationAlg::execute ( const EventContext & ctx ) const

override

Definition at line 145 of file TgcL0TruthValidationAlg.cxx.

                                                                         {
  SG::ReadHandle<TgcL0CandidateContainer> candidates{m_candidateKey, ctx};
  if (!candidates.isValid()) {
    ATH_MSG_ERROR("Failed to retrieve " << m_candidateKey.fullKey());
    return StatusCode::FAILURE;
  }
  SG::ReadHandle<TgcL0SegmentContainer> segments{m_segmentKey, ctx};
  if (!segments.isValid()) {
    ATH_MSG_ERROR("Failed to retrieve " << m_segmentKey.fullKey());
    return StatusCode::FAILURE;
  }
  SG::ReadHandle<McEventCollection> truthEvents{m_truthEventKey, ctx};
  if (!truthEvents.isValid()) {
    ATH_MSG_ERROR("Failed to retrieve " << m_truthEventKey.fullKey());
    return StatusCode::FAILURE;
  }
 
  auto output = std::make_unique<TgcL0ValidationEvent>();
  output->event.runNumber = ctx.eventID().run_number();
  output->event.eventNumber = ctx.eventID().event_number();
  output->event.lumiBlock = ctx.eventID().lumi_block();
  output->event.bcid = ctx.eventID().bunch_crossing_id();
 
  const auto processParticle = [&](const auto& particle) -> StatusCode {
    if (!particle || std::abs(particle->pdg_id()) != 13 ||
        particle->status() != m_requiredTruthStatus.value() ||
        std::abs(HepMC::barcode(particle)) > m_maxAbsBarcode.value()) {
      return StatusCode::SUCCESS;
    }
 
    const auto& momentum = particle->momentum();
    const double pt = momentum.perp();
    const double eta = momentum.eta();
    const double phi = momentum.phi();
    if (pt < m_minPt.value() || std::abs(eta) < m_minAbsEta.value() ||
        std::abs(eta) > m_maxAbsEta.value() || !std::isfinite(phi)) {
      return StatusCode::SUCCESS;
    }
 
    const int pdgId = particle->pdg_id();
    const double theta = 2.0 * std::atan(std::exp(-eta));
    const double momentumMagnitude = pt * std::cosh(eta);
    if (momentumMagnitude <= 0.0 || !std::isfinite(theta)) {
      return StatusCode::SUCCESS;
    }
 
    const double charge = pdgId == 13 ? -1.0 : 1.0;
    const Trk::PerigeeSurface perigeeSurface{Amg::Vector3D{0.0, 0.0, 0.0}};
    const Trk::Perigee perigee{0.0, 0.0, phi, theta,
                               charge / momentumMagnitude, perigeeSurface};
 
    StationPositions positions{};
    std::uint8_t stationMask{0U};
    const std::vector<double>& stationAbsZ = m_stationAbsZ.value();
    for (std::size_t station = 0U; station < positions.size(); ++station) {
      const double z = eta >= 0.0 ? stationAbsZ[station] : -stationAbsZ[station];
      Amg::Transform3D transform = Amg::Transform3D::Identity();
      transform.translation().z() = z;
      const Trk::DiscSurface disc{transform, m_validationMinR.value(),
                                  m_validationMaxR.value()};
      const Trk::BoundaryCheck boundaryCheck{true};
      const auto extrapolated = m_extrapolator->extrapolate(
          ctx, perigee, disc, Trk::alongMomentum, boundaryCheck, Trk::muon);
      if (!extrapolated) continue;
      const Amg::Vector3D& position = extrapolated->position();
      if (!std::isfinite(position.eta()) || !std::isfinite(position.phi()) ||
          std::abs(position.z() - z) > m_validationPlaneToleranceZ.value()) {
        continue;
      }
      positions[station] = StationPosition{
          true, static_cast<float>(position.eta()),
          static_cast<float>(xAOD::P4Helpers::deltaPhi(position.phi(), 0.))};
      stationMask |= stationBit(station);
    }
 
    output->truth.pdgId.emplace_back(pdgId);
    output->truth.barcode.emplace_back(HepMC::barcode(particle));
    output->truth.pt.emplace_back(static_cast<float>(pt));
    output->truth.eta.emplace_back(static_cast<float>(eta));
    output->truth.phi.emplace_back(static_cast<float>(phi));
    output->truth.charge.emplace_back(static_cast<float>(charge));
    output->truth.extrapolatedStationMask.emplace_back(stationMask);
    output->truth.m1Eta.emplace_back(positions[0].eta);
    output->truth.m1Phi.emplace_back(positions[0].phi);
    output->truth.m2Eta.emplace_back(positions[1].eta);
    output->truth.m2Phi.emplace_back(positions[1].phi);
    output->truth.m3Eta.emplace_back(positions[2].eta);
    output->truth.m3Phi.emplace_back(positions[2].phi);
    output->truth.matched.emplace_back(0U);
    output->truth.matchedCandidateIndex.emplace_back(-1);
    output->truth.matchMeanDeltaR.emplace_back(TgcL0ValidationInvalidValue);
    output->truth.unmatchedReason.emplace_back(
        stationMask == 0x7U
            ? static_cast<std::uint8_t>(
                  TgcL0ValidationUnmatchedReason::NoCandidateInWindow)
            : static_cast<std::uint8_t>(
                  TgcL0ValidationUnmatchedReason::NotFullyExtrapolated));
    output->truth.wireSegmentMatched.emplace_back(0U);
    output->truth.stripSegmentMatched.emplace_back(0U);
    output->truth.matchedWireSegmentIndex.emplace_back(-1);
    output->truth.matchedStripSegmentIndex.emplace_back(-1);
    output->truth.wireSegmentMatchResidual.emplace_back(
        TgcL0ValidationInvalidValue);
    output->truth.stripSegmentMatchResidual.emplace_back(
        TgcL0ValidationInvalidValue);
    return StatusCode::SUCCESS;
  };
 
  for (const HepMC::GenEvent* event : *truthEvents) {
    if (event == nullptr) continue;
#if __has_include("HepMC3/GenEvent.h")
    for (const auto& particle : event->particles()) {
      ATH_CHECK(processParticle(particle));
    }
#else
    for (auto particle = event->particles_begin();
         particle != event->particles_end(); ++particle) {
      ATH_CHECK(processParticle(*particle));
    }
#endif
  }
 
  for (const TgcL0Candidate& candidate : *candidates) {
    output->candidates.subdetectorId.emplace_back(candidate.subdetectorId);
    output->candidates.triggerSector.emplace_back(candidate.sectorId);
    output->candidates.readoutSector.emplace_back(candidate.readoutSector);
    output->candidates.bcTag.emplace_back(candidate.bcTag);
    output->candidates.stationMask.emplace_back(candidate.positionStationMask);
    output->candidates.wireStationMask.emplace_back(candidate.wireStationMask);
    output->candidates.stripStationMask.emplace_back(candidate.stripStationMask);
    output->candidates.eta.emplace_back(candidate.eta);
    output->candidates.phi.emplace_back(candidate.phi);
    output->candidates.deltaTheta.emplace_back(candidate.deltaTheta);
    output->candidates.deltaPhi.emplace_back(candidate.deltaPhi);
    output->candidates.truthIndex.emplace_back(-1);
  }
 
  std::vector<CandidateMatch> candidateMatches;
  std::vector<bool> hasCandidateInWindow(output->truth.pt.size(), false);
  for (std::size_t truth = 0U; truth < output->truth.pt.size(); ++truth) {
    if (output->truth.extrapolatedStationMask[truth] != 0x7U) continue;
    const StationPositions positions = truthPositions(*output, truth);
    for (std::size_t candidate = 0U; candidate < candidates->size();
         ++candidate) {
      const TgcL0Candidate& inputCandidate = (*candidates)[candidate];
      if (m_requiredBcTag.value() >= 0 &&
          inputCandidate.bcTag != static_cast<std::uint16_t>(m_requiredBcTag.value())) {
        continue;
      }
      if (output->truth.eta[truth] * inputCandidate.eta < 0.F) continue;
      const float residual = meanDeltaR(inputCandidate, positions);
      if (!std::isfinite(residual) || residual > m_maxMeanDeltaR.value()) continue;
      hasCandidateInWindow[truth] = true;
      candidateMatches.push_back({residual, truth, candidate});
    }
  }
  std::stable_sort(candidateMatches.begin(), candidateMatches.end(),
                   [](const CandidateMatch& lhs, const CandidateMatch& rhs) {
                     if (lhs.residual != rhs.residual) {
                       return lhs.residual < rhs.residual;
                     }
                     if (lhs.truth != rhs.truth) return lhs.truth < rhs.truth;
                     return lhs.candidate < rhs.candidate;
                   });
  for (const CandidateMatch& match : candidateMatches) {
    if (output->truth.matchedCandidateIndex[match.truth] >= 0 ||
        output->candidates.truthIndex[match.candidate] >= 0) {
      continue;
    }
    output->truth.matched[match.truth] = 1U;
    output->truth.matchedCandidateIndex[match.truth] =
        static_cast<int>(match.candidate);
    output->truth.matchMeanDeltaR[match.truth] = match.residual;
    output->truth.unmatchedReason[match.truth] =
        TgcL0ValidationNoUnmatchedReason;
    output->candidates.truthIndex[match.candidate] =
        static_cast<int>(match.truth);
  }
  for (std::size_t truth = 0U; truth < output->truth.pt.size(); ++truth) {
    if (output->truth.matched[truth] != 0U ||
        output->truth.extrapolatedStationMask[truth] != 0x7U) {
      continue;
    }
    output->truth.unmatchedReason[truth] = static_cast<std::uint8_t>(
        hasCandidateInWindow[truth]
            ? TgcL0ValidationUnmatchedReason::CandidateCompetition
            : TgcL0ValidationUnmatchedReason::NoCandidateInWindow);
  }
 
  for (const TgcL0Segment& segment : *segments) {
    output->segments.subdetectorId.emplace_back(segment.subdetectorId);
    output->segments.triggerSector.emplace_back(segment.triggerSector);
    output->segments.bcTag.emplace_back(segment.bcTag);
    output->segments.projection.emplace_back(
        static_cast<std::uint8_t>(segment.projection));
    output->segments.stationMask.emplace_back(segment.stationMask);
    output->segments.summedQuality.emplace_back(segment.summedQuality);
    output->segments.nStations.emplace_back(segment.nStations);
    output->segments.eta.emplace_back(segment.eta);
    output->segments.phi.emplace_back(segment.phi);
    output->segments.residual.emplace_back(segment.residual);
    output->segments.outputResidual.emplace_back(segment.outputResidual);
    output->segments.consistency.emplace_back(segment.consistency);
    output->segments.pivotChannel.emplace_back(segment.pivotChannel);
    output->segments.truthIndex.emplace_back(-1);
    output->segments.truthMatchResidual.emplace_back(
        TgcL0ValidationInvalidValue);
  }
 
  const auto matchProjection = [&](const TgcL0ValidationProjection projection,
                                   const float maximumResidual) {
    const auto projectionValue = static_cast<std::uint8_t>(projection);
    std::vector<SegmentMatch> possibleMatches;
    for (std::size_t truth = 0U; truth < output->truth.pt.size(); ++truth) {
      for (std::size_t segment = 0U;
           segment < output->segments.projection.size(); ++segment) {
        if (output->segments.projection[segment] != projectionValue) continue;
        if (m_requiredBcTag.value() >= 0 &&
            output->segments.bcTag[segment] !=
                static_cast<std::uint16_t>(m_requiredBcTag.value())) {
          continue;
        }
        if (output->truth.eta[truth] * output->segments.eta[segment] < 0.F) {
          continue;
        }
        const int station = pivotStation(output->segments.stationMask[segment]);
        if (station < 0 ||
            (output->truth.extrapolatedStationMask[truth] &
             stationBit(static_cast<std::size_t>(station))) == 0U) {
          continue;
        }
        const std::array<float, 3> truthEta{
            output->truth.m1Eta[truth], output->truth.m2Eta[truth],
            output->truth.m3Eta[truth]};
        const std::array<float, 3> truthPhi{
            output->truth.m1Phi[truth], output->truth.m2Phi[truth],
            output->truth.m3Phi[truth]};
        const float residual =
            projection == TgcL0ValidationProjection::Wire
                ? std::abs(output->segments.eta[segment] - truthEta[station])
                : std::abs(static_cast<float>(xAOD::P4Helpers::deltaPhi(
                      output->segments.phi[segment], truthPhi[station])));
        if (std::isfinite(residual) && residual <= maximumResidual) {
          possibleMatches.push_back({residual, truth, segment});
        }
      }
    }
    std::stable_sort(possibleMatches.begin(), possibleMatches.end(),
                     [](const SegmentMatch& lhs, const SegmentMatch& rhs) {
                       if (lhs.residual != rhs.residual) {
                         return lhs.residual < rhs.residual;
                       }
                       if (lhs.truth != rhs.truth) return lhs.truth < rhs.truth;
                       return lhs.segment < rhs.segment;
                     });
    for (const SegmentMatch& match : possibleMatches) {
      int& truthSegment =
          projection == TgcL0ValidationProjection::Wire
              ? output->truth.matchedWireSegmentIndex[match.truth]
              : output->truth.matchedStripSegmentIndex[match.truth];
      if (truthSegment >= 0 ||
          output->segments.truthIndex[match.segment] >= 0) {
        continue;
      }
      truthSegment = static_cast<int>(match.segment);
      output->segments.truthIndex[match.segment] =
          static_cast<int>(match.truth);
      output->segments.truthMatchResidual[match.segment] = match.residual;
      if (projection == TgcL0ValidationProjection::Wire) {
        output->truth.wireSegmentMatched[match.truth] = 1U;
        output->truth.wireSegmentMatchResidual[match.truth] = match.residual;
      } else {
        output->truth.stripSegmentMatched[match.truth] = 1U;
        output->truth.stripSegmentMatchResidual[match.truth] = match.residual;
      }
    }
  };
 
  matchProjection(TgcL0ValidationProjection::Wire,
                  m_maxWireSegmentDeltaEta.value());
  matchProjection(TgcL0ValidationProjection::Strip,
                  m_maxStripSegmentDeltaPhi.value());
 
  const TgcL0ValidationCheckResult check = checkTgcL0ValidationEvent(*output);
  if (!check.valid) {
    ATH_MSG_ERROR("Refusing to record inconsistent validation data: "
                  << check.message);
    return StatusCode::FAILURE;
  }
 
  SG::WriteHandle<TgcL0ValidationEvent> outputHandle{m_outputKey, ctx};
  ATH_CHECK(outputHandle.record(std::move(output)));
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 89 of file AthCommonAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

initialize()

StatusCode L0Muon::TgcL0TruthValidationAlg::initialize ( )

override

Definition at line 116 of file TgcL0TruthValidationAlg.cxx.

                                               {
  ATH_CHECK(m_candidateKey.initialize());
  ATH_CHECK(m_segmentKey.initialize());
  ATH_CHECK(m_truthEventKey.initialize());
  ATH_CHECK(m_outputKey.initialize());
  ATH_CHECK(m_extrapolator.retrieve());
 
  if (m_stationAbsZ.value().size() != 3U) {
    ATH_MSG_ERROR("StationAbsZ must contain exactly M1, M2, and M3 values");
    return StatusCode::FAILURE;
  }
  if (m_validationMinR.value() < 0.0 || m_validationMaxR.value() <= m_validationMinR.value()) {
    ATH_MSG_ERROR("Validation radii are invalid: min=" << m_validationMinR.value()
                  << ", max=" << m_validationMaxR.value());
    return StatusCode::FAILURE;
  }
  if (m_validationPlaneToleranceZ.value() < 0.0) {
    ATH_MSG_ERROR("ValidationPlaneToleranceZ must be non-negative");
    return StatusCode::FAILURE;
  }
  if (m_requiredBcTag.value() < -1 ||
      m_requiredBcTag.value() >
          static_cast<int>(std::numeric_limits<std::uint16_t>::max())) {
    ATH_MSG_ERROR("RequiredBcTag must be -1 or a uint16 value");
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.cxx.

                                                      {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_candidateKey

SG::ReadHandleKey<TgcL0CandidateContainer> L0Muon::TgcL0TruthValidationAlg::m_candidateKey

private

Initial value:

{
      this, "CandidateKey", "L0MuonTGCValidationCandidates",
      "Pre-Inner-Coincidence transient candidates"}

Definition at line 33 of file TgcL0TruthValidationAlg.h.

                                                         {
      this, "CandidateKey", "L0MuonTGCValidationCandidates",
      "Pre-Inner-Coincidence transient candidates"};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

m_extrapolator

ToolHandle<Trk::IExtrapolator> L0Muon::TgcL0TruthValidationAlg::m_extrapolator

private

Initial value:

{
      this, "TrackExtrapolator", "", "Truth-only extrapolator"}

Definition at line 44 of file TgcL0TruthValidationAlg.h.

                                             {
      this, "TrackExtrapolator", "", "Truth-only extrapolator"};

m_maxAbsBarcode

Gaudi::Property<int> L0Muon::TgcL0TruthValidationAlg::m_maxAbsBarcode

private

Initial value:

{
      this, "MaxAbsBarcode", 9999,
      "Maximum absolute HepMC barcode for selected truth muons"}

Definition at line 65 of file TgcL0TruthValidationAlg.h.

                                    {
      this, "MaxAbsBarcode", 9999,
      "Maximum absolute HepMC barcode for selected truth muons"};

m_maxAbsEta

Gaudi::Property<double> L0Muon::TgcL0TruthValidationAlg::m_maxAbsEta

private

Initial value:

{
      this, "MaxTruthAbsEta", 2.50, "Maximum absolute truth eta"}

Definition at line 60 of file TgcL0TruthValidationAlg.h.

                                   {
      this, "MaxTruthAbsEta", 2.50, "Maximum absolute truth eta"};

m_maxMeanDeltaR

Gaudi::Property<float> L0Muon::TgcL0TruthValidationAlg::m_maxMeanDeltaR

private

Initial value:

{
      this, "TruthMatchMaxMeanDeltaR", 0.08F,
      "Maximum station-averaged deltaR for truth matching"}

Definition at line 47 of file TgcL0TruthValidationAlg.h.

                                      {
      this, "TruthMatchMaxMeanDeltaR", 0.08F,
      "Maximum station-averaged deltaR for truth matching"};

m_maxStripSegmentDeltaPhi

Gaudi::Property<float> L0Muon::TgcL0TruthValidationAlg::m_maxStripSegmentDeltaPhi

private

Initial value:

{
      this, "TruthStripSegmentMaxDeltaPhi", 0.08F,
      "Maximum |delta phi| for truth-to-strip-segment matching"}

Definition at line 53 of file TgcL0TruthValidationAlg.h.

                                                {
      this, "TruthStripSegmentMaxDeltaPhi", 0.08F,
      "Maximum |delta phi| for truth-to-strip-segment matching"};

m_maxWireSegmentDeltaEta

Gaudi::Property<float> L0Muon::TgcL0TruthValidationAlg::m_maxWireSegmentDeltaEta

private

Initial value:

{
      this, "TruthWireSegmentMaxDeltaEta", 0.08F,
      "Maximum |delta eta| for truth-to-wire-segment matching"}

Definition at line 50 of file TgcL0TruthValidationAlg.h.

                                               {
      this, "TruthWireSegmentMaxDeltaEta", 0.08F,
      "Maximum |delta eta| for truth-to-wire-segment matching"};

m_minAbsEta

Gaudi::Property<double> L0Muon::TgcL0TruthValidationAlg::m_minAbsEta

private

Initial value:

{
      this, "MinTruthAbsEta", 0.95, "Minimum absolute truth eta"}

Definition at line 58 of file TgcL0TruthValidationAlg.h.

                                   {
      this, "MinTruthAbsEta", 0.95, "Minimum absolute truth eta"};

m_minPt

Gaudi::Property<double> L0Muon::TgcL0TruthValidationAlg::m_minPt

private

Initial value:

{
      this, "MinTruthPt", 2000.0, "Minimum truth-muon pT in MeV"}

Definition at line 56 of file TgcL0TruthValidationAlg.h.

                               {
      this, "MinTruthPt", 2000.0, "Minimum truth-muon pT in MeV"};

m_outputKey

SG::WriteHandleKey<TgcL0ValidationEvent> L0Muon::TgcL0TruthValidationAlg::m_outputKey

private

Initial value:

{
      this, "OutputKey", "L0MuonTGCValidationEvent",
      "Calculated event-local truth-validation data"}

Definition at line 41 of file TgcL0TruthValidationAlg.h.

                                                    {
      this, "OutputKey", "L0MuonTGCValidationEvent",
      "Calculated event-local truth-validation data"};

m_requiredBcTag

Gaudi::Property<int> L0Muon::TgcL0TruthValidationAlg::m_requiredBcTag

private

Initial value:

{
      this, "RequiredBcTag", 0,
      "BC tag used for truth matching; set to -1 to disable the filter"}

Definition at line 68 of file TgcL0TruthValidationAlg.h.

                                    {
      this, "RequiredBcTag", 0,
      "BC tag used for truth matching; set to -1 to disable the filter"};

m_requiredTruthStatus

Gaudi::Property<int> L0Muon::TgcL0TruthValidationAlg::m_requiredTruthStatus

private

Initial value:

{
      this, "RequiredTruthStatus", 1,
      "Generator status required for selected truth muons"}

Definition at line 62 of file TgcL0TruthValidationAlg.h.

                                          {
      this, "RequiredTruthStatus", 1,
      "Generator status required for selected truth muons"};

m_segmentKey

SG::ReadHandleKey<TgcL0SegmentContainer> L0Muon::TgcL0TruthValidationAlg::m_segmentKey

private

Initial value:

{
      this, "SegmentKey", "L0MuonTGCValidationSegments",
      "Projection segments published by reconstruction"}

Definition at line 36 of file TgcL0TruthValidationAlg.h.

                                                     {
      this, "SegmentKey", "L0MuonTGCValidationSegments",
      "Projection segments published by reconstruction"};

m_stationAbsZ

Gaudi::Property<std::vector<double> > L0Muon::TgcL0TruthValidationAlg::m_stationAbsZ

private

Initial value:

{
      this, "StationAbsZ", {13436.5, 14728.2, 15148.2},
      "Nominal absolute z positions of the M1, M2, and M3 validation planes"}

Definition at line 71 of file TgcL0TruthValidationAlg.h.

                                                {
      this, "StationAbsZ", {13436.5, 14728.2, 15148.2},
      "Nominal absolute z positions of the M1, M2, and M3 validation planes"};

m_truthEventKey

SG::ReadHandleKey<McEventCollection> L0Muon::TgcL0TruthValidationAlg::m_truthEventKey

private

Initial value:

{
      this, "TruthEventKey", "TruthEvent", "Input truth-event collection"}

Definition at line 39 of file TgcL0TruthValidationAlg.h.

                                                    {
      this, "TruthEventKey", "TruthEvent", "Input truth-event collection"};

m_validationMaxR

Gaudi::Property<double> L0Muon::TgcL0TruthValidationAlg::m_validationMaxR

private

Initial value:

{
      this, "ValidationMaxR", 11977.0,
      "Maximum radius of the truth-extrapolation validation planes"}

Definition at line 77 of file TgcL0TruthValidationAlg.h.

                                        {
      this, "ValidationMaxR", 11977.0,
      "Maximum radius of the truth-extrapolation validation planes"};

m_validationMinR

Gaudi::Property<double> L0Muon::TgcL0TruthValidationAlg::m_validationMinR

private

Initial value:

{
      this, "ValidationMinR", 0.0,
      "Minimum radius of the truth-extrapolation validation planes"}

Definition at line 74 of file TgcL0TruthValidationAlg.h.

                                        {
      this, "ValidationMinR", 0.0,
      "Minimum radius of the truth-extrapolation validation planes"};

m_validationPlaneToleranceZ

Gaudi::Property<double> L0Muon::TgcL0TruthValidationAlg::m_validationPlaneToleranceZ

private

Initial value:

{
      this, "ValidationPlaneToleranceZ", 20.0,
      "Maximum distance in z from an extrapolation target plane"}

Definition at line 80 of file TgcL0TruthValidationAlg.h.

                                                   {
      this, "ValidationPlaneToleranceZ", 20.0,
      "Maximum distance in z from an extrapolation target plane"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

The documentation for this class was generated from the following files:

• TgcL0TruthValidationAlg.h
• TgcL0TruthValidationAlg.cxx