IPhotonMappingTransformations.h

Go to the documentation of this file.

#ifndef LARSIM_PHOTONPROPAGATION_LIBRARYMAPPINGTOOLS_IPHOTONMAPPINGTRANSFORMATIONS_H
#define LARSIM_PHOTONPROPAGATION_LIBRARYMAPPINGTOOLS_IPHOTONMAPPINGTRANSFORMATIONS_H

// LArSoft libraries
#include "larcorealg/CoreUtils/ContainerMeta.h"             // util::collection_value_t<>
#include "larcoreobj/SimpleTypesAndConstants/geo_vectors.h" // geo::Point_t
#include "larsim/PhotonPropagation/LibraryMappingTools/OpDetVisibilityData.h"

// C++ standard libraries
#include <functional> // std::cref()
#include <stdexcept>  // std::out_of_range, std::domain_error
#include <utility>    // std::forward()
#include <vector>

namespace phot {

  class IPhotonMappingTransformations {

  public:
    virtual ~IPhotonMappingTransformations() = default;

    // --- BEGIN Data types ----------------------------------------------------
    using OpDetID_t = int; 

    using LibraryIndex_t = OpDetID_t; // currently bound to channel ID

    using LibraryIndexToOpDetMap = std::vector<OpDetID_t>;

    using OpDetToLibraryIndexMap = std::vector<LibraryIndex_t>; // FIXME former LibOpDetIDmap

    template <typename LibDataColl>
    using MappedOpDetData_t =
      phot::OpDetVisibilityData<util::collection_reference_t<LibDataColl>,
                                util::collection_reference_t<OpDetToLibraryIndexMap const>>;

    // --- END Data types ------------------------------------------------------

    static constexpr OpDetID_t InvalidOpDetID = std::numeric_limits<OpDetID_t>::max();

    static constexpr LibraryIndex_t InvalidLibraryIndex =
      std::numeric_limits<LibraryIndex_t>::max();

    // --- BEGIN Geometry mapping interface ------------------------------------

    virtual geo::Point_t detectorToLibrary(geo::Point_t const& location) const = 0;

    // --- END Geometry mapping interface --------------------------------------

    // --- BEGIN Optical detector mapping interface ----------------------------

    virtual LibraryIndex_t opDetToLibraryIndex(geo::Point_t const& location,
                                               OpDetID_t opDetID) const = 0;

    virtual OpDetID_t libraryIndexToOpDet(geo::Point_t const& location,
                                          LibraryIndex_t libIndex) const = 0;

    virtual OpDetToLibraryIndexMap const& opDetsToLibraryIndices(
      geo::Point_t const& location) const = 0;

    virtual std::size_t opDetMappingSize() const = 0;

    virtual LibraryIndexToOpDetMap const& libraryIndicesToOpDets(
      geo::Point_t const& location) const = 0;

    virtual std::size_t libraryMappingSize(geo::Point_t const& location) const = 0;

    // --- END Optical detector mapping interface ------------------------------

    // --- BEGIN Utility methods -----------------------------------------------

    template <typename Coll>
    MappedOpDetData_t<Coll> applyOpDetMapping(
      OpDetToLibraryIndexMap const& opDetToLibraryMap,
      Coll&& source,
      util::collection_value_t<Coll> defaultValue = {}) const;

    template <typename Coll>
    auto applyOpDetMapping(geo::Point_t const& location,
                           Coll&& source,
                           util::collection_value_t<Coll> defaultValue = {}) const
    {
      return applyOpDetMapping(
        opDetsToLibraryIndices(location), std::forward<Coll>(source), defaultValue);
    }

    // --- END Utility methods -------------------------------------------------

  }; // class IPhotonMappingTransformations

} // namespace phot

//------------------------------------------------------------------------------
//---  Template implementation
//------------------------------------------------------------------------------
template <typename Coll>
auto phot::IPhotonMappingTransformations::applyOpDetMapping(
  OpDetToLibraryIndexMap const& opDetToLibraryMap,
  Coll&& source,
  util::collection_value_t<Coll> defaultValue /* = {} */
) const -> MappedOpDetData_t<Coll>
{

  using std::size;

  // number of available destination slots (i.e. how many optical detectors)
  auto const n = size(opDetToLibraryMap);

  return MappedOpDetData_t<Coll>{util::make_collection_reference(std::forward<Coll>(source)),
                                 std::cref(opDetToLibraryMap) // mapping is referenced
                                 ,
                                 n // size
                                 ,
                                 defaultValue};

} // phot::IPhotonMappingTransformations::applyOpDetMapping()

//------------------------------------------------------------------------------

#endif // LARSIM_PHOTONPROPAGATION_LIBRARYMAPPINGTOOLS_IPHOTONMAPPINGTRANSFORMATIONS_H