BFieldMapUtils.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2017-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/Definitions/Units.hpp"
#include "Acts/MagneticField/InterpolatedBFieldMap.hpp"
#include "Acts/Utilities/detail/AxisFwd.hpp"
#include "Acts/Utilities/detail/Grid.hpp"

#include <array>
#include <cstddef>
#include <functional>
#include <utility>
#include <vector>

// Convenience functions to ease creation of and Acts::InterpolatedBFieldMap
// and to avoid code duplication. Currently implemented for the two most common
// formats: rz and xyz.

namespace Acts {

class SolenoidBField;

Acts::InterpolatedBFieldMap<
    Acts::detail::Grid<Acts::Vector2, Acts::detail::EquidistantAxis,
                       Acts::detail::EquidistantAxis>>
fieldMapRZ(const std::function<size_t(std::array<size_t, 2> binsRZ,
                                      std::array<size_t, 2> nBinsRZ)>&
               localToGlobalBin,
           std::vector<double> rPos, std::vector<double> zPos,
           std::vector<Acts::Vector2> bField,
           double lengthUnit = UnitConstants::mm,
           double BFieldUnit = UnitConstants::T, bool firstQuadrant = false);

Acts::InterpolatedBFieldMap<Acts::detail::Grid<
    Acts::Vector3, Acts::detail::EquidistantAxis, Acts::detail::EquidistantAxis,
    Acts::detail::EquidistantAxis>>
fieldMapXYZ(const std::function<size_t(std::array<size_t, 3> binsXYZ,
                                       std::array<size_t, 3> nBinsXYZ)>&
                localToGlobalBin,
            std::vector<double> xPos, std::vector<double> yPos,
            std::vector<double> zPos, std::vector<Acts::Vector3> bField,
            double lengthUnit = UnitConstants::mm,
            double BFieldUnit = UnitConstants::T, bool firstOctant = false);

Acts::InterpolatedBFieldMap<
    Acts::detail::Grid<Acts::Vector2, Acts::detail::EquidistantAxis,
                       Acts::detail::EquidistantAxis>>
solenoidFieldMap(std::pair<double, double> rlim, std::pair<double, double> zlim,
                 std::pair<size_t, size_t> nbins, const SolenoidBField& field);

}  // namespace Acts