LayerBuilderT.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file LayerBuilderT.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/.

#pragma once

#include "Acts/Definitions/Algebra.hpp"
#include "Acts/Geometry/ApproachDescriptor.hpp"
#include "Acts/Geometry/DetectorElementBase.hpp"
#include "Acts/Geometry/GeometryContext.hpp"
#include "Acts/Geometry/ILayerBuilder.hpp"
#include "Acts/Geometry/Layer.hpp"
#include "Acts/Geometry/LayerCreator.hpp"
#include "Acts/Geometry/ProtoLayer.hpp"
#include "Acts/Material/HomogeneousSurfaceMaterial.hpp"
#include "Acts/Material/Material.hpp"
#include "Acts/Material/MaterialSlab.hpp"
#include "Acts/Surfaces/Surface.hpp"
#include "Acts/Utilities/Logger.hpp"
#include "ActsExamples/GenericDetector/GenericDetectorElement.hpp"
#include "ActsExamples/GenericDetector/ProtoLayerCreatorT.hpp"

#include <iostream>

namespace ActsExamples {
namespace Generic {

using Acts::VectorHelpers::eta;
using Acts::VectorHelpers::perp;
using Acts::VectorHelpers::phi;

using SurfacePosition = std::pair<const Acts::Surface*, Acts::Vector3>;

template <typename detector_element_t>
class LayerBuilderT : public Acts::ILayerBuilder {
 public:
  struct Config {
    std::string layerIdentification = "";

    std::vector<ProtoLayerSurfaces> centralProtoLayers;

    std::vector<int> centralLayerMaterialConcentration;
    std::vector<std::shared_ptr<const Acts::ISurfaceMaterial>>
        centralLayerMaterial;

    std::vector<ProtoLayerSurfaces> negativeProtoLayers;

    std::vector<ProtoLayerSurfaces> positiveProtoLayers;

    std::vector<int> posnegLayerMaterialConcentration;

    std::vector<std::shared_ptr<const Acts::ISurfaceMaterial>>
        posnegLayerMaterial;

    std::shared_ptr<const Acts::LayerCreator> layerCreator = nullptr;
    std::shared_ptr<const Acts::ILayerBuilder> centralPassiveLayerBuilder =
        nullptr;
    std::shared_ptr<const Acts::ILayerBuilder> posnegPassiveLayerBuilder =
        nullptr;
  };

  LayerBuilderT(const Config& cfg,
                std::unique_ptr<const Acts::Logger> logger =
                    Acts::getDefaultLogger("LayerBuilderT",
                                           Acts::Logging::INFO));

  const Acts::LayerVector negativeLayers(
      const Acts::GeometryContext& gctx) const override;

  const Acts::LayerVector centralLayers(
      const Acts::GeometryContext& gctx) const override;

  const Acts::LayerVector positiveLayers(
      const Acts::GeometryContext& gctx) const override;

  const std::string& identification() const override {
    return m_cfg.layerIdentification;
  }

 private:
  const Acts::LayerVector constructEndcapLayers(
      const Acts::GeometryContext& gctx, int side) const;

  Config m_cfg;

  const Acts::Logger& logger() const { return *m_logger; }

