ITrackingVolumeHelper.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2016-2018 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/.

// ITrackingVolumeHelper.hpp, Acts project

#pragma once

#include <memory>
#include <string>
#include <vector>
#include "Acts/Utilities/BinningType.hpp"
#include "Acts/Utilities/Definitions.hpp"

namespace Acts {

class Layer;
class TrackingVolume;
class VolumeBounds;
class IVolumeMaterial;

using LayerPtr = std::shared_ptr<const Layer>;
using TrackingVolumePtr = std::shared_ptr<const TrackingVolume>;
using MutableTrackingVolumePtr = std::shared_ptr<TrackingVolume>;
using VolumeBoundsPtr = std::shared_ptr<const VolumeBounds>;

using LayerVector = std::vector<LayerPtr>;
using TrackingVolumeVector = std::vector<TrackingVolumePtr>;
using MutableTrackingVolumeVector = std::vector<MutableTrackingVolumePtr>;

class ITrackingVolumeHelper {
 public:
  virtual ~ITrackingVolumeHelper() = default;

  virtual MutableTrackingVolumePtr createTrackingVolume(
      const GeometryContext& gctx, const LayerVector& layers,
      std::shared_ptr<const IVolumeMaterial> volumeMaterial,
      VolumeBoundsPtr volumeBounds, MutableTrackingVolumeVector mtvVector = {},
      std::shared_ptr<const Transform3D> transform = nullptr,
      const std::string& volumeName = "UndefinedVolume",
      BinningType btype = arbitrary) const = 0;

  virtual MutableTrackingVolumePtr createTrackingVolume(
      const GeometryContext& gctx, const LayerVector& layers,
      MutableTrackingVolumeVector mtvVector,
      std::shared_ptr<const IVolumeMaterial> volumeMaterial, double loc0Min,
      double loc0Max, double loc1Min, double loc1Max,
      const std::string& volumeName = "UndefinedVolume",
      BinningType btype = arbitrary) const = 0;

  virtual MutableTrackingVolumePtr createGapTrackingVolume(
      const GeometryContext& gctx, MutableTrackingVolumeVector& mtvVector,
      std::shared_ptr<const IVolumeMaterial> volumeMaterial, double loc0Min,
      double loc0Max, double loc1Min, double loc1Max,
      unsigned int materialLayers, bool cylinder = true,
      const std::string& volumeName = "UndefinedVolume") const = 0;

  virtual MutableTrackingVolumePtr createGapTrackingVolume(
      const GeometryContext& gctx, MutableTrackingVolumeVector& mtvVector,
      std::shared_ptr<const IVolumeMaterial> volumeMaterial, double loc0Min,
      double loc0Max, double loc1Min, double loc1Max,
      const std::vector<double>& layerPositions, bool cylinder = true,
      const std::string& volumeName = "UndefinedVolume",
      BinningType btype = arbitrary) const = 0;

  virtual MutableTrackingVolumePtr createContainerTrackingVolume(
      const GeometryContext& gctx,
      const TrackingVolumeVector& volumes) const = 0;
};

}  // namespace Acts