AuxDetChannelMapAlg.h

Go to the documentation of this file.

#ifndef GEO_AUXDETCHANNELMAPALG_H
#define GEO_AUXDETCHANNELMAPALG_H

#include "larcoreobj/SimpleTypesAndConstants/geo_vectors.h"

// C/C++ standard libraries
#include <cstddef>
#include <cstdint>
#include <map>
#include <string>
#include <vector>

namespace geo {

  // forward-declaration from geometry
  struct AuxDetGeometryData_t;
  class AuxDetGeo;

  class AuxDetChannelMapAlg {

    using chanAndSV = std::pair<uint32_t, size_t>;

  public:
    virtual ~AuxDetChannelMapAlg() = default;

    virtual void Initialize(AuxDetGeometryData_t& geodata) = 0;
    virtual void Uninitialize() = 0;

    // method returns the entry in the sorted AuxDetGeo vector so that the
    // Geometry in turn can return that object
    virtual size_t NearestAuxDet(Point_t const& point,
                                 std::vector<AuxDetGeo> const& auxDets,
                                 double tolerance = 0) const;
    virtual size_t NearestSensitiveAuxDet(Point_t const& point,
                                          std::vector<AuxDetGeo> const& auxDets,
                                          size_t& ad,
                                          double tolerance = 0) const;
    virtual size_t ChannelToAuxDet(std::vector<AuxDetGeo> const& auxDets,
                                   std::string const& detName,
                                   uint32_t channel) const;
    virtual std::pair<size_t, size_t> ChannelToSensitiveAuxDet(
      std::vector<AuxDetGeo> const& auxDets,
      std::string const& detName,
      uint32_t channel) const;

    // Experiments must implement these method. It accounts for auxiliary detectors like
    // Multiwire proportional chambers where there is only a single sensitive volume, but
    // multiple channels running through that volume.
    virtual uint32_t PositionToAuxDetChannel(Point_t const& worldLoc,
                                             std::vector<AuxDetGeo> const& auxDets,
                                             size_t& ad,
                                             size_t& sv) const = 0;

    virtual Point_t AuxDetChannelToPosition(uint32_t channel,
                                            std::string const& auxDetName,
                                            std::vector<AuxDetGeo> const& auxDets) const = 0;

  protected:
    std::map<size_t, std::string> fADGeoToName; 
    std::map<std::string, size_t> fNameToADGeo; 
    std::map<size_t, std::vector<chanAndSV>>
      fADGeoToChannelAndSV; 
  };
}
#endif // GEO_AUXDETCHANNELMAPALG_H