BDSOutputROOTEventSampler.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSOUTPUTROOTEVENTSAMPLER_H
#define BDSOUTPUTROOTEVENTSAMPLER_H
 
#include "Rtypes.h"
#include "TObject.h"
 
#include <string>
#include <vector>
 
class BDSOutputROOTParticleData;
class TTree;
 
#ifndef __ROOTBUILD__ 
#include "globals.hh"
class BDSParticleCoordsFull;
class BDSHitSampler;
class BDSPrimaryVertexInformationV;
#endif
 
template<class U> class BDSOutputROOTEventSampler: public TObject
{
public:
  std::string samplerName; //|| Don't split the header
  
  int                n;
  std::vector<U>     energy;
  std::vector<U>     x;
  std::vector<U>     y;
  U                  z;
  std::vector<U>     xp;
  std::vector<U>     yp;
  std::vector<U>     zp;
  std::vector<U>     p;
  std::vector<U>     T;
 
  std::vector<U>     weight;
  std::vector<int>   partID;
  std::vector<int>   parentID;
  std::vector<int>   trackID;
  int                modelID;
  std::vector<int>   turnNumber;
 
  U                  S;
 
  std::vector<U>     r;
  std::vector<U>     rp;
  std::vector<U>     phi;
  std::vector<U>     phip;
  std::vector<U>     theta;
 
  std::vector<int>     charge;
  std::vector<U>       kineticEnergy;
  std::vector<U>       mass;
  std::vector<U>       rigidity;
  std::vector<bool>    isIon;
  std::vector<int>     ionA;
  std::vector<int>     ionZ;
  std::vector<int>     nElectrons;
 
  std::vector<U>       getKineticEnergy();
  std::vector<U>       getMass();
  std::vector<U>       getRigidity();
  std::vector<bool>    getIsIon();
  std::vector<int>     getIonA();
  std::vector<int>     getIonZ();
  
  BDSOutputROOTEventSampler();
  explicit BDSOutputROOTEventSampler(std::string samplerNameIn);
  virtual ~BDSOutputROOTEventSampler();
#ifndef __ROOTBUILD__
  void Fill(const BDSHitSampler* hit,
            G4bool storeMass          = false,
            G4bool storeCharge        = false,
            G4bool storePolarCoords   = false,
            G4bool storeElectrons     = false,
            G4bool storeRigidity      = false,
            G4bool storeKineticEnergy = false);
  void Fill(const BDSParticleCoordsFull& coords,
            G4double       momentumIn,
            G4double charge,
            G4int    pdgID,
            G4int    turnsTaken,
            G4int    beamlineIndex,
            G4int    nElectronsIn,
            G4double massIn,
            G4double rigidityIn,
            G4bool fillIon = true,
            G4bool* isIon  = nullptr,
            G4int*  ionA   = nullptr,
            G4int*  ionZ   = nullptr);
  void FillPolarCoords(const BDSParticleCoordsFull& coords);  
  void Fill(const BDSPrimaryVertexInformationV* vertexInfos,
            const G4int turnsTaken); 
#endif
  void Fill(const BDSOutputROOTEventSampler<U>* other);
 
  inline void FillIon() {isIon = getIsIon(); ionA = getIonA(); ionZ = getIonZ();}
  
  void SetBranchAddress(TTree *);
  virtual void Flush();  
 
  void FlushLocal(); 
 
  static BDSOutputROOTParticleData* particleTable;
 
  ClassDef(BDSOutputROOTEventSampler,5);
};
 
// This unusually has to be in the header because it's a templated static member, so we need
// the compiler to generate the intialisation for the ones required.
template <class U> BDSOutputROOTParticleData* BDSOutputROOTEventSampler<U>::particleTable = nullptr;
 
#endif