Ray.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file Ray.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2018-2019 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Definitions/Algebra.hpp"
#include "Acts/Visualization/IVisualization3D.hpp"

namespace Acts {

template <typename value_t, size_t DIM>
class Ray {
 public:
  using value_type = value_t;
  using VertexType = Eigen::Matrix<value_t, DIM, 1>;
  using vertex_array_type = Eigen::Array<value_t, DIM, 1>;
  using transform_type = Eigen::Transform<value_t, DIM, Eigen::Affine>;

  Ray(const VertexType& origin, const VertexType& dir);

  const VertexType& origin() const { return m_origin; }

  const VertexType& dir() const { return m_dir; }

  const vertex_array_type& idir() const { return m_idir; }

  Ray<value_t, DIM> transformed(const transform_type& trf) const;

  std::ostream& toStream(std::ostream& os) const;

  template <size_t D = DIM, std::enable_if_t<D == 3, int> = 0>
  void draw(IVisualization3D& helper, value_type far_distance = 10) const;

 private:
  VertexType m_origin;
  VertexType m_dir;
  vertex_array_type m_idir;
};

template <typename T, size_t D>
std::ostream& operator<<(std::ostream& os, const Ray<T, D>& ray) {
  ray.dump(os);
  return os;
}

using Ray3D = Ray<ActsScalar, 3>;

}  // namespace Acts

#include "Acts/Utilities/Ray.ipp"