AtlasUncalibSourceLinkAccessor.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
  */
#ifndef ATLASUNCALIBSROUCELINACCESOR_H
#define ATLASUNCALIBSROUCELINACCESOR_H
 
#include "ActsGeometry/ATLASSourceLink.h"
 
#include "xAODInDetMeasurement/PixelClusterContainer.h"
#include "xAODInDetMeasurement/StripClusterContainer.h"
#include "xAODInDetMeasurement/HGTDClusterContainer.h"
 
#include "src/detail/MeasurementContainerWithDimension.h"
#include <variant>
#include <vector>
#include <unordered_map>
#include <utility>
 
namespace ActsTrk::detail {
  
// Helper class to describe ranges of measurements
// the range provides the measurement collection index and  element index range (begin, end)
  struct MeasurementRange : public std::pair<unsigned int, unsigned int>
  {
    static constexpr unsigned int CONTAINER_IDX_SHIFT = 28;
    static constexpr unsigned int CONTAINER_IDX_MASK = (1u << 31) | (1u << 30) | (1u << 29) | (1u << 28);
    static constexpr unsigned int ELEMENT_IDX_MASK = ~CONTAINER_IDX_MASK;
    static constexpr unsigned int createRangeValue(unsigned int container_idx, unsigned int index)
    {
      assert(container_idx < (1u << (32 - CONTAINER_IDX_SHIFT)));
      assert((index & CONTAINER_IDX_MASK) == 0u);
      return (container_idx << CONTAINER_IDX_SHIFT) | index;
    }
    static constexpr unsigned int extractContainerIndex(unsigned int value) {
       return (value & CONTAINER_IDX_MASK) >> CONTAINER_IDX_SHIFT;
    }
    static constexpr unsigned int extractElementIndex(unsigned int value) {
      return value & ELEMENT_IDX_MASK;
    }
    bool isConsistentRange() const {
       return     extractContainerIndex(this->first)  == extractContainerIndex(this->second)
              && (    extractElementIndex(this->first) <= extractElementIndex(this->second)
                  || (extractElementIndex(this->first)==ELEMENT_IDX_MASK && extractElementIndex(this->second)==0));
    }
 
    MeasurementRange() : std::pair<unsigned int, unsigned int>(std::numeric_limits<unsigned int>::max(), std::numeric_limits<unsigned int>::max()) {}
    MeasurementRange(unsigned int container_idx, unsigned int start_element_idx, unsigned int end_element_idx)
       : std::pair<unsigned int, unsigned int>( createRangeValue(container_idx, start_element_idx),
                                                createRangeValue(container_idx, end_element_idx) ) {
    }
 
    static MeasurementRange noMeasurementExpected() {
       return MeasurementRange(CONTAINER_IDX_MASK >> CONTAINER_IDX_SHIFT,
                               ELEMENT_IDX_MASK,
                               0);
    }
 
    void updateEnd(std::size_t container_idx, unsigned int end_element_idx) {
       assert( extractContainerIndex(this->first) == container_idx);
       this->second = createRangeValue(container_idx, end_element_idx);
    }
 
    unsigned int containerIndex() const
    {
      assert(isConsistentRange());
      return extractContainerIndex(this->first);
    }
    unsigned int elementBeginIndex() const
    {
      assert(isConsistentRange());
      return extractElementIndex(this->first);
    }
    unsigned int elementEndIndex() const
    {
      assert(isConsistentRange());
      return extractElementIndex(this->second);
    }
    bool empty() const { assert(isConsistentRange()); return this->first == this->second; }
    bool isMeasurementExpected() const { assert(isConsistentRange()); return this->first <= this->second; }
  };
 
   // List of measurement ranges and the measurement container targeted by the ranges.
   template <typename T_MeasurementContainerList >
   class GenMeasurementRangeList : public std::unordered_map<std::size_t, MeasurementRange>
   {
   public:
      using MeasurementContainer = typename T_MeasurementContainerList::measurement_container_variant_t;
      using MeasurementRangeContainer = std::unordered_map<std::size_t, MeasurementRange>;
   private:
      T_MeasurementContainerList m_measurementContainerList;
 
   public:
 
      const std::vector< MeasurementContainer > &measurementContainerList() const { return  m_measurementContainerList.containerList(); }
 
      // set container, resizing if necessary. That is just in case we call addMeasurements out of order or not for 2 types of measurements
      void setContainer(unsigned int container_index, const xAOD::UncalibratedMeasurementContainer *container) {
         if (container) {
            // @TODO allow for container == nullprt ?
            m_measurementContainerList.setContainer(container_index, *container);
         }
      }
      std::size_t numContainers() const { return m_measurementContainerList.size(); }
 
      const MeasurementContainer &container(unsigned index) const { return m_measurementContainerList.at(index); }
   };
 
   // List of measurement ranges and the measurement container targeted by the ranges.
   template <typename T_MeasurementContainerList >
   class GenMeasurementRangeListFlat : public std::vector<std::pair<std::size_t, MeasurementRange>>
   {
   public:
      using MeasurementContainer = typename T_MeasurementContainerList::measurement_container_variant_t;
      using MeasurementRangeContainer = std::vector<std::pair<std::size_t, MeasurementRange>>;
   private:
      T_MeasurementContainerList m_measurementContainerList;
 
   public:
 
      const std::vector< MeasurementContainer > &measurementContainerList() const { return  m_measurementContainerList.containerList(); }
 