  std::unique_ptr<const Acts::Logger> m_logger;
};

template <typename detector_element_t>
const Acts::LayerVector LayerBuilderT<detector_element_t>::centralLayers(
    const Acts::GeometryContext& gctx) const {
  // create the vector
  Acts::LayerVector cLayers;
  cLayers.reserve(m_cfg.centralProtoLayers.size());
  // the layer counter
  size_t icl = 0;
  for (auto& cpl : m_cfg.centralProtoLayers) {
    // create the layer actually
    Acts::MutableLayerPtr cLayer = m_cfg.layerCreator->cylinderLayer(
        gctx, cpl.surfaces, cpl.bins0, cpl.bins1, cpl.protoLayer);

    // the layer is built let's see if it needs material
    if (!m_cfg.centralLayerMaterial.empty()) {
      std::shared_ptr<const Acts::ISurfaceMaterial> layerMaterialPtr =
          m_cfg.centralLayerMaterial.at(icl);
      // central material
      if (m_cfg.centralLayerMaterialConcentration.at(icl) == 0.) {
        // the layer surface is the material surface
        cLayer->surfaceRepresentation().assignSurfaceMaterial(layerMaterialPtr);
        ACTS_VERBOSE("- and material at central layer surface.");
      } else {
        // approach surface material
        // get the approach descriptor - at this stage we know that the
        // approachDescriptor exists
        auto approachSurfaces =
            cLayer->approachDescriptor()->containedSurfaces();
        if (m_cfg.centralLayerMaterialConcentration.at(icl) > 0) {
          auto mutableOuterSurface =
              const_cast<Acts::Surface*>(approachSurfaces.at(1));
          mutableOuterSurface->assignSurfaceMaterial(layerMaterialPtr);
          ACTS_VERBOSE("- and material at outer approach surface");
        } else {
          auto mutableInnerSurface =
              const_cast<Acts::Surface*>(approachSurfaces.at(0));
          mutableInnerSurface->assignSurfaceMaterial(layerMaterialPtr);
          ACTS_VERBOSE("- and material at inner approach surface");
        }
      }
    }
    // push it into the layer vector
    cLayers.push_back(cLayer);
    ++icl;
  }
  return cLayers;
}

template <typename detector_element_t>
const Acts::LayerVector LayerBuilderT<detector_element_t>::negativeLayers(
    const Acts::GeometryContext& gctx) const {
  return constructEndcapLayers(gctx, -1);
}

template <typename detector_element_t>
const Acts::LayerVector LayerBuilderT<detector_element_t>::positiveLayers(
    const Acts::GeometryContext& gctx) const {
  return constructEndcapLayers(gctx, 1);
}

template <typename detector_element_t>
LayerBuilderT<detector_element_t>::LayerBuilderT(
    const LayerBuilderT<detector_element_t>::Config& cfg,
    std::unique_ptr<const Acts::Logger> log)
    : Acts::ILayerBuilder(), m_cfg(cfg), m_logger(std::move(log)) {}

template <typename detector_element_t>
const Acts::LayerVector
LayerBuilderT<detector_element_t>::constructEndcapLayers(
    const Acts::GeometryContext& gctx, int side) const {
  // The from negative or positive proto layers
  const auto& protoLayers =
      (side < 0) ? m_cfg.negativeProtoLayers : m_cfg.positiveProtoLayers;

  // create the vector
  Acts::LayerVector eLayers;
  eLayers.reserve(protoLayers.size());

  // the layer counter
  size_t ipnl = 0;
  // loop over the proto layers and create the actual layers
  for (auto& ple : protoLayers) {
    Acts::MutableLayerPtr eLayer = m_cfg.layerCreator->discLayer(
        gctx, ple.surfaces, ple.bins0, ple.bins1, ple.protoLayer);

    // the layer is built let's see if it needs material
    if (!m_cfg.posnegLayerMaterial.empty()) {
      std::shared_ptr<const Acts::ISurfaceMaterial> layerMaterialPtr =
          m_cfg.posnegLayerMaterial[ipnl];
      // central material
      if (m_cfg.posnegLayerMaterialConcentration.at(ipnl) == 0.) {
        // assign the surface material - the layer surface is the material
        // surface
        eLayer->surfaceRepresentation().assignSurfaceMaterial(layerMaterialPtr);
        ACTS_VERBOSE("- and material at central layer surface.");
      } else {
        // approach surface material
        // get the approach descriptor - at this stage we know that the
        // approachDescriptor exists
        auto approachSurfaces =
            eLayer->approachDescriptor()->containedSurfaces();
        if (m_cfg.posnegLayerMaterialConcentration.at(ipnl) > 0.) {
          int sf = side < 0 ? 0 : 1;
          auto mutableInnerSurface =
              const_cast<Acts::Surface*>(approachSurfaces.at(sf));
          mutableInnerSurface->assignSurfaceMaterial(layerMaterialPtr);
          ACTS_VERBOSE("- and material at outer approach surfaces.");
        } else {
          int sf = side < 0 ? 1 : 0;
          auto mutableOuterSurface =
              const_cast<Acts::Surface*>(approachSurfaces.at(sf));
          mutableOuterSurface->assignSurfaceMaterial(layerMaterialPtr);
          ACTS_VERBOSE("- and material at inner approach surfaces.");
        }
      }
    }
    // push it into the layer vector
    eLayers.push_back(eLayer);
    ++ipnl;
  }
  return eLayers;
}

}  // end of namespace Generic
}  // end of namespace ActsExamples