|
| 1 | +// Copyright 2019-2020 CERN and copyright holders of ALICE O2. |
| 2 | +// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders. |
| 3 | +// All rights not expressly granted are reserved. |
| 4 | +// |
| 5 | +// This software is distributed under the terms of the GNU General Public |
| 6 | +// License v3 (GPL Version 3), copied verbatim in the file "COPYING". |
| 7 | +// |
| 8 | +// In applying this license CERN does not waive the privileges and immunities |
| 9 | +// granted to it by virtue of its status as an Intergovernmental Organization |
| 10 | +// or submit itself to any jurisdiction. |
| 11 | + |
| 12 | +/// |
| 13 | +/// \file OTFParticle.h |
| 14 | +/// \brief Basic class to hold information regarding a mc particle to be used in fast simulation |
| 15 | +/// \author Jesper Karlsson Gumprecht <jesper.gumprecht@cern.ch> |
| 16 | +/// |
| 17 | + |
| 18 | +#ifndef ALICE3_CORE_OTFPARTICLE_H_ |
| 19 | +#define ALICE3_CORE_OTFPARTICLE_H_ |
| 20 | + |
| 21 | +#include <CommonConstants/MathConstants.h> |
| 22 | + |
| 23 | +#include <array> |
| 24 | +#include <bitset> |
| 25 | +#include <cmath> |
| 26 | +#include <cstdint> |
| 27 | +#include <span> |
| 28 | + |
| 29 | +namespace o2::upgrade |
| 30 | +{ |
| 31 | + |
| 32 | +enum class DecayerBits { ProducedByDecayer = 0, |
| 33 | + IsPrimary, |
| 34 | + IsAlive }; |
| 35 | + |
| 36 | +class OTFParticle |
| 37 | +{ |
| 38 | + public: |
| 39 | + OTFParticle() = default; |
| 40 | + |
| 41 | + template <typename TParticle> |
| 42 | + explicit OTFParticle(const TParticle& particle) |
| 43 | + { |
| 44 | + mPdgCode = particle.pdgCode(); |
| 45 | + mGlobalIndex = particle.globalIndex(); |
| 46 | + mCollisionId = particle.mcCollisionId(); |
| 47 | + mPx = particle.px(); |
| 48 | + mPy = particle.py(); |
| 49 | + mPz = particle.pz(); |
| 50 | + mE = particle.e(); |
| 51 | + mVx = particle.vx(); |
| 52 | + mVy = particle.vy(); |
| 53 | + mVz = particle.vz(); |
| 54 | + mVt = particle.vt(); |
| 55 | + mFlag = particle.flags(); |
| 56 | + mStatusCode = particle.statusCode(); |
| 57 | + mIsFromMcParticles = true; |
| 58 | + if (particle.has_mothers()) { |
| 59 | + mIndicesMother = {particle.mothersIds().front(), particle.mothersIds().back()}; |
| 60 | + } |
| 61 | + if constexpr (requires { particle.decayerBits(); }) { |
| 62 | + mBits = particle.decayerBits(); |
| 63 | + } else { |
| 64 | + // If we are here, we created particle in the standard workflow -- without secondaries |
| 65 | + // Then we should set all particles as physical primaries accordingly |
| 66 | + setBitOn(DecayerBits::IsPrimary); |
| 67 | + } |
| 68 | + } |
| 69 | + |
| 70 | + // Setters |
| 71 | + void setIsPrimary(const bool isPrimary) { mIsPrimary = isPrimary; } |
| 72 | + void setCollisionId(const int collisionId) { mCollisionId = collisionId; } |
| 73 | + void setPDG(const int pdg) { mPdgCode = pdg; } |
| 74 | + void setIndicesMother(const int start, const int stop) { mIndicesMother = {start, stop}; } |
| 75 | + void setIndicesDaughter(const int start, const int stop) { mIndicesDaughter = {start, stop}; } |
| 76 | + void setProductionTime(const float vt) { mVt = vt; } |
| 77 | + void setFlags(uint8_t flag) { mFlag = flag; } |
| 78 | + void setVxVyVz(const float vx, const float vy, const float vz) |
| 79 | + { |
| 80 | + mVx = vx; |
| 81 | + mVy = vy; |
| 82 | + mVz = vz; |
| 83 | + } |
| 84 | + void setPxPyPzE(const float px, const float py, const float pz, const float e) |
| 85 | + { |
| 86 | + mPx = px; |
| 87 | + mPy = py; |
| 88 | + mPz = pz; |
| 89 | + mE = e; |
| 90 | + } |
| 91 | + |
| 92 | + // Getters |
| 93 | + int pdgCode() const { return mPdgCode; } |
| 94 | + int globalIndex() const { return mGlobalIndex; } |
| 95 | + int collisionId() const { return mCollisionId; } |
| 96 | + bool isAlive() const { return mIsAlive; } |
| 97 | + bool isPrimary() const { return mIsPrimary; } |
| 98 | + bool isFromMcParticles() const { return mIsFromMcParticles; } |
| 99 | + float weight() const |
| 100 | + { |
| 101 | + static constexpr float Weight = 1.f; |
| 102 | + return Weight; |
| 103 | + } |
| 104 | + uint8_t flags() const { return mFlag; } |
| 105 | + int statusCode() const { return mStatusCode; } |
| 106 | + float vx() const { return mVx; } |
| 107 | + float vy() const { return mVy; } |
| 108 | + float vz() const { return mVz; } |
| 109 | + float vt() const { return mVt; } |
| 110 | + float px() const { return mPx; } |
| 111 | + float py() const { return mPy; } |
| 112 | + float pz() const { return mPz; } |
| 113 | + float e() const { return mE; } |
| 114 | + float radius() const { return std::hypot(mVx, mVy); } |
| 115 | + float r() const { return radius(); } |
| 116 | + float pt() const { return std::hypot(mPx, mPy); } |
| 117 | + float p() const { return std::hypot(mPx, mPy, mPz); } |
| 118 | + float phi() const { return o2::constants::math::PI + std::atan2(-1.0f * py(), -1.0f * px()); } |
| 119 | + float eta() const |
| 120 | + { |
| 121 | + // Conditionally defined to avoid FPEs |
| 122 | + // As https://github.com/AliceO2Group/AliceO2/blob/dev/Framework/Core/include/Framework/AnalysisDataModel.h#L1959 |
| 123 | + static constexpr float Tolerance = 1e-7f; |
| 124 | + if ((p() - mPz) < Tolerance) { |
| 125 | + return (mPz < 0.0f) ? -100.0f : 100.0f; |
| 126 | + } else { |
| 127 | + return 0.5f * std::log((p() + mPz) / (p() - mPz)); |
| 128 | + } |
| 129 | + } |
| 130 | + float y() const |
| 131 | + { |
| 132 | + // Conditionally defined to avoid FPEs |
| 133 | + // As https://github.com/AliceO2Group/AliceO2/blob/dev/Framework/Core/include/Framework/AnalysisDataModel.h#L1980 |
| 134 | + static constexpr float Tolerance = 1e-7f; |
| 135 | + if ((e() - mPz) < Tolerance) { |
| 136 | + return (mPz < 0.0f) ? -100.0f : 100.0f; |
| 137 | + } else { |
| 138 | + return 0.5f * std::log((mE + mPz) / (mE - mPz)); |
| 139 | + } |
| 140 | + } |
| 141 | + int getMotherIndexStart() const { return mIndicesMother[0]; } |
| 142 | + int getMotherIndexStop() const { return mIndicesMother[1]; } |
| 143 | + int getDaughterIndexStart() const { return mIndicesDaughter[0]; } |
| 144 | + int getDaughterIndexStop() const { return mIndicesDaughter[1]; } |
| 145 | + std::array<int, 2> getMothers() const { return mIndicesMother; } |
| 146 | + std::array<int, 2> getDaughters() const { return mIndicesDaughter; } |
| 147 | + std::span<const int> getMotherSpan() const { return hasMothers() ? std::span<const int>(mIndicesMother.data(), 2) : std::span<const int>(); } |
| 148 | + |
| 149 | + // Checks |
| 150 | + bool hasDaughters() const { return (mIndicesDaughter[0] > 0); } |
| 151 | + bool hasMothers() const { return (mIndicesMother[0] > 0); } |
| 152 | + bool hasNaN() const |
| 153 | + { |
| 154 | + return std::isnan(mPx) || std::isnan(mPy) || std::isnan(mPz) || std::isnan(mE) || |
| 155 | + std::isnan(mVx) || std::isnan(mVy) || std::isnan(mVz); |
| 156 | + } |
| 157 | + bool hasIndex() const |
| 158 | + { |
| 159 | + return (mGlobalIndex != -1); |
| 160 | + } |
| 161 | + |
| 162 | + // Bits |
| 163 | + bool checkBit(DecayerBits bit) const { return mBits.test(static_cast<size_t>(bit)); } |
| 164 | + void setBit(DecayerBits bit, bool value = true) { mBits.set(static_cast<size_t>(bit), value); } |
| 165 | + void setBitOn(DecayerBits bit) { mBits.set(static_cast<size_t>(bit), true); } |
| 166 | + void setBitOff(DecayerBits bit) { mBits.set(static_cast<size_t>(bit), false); } |
| 167 | + |
| 168 | + std::bitset<8> getBits() const { return mBits; } |
| 169 | + uint8_t getBitsValue() const { return static_cast<uint8_t>(mBits.to_ulong()); } |
| 170 | + void setBits(std::bitset<8> bits) { mBits = bits; } |
| 171 | + |
| 172 | + private: |
| 173 | + int mPdgCode{}, mGlobalIndex{-1}; |
| 174 | + int mCollisionId{}; |
| 175 | + float mVx{}, mVy{}, mVz{}, mVt{}; |
| 176 | + float mPx{}, mPy{}, mPz{}, mE{}; |
| 177 | + bool mIsAlive{}, mIsFromMcParticles{false}; |
| 178 | + bool mIsPrimary{}; |
| 179 | + |
| 180 | + int mStatusCode{}; |
| 181 | + uint8_t mFlag{}; |
| 182 | + std::bitset<8> mBits{}; |
| 183 | + std::array<int, 2> mIndicesMother{-1, -1}, mIndicesDaughter{-1, -1}; |
| 184 | +}; |
| 185 | + |
| 186 | +} // namespace o2::upgrade |
| 187 | +#endif // ALICE3_CORE_OTFPARTICLE_H_ |
0 commit comments