      // set container, resizing if necessary. That is just in case we call addMeasurements out of order or not for 2 types of measurements
      void setContainer(unsigned int container_index, const xAOD::UncalibratedMeasurementContainer *container) {
         if (container) {
            // @TODO allow for container == nullprt ?
            m_measurementContainerList.setContainer(container_index, *container);
         }
      }
      std::size_t numContainers() const { return m_measurementContainerList.size(); }
 
      const MeasurementContainer &container(unsigned index) const { return m_measurementContainerList.at(index); }
 
      // required std::unordered_map methods compatible with GenMeasurementRangeList
      MeasurementRangeContainer::const_iterator find(const MeasurementRangeContainer::value_type::first_type &key) const {
        return std::find_if(begin(), end(),
                            [&key](const auto &c) {
                              return c.first == key;
                            });
      }
 
      std::pair<MeasurementRangeContainer::iterator, bool> insert(MeasurementRangeContainer::value_type&& value) {
        emplace_back(std::forward<MeasurementRangeContainer::value_type>(value));
        return {std::prev(end()), true};
      }
   };

  template <typename T_MeasurementRangeList>
  class GenUncalibSourceLinkAccessor
  {
  private:
    const T_MeasurementRangeList *m_measurementRanges;
 
  public:
    using MeasurementContainer = typename T_MeasurementRangeList::MeasurementContainer;
    class BaseIterator
    {
    public:
       BaseIterator(const std::vector< MeasurementContainer > *containerList,
                    unsigned int container_index,
                    unsigned int element_index)
          : m_containerList(containerList),
            m_containerIndex(container_index),
            m_index(element_index)
      {
      }
      BaseIterator &operator++()
      {
        ++m_index;
        return *this;
      }
      bool operator==(const BaseIterator &a) const { return m_index == a.m_index && m_containerIndex == a.m_containerIndex; }
 
      Acts::SourceLink operator*() const
      {
         // @TODO avoid double indirection
         const xAOD::UncalibratedMeasurementContainer *base_container
            = std::visit([](const auto &a) -> const xAOD::UncalibratedMeasurementContainer *{return  a.containerPtr(); },
                         (*m_containerList)[m_containerIndex] );
         assert( m_index < base_container->size());
         return Acts::SourceLink{ makeATLASUncalibSourceLink( (*base_container)[m_index] )};
      }
 
      const std::vector< MeasurementContainer > &measurementContainerList() const { return *m_containerList; }
      unsigned int containerIndex() const { return m_containerIndex; }
      unsigned int index() const { return m_index; }
 
      using value_type = unsigned int;
      using difference_type = unsigned int;
      using pointer = const xAOD::UncalibratedMeasurementContainer **;
      using reference = const xAOD::UncalibratedMeasurementContainer *;
      using iterator_category = std::input_iterator_tag;
 
    private:
       const std::vector< MeasurementContainer > *m_containerList;
       unsigned int m_containerIndex;
       unsigned int m_index;
    };
 
    using Iterator = Acts::SourceLinkAdapterIterator<BaseIterator>;
    GenUncalibSourceLinkAccessor(const T_MeasurementRangeList &measurement_ranges)
        : m_measurementRanges(&measurement_ranges)
    {
    }
    // get the range of elements with requested geoId
    std::pair<Iterator, Iterator> range(const Acts::Surface &surface) const
    {
      typename T_MeasurementRangeList::const_iterator
         range_iter = m_measurementRanges->find(surface.geometryId().value());
      if (range_iter == m_measurementRanges->end())
      {
        return {Iterator(BaseIterator(nullptr, 0u, 0u)),
                Iterator(BaseIterator(nullptr, 0u, 0u))};
      }
 
      return {Iterator(BaseIterator(&measurementContainerList(), range_iter->second.containerIndex(), range_iter->second.elementBeginIndex())),
              Iterator(BaseIterator(&measurementContainerList(), range_iter->second.containerIndex(), range_iter->second.elementEndIndex()))};
    }
    const MeasurementContainer &container(unsigned index) const { return m_measurementRanges->container(index); }
    const std::vector< MeasurementContainer > &measurementContainerList() const { return  m_measurementRanges->measurementContainerList(); }
 
  };
 
  class AtlasMeasurementContainerList : public MeasurementContainerListWithDimension< AtlasMeasurementContainerList,
                                                                                      ContainerRefWithDim<xAOD::PixelClusterContainer,2>,
                                                                                      ContainerRefWithDim<xAOD::StripClusterContainer,1>,
                                                                                      ContainerRefWithDim<xAOD::HGTDClusterContainer,3> >
  {
  public:
 
     template <std::size_t DIM>
     static bool isDimension(const SG::AuxVectorBase &container) {
         static const xAOD::PosAccessor<DIM> acc{"localPositionDim" + std::to_string(DIM)};
         return container.isAvailable(acc.auxid());
     }
 
     // to support 2D and 3D pixel measurements
     // @note to support 3D pixel measurements, still need to add ContainerRefWithDim<xAOD::PixelClusterContainer,3> as
     //       template paramter to MeasurementContainerListWithDimension
     unsigned int getDimension(const xAOD::PixelClusterContainer &container) {
        if (isDimension<2>(container.auxbase())) { return 2u; }
        else if (isDimension<3>(container.auxbase())) { return 3u; }
        else {
           throw std::runtime_error("Unsupported dimension for PixelClusterContainer");
        }
     }
  };
 
  using MeasurementRangeList = GenMeasurementRangeList< AtlasMeasurementContainerList >;
  using MeasurementRangeListFlat = GenMeasurementRangeListFlat< AtlasMeasurementContainerList >;
  using UncalibSourceLinkAccessor = GenUncalibSourceLinkAccessor< MeasurementRangeList >;
 
}
 
#endif