VisualisationTrack.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 ALICE_O2_EVENTVISUALISATION_BASE_VISUALISATIONTRACK_H
#define ALICE_O2_EVENTVISUALISATION_BASE_VISUALISATIONTRACK_H
 
#include "ReconstructionDataFormats/GlobalTrackID.h"
#include "ConversionConstants.h"
#include "VisualisationCluster.h"
#include "rapidjson/document.h"
 
#include <iosfwd>
#include <string>
#include <vector>
#include <array>
#include <cmath>
#include <gsl/span>
 
namespace o2
{
namespace event_visualisation
{
 
 
class VisualisationTrack
{
  friend class VisualisationEventJSONSerializer;
  friend class VisualisationEventROOTSerializer;
  friend class VisualisationEventOpenGLSerializer;
 
 public:
  // Default constructor
  VisualisationTrack();
 
  struct VisualisationTrackVO {
    float time = 0;
    int charge = 0;
    int PID = 0;
    float startXYZ[3];
    float phi = 0;
    float theta = 0;
    float eta = 0;
    o2::dataformats::GlobalTrackID gid = 0;
  };
  // Constructor with properties initialisation
  explicit VisualisationTrack(const VisualisationTrackVO& vo);
 
  VisualisationTrack(const VisualisationTrack& src);
 
  // Add child particle (coming from decay of this particle)
  void addChild(int childID);
  // Add xyz coordinates of the point along the track
  void addPolyPoint(float x, float y, float z);
  void addPolyPoint(const float p[]);
  // Time getter
  [[nodiscard]] float getTime() const { return mTime; }
  // Charge getter
  int getCharge() const { return mCharge; }
  // PID (particle identification code) getter
  int getPID() const { return mPID; }
  // GID  getter
  std::string getGIDAsString() const { return mBGID.asString(); }
  // Source Getter
  [[nodiscard]] o2::dataformats::GlobalTrackID::Source getSource() const { return static_cast<o2::dataformats::GlobalTrackID::Source>(mBGID.getSource()); }
  // Phi  getter
  [[nodiscard]] float getPhi() const { return mPhi; }
  // Theta  getter
  float getTheta() const { return mTheta; }
  //
  const float* getStartCoordinates() const { return mStartCoordinates; }
 
  size_t getPointCount() const { return mPolyX.size(); }
  std::array<float, 3> getPoint(size_t i) const { return std::array<float, 3>{mPolyX[i], mPolyY[i], mPolyZ[i]}; }
 
  VisualisationCluster& addCluster(const float pos[]);
  const VisualisationCluster& getCluster(int i) const { return mClusters[i]; };
  size_t getClusterCount() const { return mClusters.size(); } // Returns number of clusters
  gsl::span<const VisualisationCluster> getClustersSpan() const
  {
    return mClusters;
  }
 
 private:
  // Set coordinates of the beginning of the track
  void addStartCoordinates(const float xyz[3]);
 
  float mTime;                 
  int mCharge;                 
 
  int mPID;                    
  // std::string mGID_obsolete;            /// String representation of gid (obsolete)
  o2::dataformats::GlobalTrackID mBGID; // binary representation of gid
 
  float mStartCoordinates[3]; 
 
  float mTheta; 
  float mPhi;   
  float mEta;
 
  //  std::vector<int> mChildrenIDs; /// Uniqe IDs of children particles
  // o2::dataformats::GlobalTrackID::Source mSource; /// data source of the track (debug)
 
  std::vector<float> mPolyX;
  std::vector<float> mPolyY;
  std::vector<float> mPolyZ;
 
  std::vector<VisualisationCluster> mClusters; 
};
 
} // namespace event_visualisation
} // namespace o2
#endif // ALICE_O2_EVENTVISUALISATION_BASE_VISUALISATIONTRACK_H