CylinderBounds.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2016-2020 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/Definitions/Tolerance.hpp"
#include "Acts/Surfaces/BoundaryCheck.hpp"
#include "Acts/Surfaces/SurfaceBounds.hpp"
#include "Acts/Utilities/detail/periodic.hpp"

#include <array>
#include <cmath>
#include <cstddef>
#include <iostream>
#include <stdexcept>
#include <vector>

namespace Acts {

class CylinderBounds : public SurfaceBounds {
 public:
  enum BoundValues : int {
    eR = 0,
    eHalfLengthZ = 1,
    eHalfPhiSector = 2,
    eAveragePhi = 3,
    eBevelMinZ = 4,
    eBevelMaxZ = 5,
    eSize = 6
  };

  CylinderBounds() = delete;

  CylinderBounds(double r, double halfZ, double halfPhi = M_PI,
                 double avgPhi = 0., double bevelMinZ = 0.,
                 double bevelMaxZ = 0.) noexcept(false)
      : m_values({r, halfZ, halfPhi, avgPhi, bevelMinZ, bevelMaxZ}),
        m_closed(std::abs(halfPhi - M_PI) < s_epsilon) {
    checkConsistency();
  }

  CylinderBounds(const std::array<double, eSize>& values) noexcept(false)
      : m_values(values),
        m_closed(std::abs(values[eHalfPhiSector] - M_PI) < s_epsilon) {
    checkConsistency();
  }

  ~CylinderBounds() override = default;

  BoundsType type() const final;

  std::vector<double> values() const final;

  bool inside(const Vector2& lposition,
              const BoundaryCheck& bcheck) const final;

  bool inside3D(const Vector3& position,
                const BoundaryCheck& bcheck = true) const;

  double get(BoundValues bValue) const { return m_values[bValue]; }

  bool coversFullAzimuth() const;

  std::vector<Vector3> createCircles(const Transform3 trans, size_t lseg) const;

  std::ostream& toStream(std::ostream& sl) const final;

 private:
  std::array<double, eSize> m_values;
  bool m_closed{false};

  void checkConsistency() noexcept(false);

  Vector2 shifted(const Vector2& lposition) const;

  ActsMatrix<2, 2> jacobian() const;
};

inline std::vector<double> CylinderBounds::values() const {
  std::vector<double> valvector;
  valvector.insert(valvector.begin(), m_values.begin(), m_values.end());
  return valvector;
}

inline bool CylinderBounds::coversFullAzimuth() const {
  return m_closed;
}

inline void CylinderBounds::checkConsistency() noexcept(false) {
  if (get(eR) <= 0.) {
    throw std::invalid_argument("CylinderBounds: invalid radial setup.");
  }
  if (get(eHalfLengthZ) <= 0.) {
    throw std::invalid_argument("CylinderBounds: invalid length setup.");
  }
  if (get(eHalfPhiSector) <= 0. or get(eHalfPhiSector) > M_PI) {
    throw std::invalid_argument("CylinderBounds: invalid phi sector setup.");
  }
  if (get(eAveragePhi) != detail::radian_sym(get(eAveragePhi))) {
    throw std::invalid_argument("CylinderBounds: invalid phi positioning.");
  }
  if (get(eBevelMinZ) != detail::radian_sym(get(eBevelMinZ))) {
    throw std::invalid_argument("CylinderBounds: invalid bevel at min Z.");
  }
  if (get(eBevelMaxZ) != detail::radian_sym(get(eBevelMaxZ))) {
    throw std::invalid_argument("CylinderBounds: invalid bevel at max Z.");
  }
}

}  // namespace Acts