L0Muon Namespace Reference

Namespaces
namespace	MuCTPIBits
namespace	NSWTPBits
namespace	TgcL0Floating

Classes
class	ICandData
class	ITgcL0CandidateBuilderTool
	Interface for building pre-Inner-Coincidence TGC candidates. More...
class	ITgcL0InnerCoincidenceTool
	Interface for applying Inner Coincidence to TGC candidates. More...
class	ITgcL0TrackSelectorTool
	Interface for selecting TGC candidates and filling TGCCandData. More...
class	L0MuonEndcapAlg
	Initial data-flow boundary for the Phase-II endcap trigger. More...
class	L0MuonSmearingAlg
class	L0MuonTrack
class	MDTSimulation
class	NSWSimulation
class	RPCCandData
class	RPCSimulation
class	TGCCandData
class	TgcL0BitwiseCandidateBuilderTool
class	TgcL0BitwiseInnerCoincidenceTool
class	TgcL0BitwiseTrackSelectorTool
struct	TgcL0Candidate
	Event-local candidate used by the TGC simulation tools. More...
class	TgcL0FloatingCandidateBuilderTool
class	TgcL0FloatingInnerCoincidenceTool
struct	TgcL0FloatingPtEvaluation
class	TgcL0FloatingPtLut
	Immutable Floating-pT runtime calibration loaded from ASCII. More...
class	TgcL0FloatingTrackSelectorTool
class	TgcL0GoodMagMap
	Immutable sparse GoodMag map loaded from ASCII. More...
class	TgcL0MdtCandidateSelector
	Select the TGC candidates sent to MDTTP. More...
class	TgcL0RootOutputAlg
	MuonTester backend for event-level TGC truth-validation data. More...
struct	TgcL0Segment
	Event-local projection segment optionally exposed for validation. More...
class	TgcL0TruthValidationAlg
	Calculates event-local TGC truth-validation quantities. More...
struct	TgcL0ValidationCandidateBlock
	Reconstruction quantities exposed to validation backends. More...
struct	TgcL0ValidationCheckResult
	Result of a structural validation-data consistency check. More...
struct	TgcL0ValidationEvent
	ROOT-independent validation data for one event. More...
struct	TgcL0ValidationEventInfo
	Event identifiers used by the validation chain. More...
struct	TgcL0ValidationSegmentBlock
	Projection-segment quantities published by reconstruction. More...
struct	TgcL0ValidationTruthBlock
	Truth and truth-to-reconstruction matching quantities. More...
class	TGCSimulation
class	TruthTrackSmearer

Typedefs
using	RPCCandDataContainer = DataVector<RPCCandData>
using	TGCCandDataContainer = DataVector<TGCCandData>
using	TgcL0CandidateContainer = std::vector<TgcL0Candidate>
	Event-local candidate collection.
using	TgcL0SegmentContainer = std::vector<TgcL0Segment>

Enumerations
enum class	TgcL0FloatingPtResponseMode : std::uint8_t { Invalid = 0 , Linear = 1 , FloatingMonotonicLut = 2 }
enum class	TgcL0FloatingThresholdCalibrationStatus : std::uint8_t {   None = 0 , Direct = 1 , PhiMedianFallback = 2 , EtaNeighborFallback = 3 ,   GlobalFallback = 4 , Provisional = 5 }
enum class	TgcL0SegmentProjection : std::uint8_t { Wire = 0U , Strip = 1U }
	Projection represented by a transient TGC segment. More...
enum class	TgcL0ValidationProjection : std::uint8_t { Wire = 0U , Strip = 1U }
	Projection encoding used in the validation segment block. More...
enum class	TgcL0ValidationUnmatchedReason : std::uint8_t { NotFullyExtrapolated = 0U , NoCandidateInWindow = 1U , CandidateCompetition = 2U }
	Reason why a selected truth muon has no matched candidate. More...

Functions
TgcL0ValidationCheckResult	checkTgcL0ValidationEvent (const TgcL0ValidationEvent &event)
	Check vector sizes and reciprocal cross-block indices.

Variables
static constexpr float	TgcL0ValidationInvalidValue = 999.F
	Common sentinel for unavailable floating-point validation data.
static constexpr std::uint8_t	TgcL0ValidationNoUnmatchedReason = 255U
	Sentinel indicating that a matched truth object has no failure code.

Typedef Documentation

