Hit.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#ifndef ALICEO2_EXT_HIT_H
#define ALICEO2_EXT_HIT_H
 
#include "SimulationDataFormat/BaseHits.h" // for BasicXYZEHit
#include "CommonUtils/ShmAllocator.h"
#include "Rtypes.h"
#include "TVector3.h"
#include <iosfwd>
 
namespace o2::ext
{
 
class Hit : public o2::BasicXYZEHit<float, float>
{
 public:
  enum HitStatus_t {
    kTrackEntering = 0x1,
    kTrackInside = 0x1 << 1,
    kTrackExiting = 0x1 << 2,
    kTrackOut = 0x1 << 3,
    kTrackStopped = 0x1 << 4,
    kTrackAlive = 0x1 << 5
  };
 
  Hit() = default;
 
  Hit(int trackID, unsigned short sensorID, const TVector3& startPos, const TVector3& endPos,
      const TVector3& startMom, double startE, double endTime, double eLoss,
      unsigned char startStatus, unsigned char endStatus, int pdg = 0, float length = 0.f)
    : BasicXYZEHit(endPos.X(), endPos.Y(), endPos.Z(), endTime, eLoss, trackID, sensorID),
      mMomentum(startMom.Px(), startMom.Py(), startMom.Pz()),
      mPosStart(startPos.X(), startPos.Y(), startPos.Z()),
      mE(startE),
      mLength(length),
      mPdg(pdg),
      mTrackStatusEnd(endStatus),
      mTrackStatusStart(startStatus)
  {
  }
 
  // entrance position
  math_utils::Point3D<float> GetPosStart() const { return mPosStart; }
  float GetStartX() const { return mPosStart.X(); }
  float GetStartY() const { return mPosStart.Y(); }
  float GetStartZ() const { return mPosStart.Z(); }
  void SetPosStart(const math_utils::Point3D<float>& p) { mPosStart = p; }
 
  // momentum / energy
  math_utils::Vector3D<float> GetMomentum() const { return mMomentum; }
  math_utils::Vector3D<float>& GetMomentum() { return mMomentum; }
  float GetPx() const { return mMomentum.X(); }
  float GetPy() const { return mMomentum.Y(); }
  float GetPz() const { return mMomentum.Z(); }
  float GetE() const { return mE; }
  float GetTotalEnergy() const { return mE; }
 
  // extra bookkeeping
  float GetLength() const { return mLength; }
  void SetLength(float l) { mLength = l; }
  int GetPdg() const { return mPdg; }
  void SetPdg(int pdg) { mPdg = pdg; }
 
  // status flags
  unsigned char GetStatusStart() const { return mTrackStatusStart; }
  unsigned char GetStatusEnd() const { return mTrackStatusEnd; }
  bool IsEntering() const { return mTrackStatusEnd & kTrackEntering; }
  bool IsInside() const { return mTrackStatusEnd & kTrackInside; }
  bool IsExiting() const { return mTrackStatusEnd & kTrackExiting; }
  bool IsOut() const { return mTrackStatusEnd & kTrackOut; }
  bool IsStopped() const { return mTrackStatusEnd & kTrackStopped; }
  bool IsAlive() const { return mTrackStatusEnd & kTrackAlive; }
 
  friend std::ostream& operator<<(std::ostream& of, const Hit& point)
  {
    of << "-I- o2::ext::Hit for track " << point.GetTrackID() << " in sensor " << point.GetDetectorID();
    return of;
  }
 
 private:
  math_utils::Vector3D<float> mMomentum; 
  math_utils::Point3D<float> mPosStart;  
  float mE;                              
  float mLength;                         
  int mPdg;                              
  unsigned char mTrackStatusEnd;         
  unsigned char mTrackStatusStart;       
 
  ClassDefNV(Hit, 1);
};
 
} // namespace o2::ext
 
#ifdef USESHM
namespace std
{
template <>
class allocator<o2::ext::Hit> : public o2::utils::ShmAllocator<o2::ext::Hit>
{
};
} // namespace std
#endif
 
#endif // ALICEO2_EXT_HIT_H