DetectorCoordinateMap.h

Go to the documentation of this file.

/*
        Copyright 2015, 2017 ETH Zurich, Institute of Particle Physics
        Copyright 2020 Positrigo AG, Zurich
    Copyright (C) 2021 University College London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
 */

#include <fstream>
#include <string>
#include <vector>
#include <random>
#include <map>
#include <boost/algorithm/string.hpp>
#include <boost/unordered_map.hpp>
#ifdef STIR_OPENMP
#  include <omp.h>
#endif

#include "stir/CartesianCoordinate3D.h"
#include "stir/DetectionPosition.h"

#ifndef __stir_DetectorCoordinateMap_H__
#  define __stir_DetectorCoordinateMap_H__

START_NAMESPACE_STIR

class Succeeded;

class DetectorCoordinateMap
{
  struct ihash
  {
    std::size_t operator()(stir::DetectionPosition<> const& detpos) const
    {
      std::size_t seed = 0;
      boost::hash_combine(seed, detpos.axial_coord());
      boost::hash_combine(seed, detpos.radial_coord());
      boost::hash_combine(seed, detpos.tangential_coord());
      return seed;
    }
  };

public:
  typedef boost::unordered_map<stir::DetectionPosition<>, stir::CartesianCoordinate3D<float>, ihash> det_pos_to_coord_type;
  typedef boost::unordered_map<stir::DetectionPosition<>, stir::DetectionPosition<>, ihash> unordered_to_ordered_det_pos_type;

  DetectorCoordinateMap(const std::string& filename, double sigma = 0.0)
      : DetectorCoordinateMap(sigma)
  {
    read_detectormap_from_file(filename);
  }
  DetectorCoordinateMap(const det_pos_to_coord_type& coord_map, double sigma = 0.0)
      : DetectorCoordinateMap(sigma)
  {
    set_detector_map(coord_map);
  }

  void read_detectormap_from_file(const std::string& filename);

  void set_detector_map(const det_pos_to_coord_type& coord_map);

  stir::DetectionPosition<> get_det_pos_for_index(const stir::DetectionPosition<>& index) const
  {
    return input_index_to_det_pos.at(index);
  }
  stir::CartesianCoordinate3D<float> get_coordinate_for_det_pos(const stir::DetectionPosition<>& det_pos) const
  {
    auto coord = det_pos_to_coord.at(det_pos);
    if (sigma == 0.0)
      return coord;

#  ifdef STIR_OPENMP
    auto thread_id = omp_get_thread_num();
#  else
    auto thread_id = 0;
#  endif

    coord.x() += static_cast<float>(distributions[thread_id](generators[thread_id]));
    coord.y() += static_cast<float>(distributions[thread_id](generators[thread_id]));
    coord.z() += static_cast<float>(distributions[thread_id](generators[thread_id]));
    return coord;
  }
  stir::CartesianCoordinate3D<float> get_coordinate_for_index(const stir::DetectionPosition<>& index) const
  {
    return get_coordinate_for_det_pos(get_det_pos_for_index(index));
  }

  Succeeded find_detection_position_given_cartesian_coordinate(DetectionPosition<>& det_pos,
                                                               const CartesianCoordinate3D<float>& cart_coord) const;

  unsigned get_num_tangential_coords() const { return num_tangential_coords; }
  unsigned get_num_axial_coords() const { return num_axial_coords; }
  unsigned get_num_radial_coords() const { return num_radial_coords; }

protected:
  explicit DetectorCoordinateMap(double sigma = 0.0)
      : sigma(sigma)
  {
#  ifdef STIR_OPENMP
    generators.resize(omp_get_max_threads());
    distributions.resize(omp_get_max_threads());
    for (auto& distribution : distributions)
      distribution = std::normal_distribution<double>(0.0, sigma);
#  else
    generators.resize(1);
    distributions.resize(1);
    distributions[0] = std::normal_distribution<double>(0.0, sigma);
#  endif
  }

private:
  unsigned num_tangential_coords;
  unsigned num_axial_coords;
  unsigned num_radial_coords;
  unordered_to_ordered_det_pos_type input_index_to_det_pos;
  det_pos_to_coord_type det_pos_to_coord;
  std::map<stir::CartesianCoordinate3D<float>, stir::DetectionPosition<>>
      detection_position_map_given_cartesian_coord_keys_3_decimal;
  std::map<stir::CartesianCoordinate3D<float>, stir::DetectionPosition<>>
      detection_position_map_given_cartesian_coord_keys_2_decimal;

  const double sigma;
  mutable std::vector<std::default_random_engine> generators;
  mutable std::vector<std::normal_distribution<double>> distributions;

  static det_pos_to_coord_type read_detectormap_from_file_help(const std::string& crystal_map_name);
};

END_NAMESPACE_STIR
#endif