RPCCandDataContainer

using L0Muon::RPCCandDataContainer = DataVector<RPCCandData>

Definition at line 13 of file Trigger/TrigT1/Muon/L0MuonInterface/L0MuonInterface/RPCCandDataContainer.h.

TGCCandDataContainer

using L0Muon::TGCCandDataContainer = DataVector<TGCCandData>

Definition at line 13 of file Trigger/TrigT1/Muon/L0MuonInterface/L0MuonInterface/TGCCandDataContainer.h.

TgcL0CandidateContainer

using L0Muon::TgcL0CandidateContainer = std::vector<TgcL0Candidate>

Event-local candidate collection.

Definition at line 103 of file TgcL0Candidate.h.

TgcL0SegmentContainer

using L0Muon::TgcL0SegmentContainer = std::vector<TgcL0Segment>

Definition at line 34 of file TgcL0Segment.h.

Enumeration Type Documentation

TgcL0FloatingPtResponseMode

enum class L0Muon::TgcL0FloatingPtResponseMode : std::uint8_t

strong

Enumerator
Invalid
Linear
FloatingMonotonicLut

Definition at line 15 of file TgcL0FloatingPtLut.h.

                                       : std::uint8_t {
  Invalid = 0,
  Linear = 1,
  FloatingMonotonicLut = 2
};

TgcL0FloatingThresholdCalibrationStatus

enum class L0Muon::TgcL0FloatingThresholdCalibrationStatus : std::uint8_t

strong

Enumerator
None
Direct
PhiMedianFallback
EtaNeighborFallback
GlobalFallback
Provisional

Definition at line 21 of file TgcL0FloatingPtLut.h.

                                                   : std::uint8_t {
  None = 0,
  Direct = 1,
  PhiMedianFallback = 2,
  EtaNeighborFallback = 3,
  GlobalFallback = 4,
  Provisional = 5
};

TgcL0SegmentProjection

enum class L0Muon::TgcL0SegmentProjection : std::uint8_t

strong

Projection represented by a transient TGC segment.

Enumerator
Wire
Strip

Definition at line 15 of file TgcL0Segment.h.

: std::uint8_t { Wire = 0U, Strip = 1U };

TgcL0ValidationProjection

enum class L0Muon::TgcL0ValidationProjection : std::uint8_t

strong

Projection encoding used in the validation segment block.

Enumerator
Wire
Strip

Definition at line 21 of file TgcL0ValidationEvent.h.

                                     : std::uint8_t {
  Wire = 0U,
  Strip = 1U
};

TgcL0ValidationUnmatchedReason

enum class L0Muon::TgcL0ValidationUnmatchedReason : std::uint8_t

strong

Reason why a selected truth muon has no matched candidate.

Enumerator
NotFullyExtrapolated
NoCandidateInWindow
CandidateCompetition

Definition at line 27 of file TgcL0ValidationEvent.h.

                                          : std::uint8_t {
  NotFullyExtrapolated = 0U,
  NoCandidateInWindow = 1U,
  CandidateCompetition = 2U
};

Function Documentation

checkTgcL0ValidationEvent()

TgcL0ValidationCheckResult L0Muon::checkTgcL0ValidationEvent ( const TgcL0ValidationEvent & event )

inline

Check vector sizes and reciprocal cross-block indices.

