Acts/EventData/TrackStatePropMask.hpp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 CERN for the benefit of the ACTS project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include "Acts/Utilities/EnumBitwiseOperators.hpp"
0012
0013 #include <cstdint>
0014 #include <limits>
0015 #include <ostream>
0016 #include <type_traits>
0017
0018 namespace Acts {
0019
0020 /// Collection of bit masks to enable steering which components of a track state
0021 /// should be initialized, and which should be left invalid.
0022 /// These mask values can be combined using binary operators, so
0023 /// (TrackStatePropMask::Predicted | TrackStatePropMask::Jacobian) will instruct
0024 /// allocating storage for both predicted parameters (including covariance) and
0025 /// a jacobian.
0026 /// The enum is used as a strong type wrapper around the bits to prevent
0027 /// autoconversion from integer
0028 enum struct TrackStatePropMask : std::uint8_t {
0029   None = 0,
0030   Predicted = 1 << 0,
0031   Filtered = 1 << 1,
0032   Smoothed = 1 << 2,
0033   Jacobian = 1 << 3,
0034   Calibrated = 1 << 4,
0035
0036   All = std::numeric_limits<std::uint8_t>::max(),  // should be all ones
0037 };
0038
0039 ACTS_DEFINE_ENUM_BITWISE_OPERATORS(TrackStatePropMask)
0040
0041 std::ostream& operator<<(std::ostream& os, TrackStatePropMask mask);
0042
0043 }  // namespace Acts