Definition at line 24 of file TgcL0ValidationEventCheck.h.

                                       {
  const std::size_t nTruth = event.truth.pdgId.size();
  const std::size_t nSegments = event.segments.subdetectorId.size();
  const std::size_t nCandidates = event.candidates.subdetectorId.size();
 
  const auto invalid = [](std::string message) {
    return TgcL0ValidationCheckResult{false, std::move(message)};
  };
  const auto checkTruthSize = [&](const std::size_t size,
                                  const char* field) {
    return size == nTruth
               ? TgcL0ValidationCheckResult{}
               : invalid(std::string{"Truth block size mismatch for "} +
                         field);
  };
  const auto checkSegmentSize = [&](const std::size_t size,
                                    const char* field) {
    return size == nSegments
               ? TgcL0ValidationCheckResult{}
               : invalid(std::string{"Segment block size mismatch for "} +
                         field);
  };
  const auto checkCandidateSize = [&](const std::size_t size,
                                      const char* field) {
    return size == nCandidates
               ? TgcL0ValidationCheckResult{}
               : invalid(std::string{"Candidate block size mismatch for "} +
                         field);
  };
 
#define TGC_CHECK_TRUTH_SIZE(FIELD)                 \
  do {                                              \
    const auto result = checkTruthSize(             \
        event.truth.FIELD.size(), #FIELD);           \
    if (!result.valid) return result;                \
  } while (false)
 
  TGC_CHECK_TRUTH_SIZE(barcode);
  TGC_CHECK_TRUTH_SIZE(pt);
  TGC_CHECK_TRUTH_SIZE(eta);
  TGC_CHECK_TRUTH_SIZE(phi);
  TGC_CHECK_TRUTH_SIZE(charge);
  TGC_CHECK_TRUTH_SIZE(extrapolatedStationMask);
  TGC_CHECK_TRUTH_SIZE(m1Eta);
  TGC_CHECK_TRUTH_SIZE(m1Phi);
  TGC_CHECK_TRUTH_SIZE(m2Eta);
  TGC_CHECK_TRUTH_SIZE(m2Phi);
  TGC_CHECK_TRUTH_SIZE(m3Eta);
  TGC_CHECK_TRUTH_SIZE(m3Phi);
  TGC_CHECK_TRUTH_SIZE(matched);
  TGC_CHECK_TRUTH_SIZE(matchedCandidateIndex);
  TGC_CHECK_TRUTH_SIZE(matchMeanDeltaR);
  TGC_CHECK_TRUTH_SIZE(unmatchedReason);
  TGC_CHECK_TRUTH_SIZE(wireSegmentMatched);
  TGC_CHECK_TRUTH_SIZE(stripSegmentMatched);
  TGC_CHECK_TRUTH_SIZE(matchedWireSegmentIndex);
  TGC_CHECK_TRUTH_SIZE(matchedStripSegmentIndex);
  TGC_CHECK_TRUTH_SIZE(wireSegmentMatchResidual);
  TGC_CHECK_TRUTH_SIZE(stripSegmentMatchResidual);
#undef TGC_CHECK_TRUTH_SIZE
 
#define TGC_CHECK_SEGMENT_SIZE(FIELD)               \
  do {                                              \
    const auto result = checkSegmentSize(           \
        event.segments.FIELD.size(), #FIELD);        \
    if (!result.valid) return result;                \
  } while (false)
 
  TGC_CHECK_SEGMENT_SIZE(triggerSector);
  TGC_CHECK_SEGMENT_SIZE(bcTag);
  TGC_CHECK_SEGMENT_SIZE(projection);
  TGC_CHECK_SEGMENT_SIZE(stationMask);
  TGC_CHECK_SEGMENT_SIZE(summedQuality);
  TGC_CHECK_SEGMENT_SIZE(nStations);
  TGC_CHECK_SEGMENT_SIZE(eta);
  TGC_CHECK_SEGMENT_SIZE(phi);
  TGC_CHECK_SEGMENT_SIZE(residual);
  TGC_CHECK_SEGMENT_SIZE(outputResidual);
  TGC_CHECK_SEGMENT_SIZE(consistency);
  TGC_CHECK_SEGMENT_SIZE(pivotChannel);
  TGC_CHECK_SEGMENT_SIZE(truthIndex);
  TGC_CHECK_SEGMENT_SIZE(truthMatchResidual);
#undef TGC_CHECK_SEGMENT_SIZE
 
#define TGC_CHECK_CANDIDATE_SIZE(FIELD)             \
  do {                                              \
    const auto result = checkCandidateSize(         \
        event.candidates.FIELD.size(), #FIELD);      \
    if (!result.valid) return result;                \
  } while (false)
 
  TGC_CHECK_CANDIDATE_SIZE(triggerSector);
  TGC_CHECK_CANDIDATE_SIZE(readoutSector);
  TGC_CHECK_CANDIDATE_SIZE(bcTag);
  TGC_CHECK_CANDIDATE_SIZE(stationMask);
  TGC_CHECK_CANDIDATE_SIZE(wireStationMask);
  TGC_CHECK_CANDIDATE_SIZE(stripStationMask);
  TGC_CHECK_CANDIDATE_SIZE(eta);
  TGC_CHECK_CANDIDATE_SIZE(phi);
  TGC_CHECK_CANDIDATE_SIZE(deltaTheta);
  TGC_CHECK_CANDIDATE_SIZE(deltaPhi);
  TGC_CHECK_CANDIDATE_SIZE(pt);
  TGC_CHECK_CANDIDATE_SIZE(threshold);
  TGC_CHECK_CANDIDATE_SIZE(charge);
  TGC_CHECK_CANDIDATE_SIZE(truthIndex);
#undef TGC_CHECK_CANDIDATE_SIZE
 
  const auto wireProjection =
      static_cast<std::uint8_t>(TgcL0ValidationProjection::Wire);
  const auto stripProjection =
      static_cast<std::uint8_t>(TgcL0ValidationProjection::Strip);
 
  for (std::size_t segment = 0U; segment < nSegments; ++segment) {
    const std::uint8_t projection = event.segments.projection[segment];
    if (projection != wireProjection && projection != stripProjection) {
      return invalid("Segment projection is not wire or strip");
    }
    if (event.segments.nStations[segment] == 0U ||
        event.segments.nStations[segment] > 3U) {
      return invalid("Segment station count is out of range");
    }
    const int truth = event.segments.truthIndex[segment];
    if (truth >= 0 && static_cast<std::size_t>(truth) >= nTruth) {
      return invalid("Segment truth index is out of range");
    }
    const float residual = event.segments.truthMatchResidual[segment];
    if (truth >= 0 &&
        (!std::isfinite(residual) ||
         residual == TgcL0ValidationInvalidValue)) {
      return invalid("Matched segment has an invalid truth residual");
    }
    if (truth < 0 && residual != TgcL0ValidationInvalidValue) {
      return invalid("Unmatched segment has a truth residual");
    }
  }
 
  for (const int truth : event.candidates.truthIndex) {
    if (truth >= 0 && static_cast<std::size_t>(truth) >= nTruth) {
      return invalid("Candidate truth index is out of range");
    }
  }
 
  std::vector<int> candidateOwner(nCandidates, -1);
  for (std::size_t truth = 0U; truth < nTruth; ++truth) {
    if (event.truth.matched[truth] > 1U) {
      return invalid("Truth matched flag is not binary");
    }
    const bool matched = event.truth.matched[truth] != 0U;
    const int candidate = event.truth.matchedCandidateIndex[truth];
    if (candidate >= 0 && static_cast<std::size_t>(candidate) >= nCandidates) {
      return invalid("Truth matched-candidate index is out of range");
    }
    if (matched && candidate < 0) {
      return invalid("Matched truth has no candidate index");
    }
    if (!matched && candidate >= 0) {
      return invalid("Unmatched truth has a candidate index");
    }
    if (matched &&
        event.truth.unmatchedReason[truth] !=
            TgcL0ValidationNoUnmatchedReason) {
      return invalid("Matched truth has an unmatched-reason code");
    }
    if (!matched &&
        event.truth.unmatchedReason[truth] ==
            TgcL0ValidationNoUnmatchedReason) {
      return invalid("Unmatched truth has no unmatched-reason code");
    }
    if (!matched &&
        event.truth.unmatchedReason[truth] >
            static_cast<std::uint8_t>(
                TgcL0ValidationUnmatchedReason::CandidateCompetition)) {
      return invalid("Truth unmatched-reason code is out of range");
    }
    if (matched &&
        (!std::isfinite(event.truth.matchMeanDeltaR[truth]) ||
         event.truth.matchMeanDeltaR[truth] == TgcL0ValidationInvalidValue)) {
      return invalid("Matched truth has an invalid candidate residual");
    }
    if (!matched &&
        event.truth.matchMeanDeltaR[truth] != TgcL0ValidationInvalidValue) {
      return invalid("Unmatched truth has a candidate residual");
    }
    if (candidate >= 0) {
      const auto candidateIndex = static_cast<std::size_t>(candidate);
      if (candidateOwner[candidateIndex] >= 0) {
        return invalid("Candidate is matched to more than one truth muon");
      }
      candidateOwner[candidateIndex] = static_cast<int>(truth);
      if (event.candidates.truthIndex[candidateIndex] !=
          static_cast<int>(truth)) {
        return invalid("Truth-candidate matching indices are not reciprocal");
      }
    }
 
    if (event.truth.wireSegmentMatched[truth] > 1U ||
        event.truth.stripSegmentMatched[truth] > 1U) {
      return invalid("Truth segment-matched flag is not binary");
    }
    const bool wireMatched = event.truth.wireSegmentMatched[truth] != 0U;
    const bool stripMatched = event.truth.stripSegmentMatched[truth] != 0U;
    const int wireSegment = event.truth.matchedWireSegmentIndex[truth];
    const int stripSegment = event.truth.matchedStripSegmentIndex[truth];
    if (wireSegment >= 0 &&
        static_cast<std::size_t>(wireSegment) >= nSegments) {
      return invalid("Truth matched-wire-segment index is out of range");
    }
    if (stripSegment >= 0 &&
        static_cast<std::size_t>(stripSegment) >= nSegments) {
      return invalid("Truth matched-strip-segment index is out of range");
    }
    if (wireMatched && wireSegment < 0) {
      return invalid("Wire-segment-matched truth has no segment index");
    }
    if (stripMatched && stripSegment < 0) {
      return invalid("Strip-segment-matched truth has no segment index");
    }
    if (!wireMatched && wireSegment >= 0) {
      return invalid("Wire-segment-unmatched truth has a segment index");
    }
    if (!stripMatched && stripSegment >= 0) {
      return invalid("Strip-segment-unmatched truth has a segment index");
    }
    if (wireMatched &&
        (!std::isfinite(event.truth.wireSegmentMatchResidual[truth]) ||
         event.truth.wireSegmentMatchResidual[truth] ==
             TgcL0ValidationInvalidValue)) {
      return invalid("Wire-segment-matched truth has an invalid residual");
    }
    if (!wireMatched &&
        event.truth.wireSegmentMatchResidual[truth] !=
            TgcL0ValidationInvalidValue) {
      return invalid("Wire-segment-unmatched truth has a residual");
    }
    if (stripMatched &&
        (!std::isfinite(event.truth.stripSegmentMatchResidual[truth]) ||
         event.truth.stripSegmentMatchResidual[truth] ==
             TgcL0ValidationInvalidValue)) {
      return invalid("Strip-segment-matched truth has an invalid residual");
    }
    if (!stripMatched &&
        event.truth.stripSegmentMatchResidual[truth] !=
            TgcL0ValidationInvalidValue) {
      return invalid("Strip-segment-unmatched truth has a residual");
    }
    if (wireSegment >= 0 &&
        event.segments.projection[wireSegment] != wireProjection) {
      return invalid("Truth wire-segment index points to a strip segment");
    }
    if (stripSegment >= 0 &&
        event.segments.projection[stripSegment] != stripProjection) {
      return invalid("Truth strip-segment index points to a wire segment");
    }
    if ((wireSegment >= 0 &&
         event.segments.truthIndex[wireSegment] != static_cast<int>(truth)) ||
        (stripSegment >= 0 &&
         event.segments.truthIndex[stripSegment] != static_cast<int>(truth))) {
      return invalid("Truth-segment matching indices are not reciprocal");
    }
  }
 
  for (std::size_t candidate = 0U; candidate < nCandidates; ++candidate) {
    const int truth = event.candidates.truthIndex[candidate];
    if (truth < 0) continue;
    if (event.truth.matched[truth] == 0U ||
        event.truth.matchedCandidateIndex[truth] !=
            static_cast<int>(candidate)) {
      return invalid("Truth-candidate matching indices are not reciprocal");
    }
  }
 
  for (std::size_t segment = 0U; segment < nSegments; ++segment) {
    const int truth = event.segments.truthIndex[segment];
    if (truth < 0) continue;
    const bool isWire = event.segments.projection[segment] == wireProjection;
    const int reverseIndex =
        isWire ? event.truth.matchedWireSegmentIndex[truth]
               : event.truth.matchedStripSegmentIndex[truth];
    if (reverseIndex != static_cast<int>(segment)) {
      return invalid("Truth-segment matching indices are not reciprocal");
    }
  }
 
  return {};
}

Variable Documentation

TgcL0ValidationInvalidValue

float L0Muon::TgcL0ValidationInvalidValue = 999.F

staticconstexpr

Common sentinel for unavailable floating-point validation data.

Definition at line 15 of file TgcL0ValidationEvent.h.

TgcL0ValidationNoUnmatchedReason

std::uint8_t L0Muon::TgcL0ValidationNoUnmatchedReason = 255U

staticconstexpr

Sentinel indicating that a matched truth object has no failure code.

Definition at line 18 of file TgcL0ValidationEvent.h.