PHG4mRICHSteppingAction.cc

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file PHG4mRICHSteppingAction.cc

/*===============================================================*
 *                       March 19th 2017                         *
    mRICH Stepping Action created by Cheuk-Ping Wong @GSU        *
 *===============================================================*/
#include "PHG4mRICHSteppingAction.h"

#include "PHG4mRICHDetector.h"

#include <phparameter/PHParameters.h>

#include <fun4all/Fun4AllBase.h>

#include <g4main/PHG4Hit.h>
#include <g4main/PHG4HitContainer.h>
#include <g4main/PHG4Hitv1.h>
#include <g4main/PHG4Shower.h>
#include <g4main/PHG4SteppingAction.h>  // for PHG4SteppingAction
#include <g4main/PHG4TrackUserInfoV1.h>

#include <TSystem.h>

#include <phool/getClass.h>
#include <phool/phool.h>  // for PHWHERE

#include <Geant4/G4ParticleDefinition.hh>      // for G4ParticleDefinition
#include <Geant4/G4ReferenceCountedHandle.hh>  // for G4ReferenceCountedHandle
#include <Geant4/G4Step.hh>
#include <Geant4/G4StepPoint.hh>   // for G4StepPoint
#include <Geant4/G4StepStatus.hh>  // for fGeomBoundary, fAtRest...
#include <Geant4/G4String.hh>      // for G4String
#include <Geant4/G4SystemOfUnits.hh>
#include <Geant4/G4ThreeVector.hh>            // for G4ThreeVector
#include <Geant4/G4TouchableHandle.hh>        // for G4TouchableHandle
#include <Geant4/G4Track.hh>                  // for G4Track
#include <Geant4/G4TrackStatus.hh>            // for fStopAndKill
#include <Geant4/G4Types.hh>                  // for G4double
#include <Geant4/G4VPhysicalVolume.hh>        // for G4VPhysicalVolume
#include <Geant4/G4VTouchable.hh>             // for G4VTouchable
#include <Geant4/G4VUserTrackInformation.hh>  // for G4VUserTrackInformation

#include <boost/tokenizer.hpp>
// this is an ugly hack, the gcc optimizer has a bug which
// triggers the uninitialized variable warning which
// stops compilation because of our -Werror
#include <boost/version.hpp>  // to get BOOST_VERSION
#if (__GNUC__ == 4 && __GNUC_MINOR__ == 4 && BOOST_VERSION == 105700)
#pragma GCC diagnostic ignored "-Wuninitialized"
#pragma message "ignoring bogus gcc warning in boost header lexical_cast.hpp"
#include <boost/lexical_cast.hpp>
#pragma GCC diagnostic warning "-Wuninitialized"
#else
#include <boost/lexical_cast.hpp>
#endif

#include <cmath>  // for isfinite
#include <iostream>

class PHCompositeNode;

using namespace CLHEP;

//____________________________________________________________________________..
PHG4mRICHSteppingAction::PHG4mRICHSteppingAction(PHG4mRICHDetector* detector, PHParameters* params)
  : PHG4SteppingAction(detector->GetName())
  , detector_(detector)
  ,
  // active(params->get_int_param("active")),
  IsBlackHole(params->get_int_param("blackhole"))
  ,
  // use_g4_steps(params->get_int_param("use_g4steps")),
  detectorname(params->get_string_param("detectorname"))
  , superdetector(params->get_string_param("superdetector"))
  , hits_(nullptr)
  , absorberhits_(nullptr)
  , hit(nullptr)
  , savehitcontainer(nullptr)
  , saveshower(nullptr)
  , savetrackid(-1)
  , savepoststepstatus(-1)
{
}
//____________________________________________________________________________..
PHG4mRICHSteppingAction::~PHG4mRICHSteppingAction()
{
  delete hit;
}
//____________________________________________________________________________..
bool PHG4mRICHSteppingAction::UserSteppingAction(const G4Step* aStep, bool)
{
  G4TouchableHandle touch = aStep->GetPreStepPoint()->GetTouchableHandle();
  G4VPhysicalVolume* volume = touch->GetVolume();

  int isactive = detector_->IsInmRICH(volume);
  if (isactive > PHG4mRICHDetector::INACTIVE)
  {
    // collect energy and track length step by step
    G4double edep = aStep->GetTotalEnergyDeposit() / GeV;
    G4double eion = (aStep->GetTotalEnergyDeposit() - aStep->GetNonIonizingEnergyDeposit()) / GeV;

    const G4Track* aTrack = aStep->GetTrack();

    /* Check if particle is 'geantino' */
    bool geantino = false;
    if (aTrack->GetParticleDefinition()->GetPDGEncoding() == 0 && aTrack->GetParticleDefinition()->GetParticleName().find("geantino") != std::string::npos)
    {
      geantino = true;
    }

    //cout << "Name of volume: " << volume->GetName() << ", isactive = " << isactive << endl;
    // G4VPhysicalVolume* v1 = touch->GetVolume(1);
    // cout << "Name of mother volume: " << v1->GetName() << endl;
    // G4VPhysicalVolume* v2 = touch->GetVolume(2);
    // cout << "Name of grand mother volume: " << v2->GetName() << endl;

    // cout << "copyNum = " << touch->GetReplicaNumber() << ", Or = " << touch->GetReplicaNumber(1) << ", Or = " << touch->GetReplicaNumber(2) << ", Or = " << touch->GetReplicaNumber(3) << endl;
    // int module_id=GetModuleID(touch->GetVolume(2)); // use mother volume to determine module_id
    int module_id = touch->GetReplicaNumber(2) - 1;  // use copy number of mother volume to determine module_id
    int PID = aTrack->GetDefinition()->GetPDGEncoding();
    std::string PName = aTrack->GetDefinition()->GetParticleName();

    //-----------------------------------------------------------------------------------//
    // if this block stops everything, just put all kinetic energy into edep
    if (IsBlackHole)
    {
      edep = aTrack->GetKineticEnergy() / GeV;
      G4Track* killtrack = const_cast<G4Track*>(aTrack);
      killtrack->SetTrackStatus(fStopAndKill);
    }

    /* Get Geant4 pre- and post-step points */
    G4StepPoint* prePoint = aStep->GetPreStepPoint();
    G4StepPoint* postPoint = aStep->GetPostStepPoint();

    switch (prePoint->GetStepStatus())
    {
    //-----------------
    case fGeomBoundary:
      //-----------------
    case fUndefined:
      if (!hit) hit = new PHG4Hitv1();
      /* Set hit location (space point) */
      hit->set_x(0, prePoint->GetPosition().x() / cm);
      hit->set_y(0, prePoint->GetPosition().y() / cm);
      hit->set_z(0, prePoint->GetPosition().z() / cm);

      /* Set hit time */
      hit->set_t(0, prePoint->GetGlobalTime() / nanosecond);

      //set the track ID
      hit->set_trkid(aTrack->GetTrackID());
      savetrackid = aTrack->GetTrackID();

      /* set intial energy deposit */
      hit->set_edep(0);
      hit->set_eion(0);
      if (isactive == PHG4mRICHDetector::SENSOR)
      {
        savehitcontainer = hits_;
        if (PID == 0)
        {
          edep = aTrack->GetKineticEnergy() / GeV;
          G4Track* killtrack = const_cast<G4Track*>(aTrack);
          killtrack->SetTrackStatus(fStopAndKill);
          hit->set_scint_id(module_id);
        }
      }
      else
      {
        savehitcontainer = absorberhits_;
      }

      // here we set what is common for scintillator and absorber hits
      if (G4VUserTrackInformation* p = aTrack->GetUserInformation())
      {
        if (PHG4TrackUserInfoV1* pp = dynamic_cast<PHG4TrackUserInfoV1*>(p))
        {
          hit->set_trkid(pp->GetUserTrackId());
          hit->set_shower_id(pp->GetShower()->get_id());
          saveshower = pp->GetShower();
        }
      }
      break;
      //-----------------
    default:
      break;
    }

    // some sanity checks for inconsistencies
    // check if this hit was created, if not print out last post step status
    if (!hit || !isfinite(hit->get_x(0)))
    {
      std::cout << __FILE__ << "::" << __func__ << "::" << GetName() << ": hit was not created" << std::endl;
      std::cout << "prestep status: " << prePoint->GetStepStatus()
                << ", last post step status: " << savepoststepstatus << std::endl;
      gSystem->Exit(1);
    }
    savepoststepstatus = postPoint->GetStepStatus();

    // check if track id matches the initial one when the hit was created
    if (aTrack->GetTrackID() != savetrackid)
    {
      std::cout << __FILE__ << "::" << __func__ << "::" << GetName() << ": hits do not belong to the same track" << std::endl;
      std::cout << "saved track: " << savetrackid
                << ", current trackid: " << aTrack->GetTrackID()
                << std::endl;
      gSystem->Exit(1);
    }

    //-----------------------------------------------------------------------------------//
    /* Update exit values- will be overwritten with every step until
     * we leave the volume or the particle ceases to exist */
    //-m/s- hit->set_x( 1, postPoint->GetPosition().x() / cm );
    //-m/s- hit->set_y( 1, postPoint->GetPosition().y() / cm );
    //-m/s- hit->set_z( 1, postPoint->GetPosition().z() / cm );

    //-m/s- hit->set_t( 1, postPoint->GetGlobalTime() / nanosecond );

    /* sum up the energy to get total deposited */
    hit->set_edep(hit->get_edep() + edep);
    hit->set_eion(hit->get_eion() + eion);

    if (geantino)
    {
      hit->set_edep(-1);  // only energy=0 g4hits get dropped, this way geantinos survive the g4hit compression
      hit->set_eion(-1);
    }
    if (hit->get_edep() && PID == 0)
    {
      if (G4VUserTrackInformation* p = aTrack->GetUserInformation())
      {
        if (PHG4TrackUserInfoV1* pp = dynamic_cast<PHG4TrackUserInfoV1*>(p))
        {
          pp->SetKeep(1);  // we want to keep the track
        }
      }
    }

    //-----------------------------------------------------------------------------------//
    // if any of these conditions is true this is the last step in
    // this volume and we need to save the hit
    if (postPoint->GetStepStatus() == fGeomBoundary ||
        postPoint->GetStepStatus() == fWorldBoundary ||
        postPoint->GetStepStatus() == fAtRestDoItProc ||
        aTrack->GetTrackStatus() == fStopAndKill)
    {
      // save only hits with energy deposit (or -1 for geantino)
      if (hit->get_edep() && PID == 0)
      {
        savehitcontainer->AddHit(module_id, hit);
        if (saveshower)
        {
          saveshower->add_g4hit_id(hits_->GetID(), hit->get_hit_id());
        }
        // ownership has been transferred to container, set to null
        // so we will create a new hit for the next track
        hit = nullptr;
      }
      else
      {
        // if this hit has no energy deposit, just reset it for reuse
        // this means we have to delete it in the dtor. If this was
        // the last hit we processed the memory is still allocated
        hit->Reset();
      }
    }
    return true;
  }
  else
  {
    return false;
  }
}

//____________________________________________________________________________..
void PHG4mRICHSteppingAction::SetInterfacePointers(PHCompositeNode* topNode)
{
  std::string hitnodename;
  std::string absorbernodename;

  if (superdetector != "NONE")
  {
    hitnodename = "G4HIT_" + superdetector;
    absorbernodename = "G4HIT_ABSORBER_" + superdetector;
  }
  else
  {
    hitnodename = "G4HIT_" + detectorname;
    absorbernodename = "G4HIT_ABSORBER_" + detectorname;
  }

  //now look for the map and grab a pointer to it.
  hits_ = findNode::getClass<PHG4HitContainer>(topNode, hitnodename.c_str());
  absorberhits_ = findNode::getClass<PHG4HitContainer>(topNode, absorbernodename.c_str());

  // if we do not find the node it's messed up.
  if (!hits_)
  {
    if (Verbosity() >= Fun4AllBase::VERBOSITY_SOME) std::cout << __FILE__ << "::" << __func__ << " - unable to find " << hitnodename << std::endl;
  }
  if (!absorberhits_)
  {
    if (Verbosity() >= Fun4AllBase::VERBOSITY_SOME) std::cout << __FILE__ << "::" << __func__ << " - unable to find " << absorbernodename << std::endl;
  }
}
//____________________________________________________________________________..
int PHG4mRICHSteppingAction::GetModuleID(G4VPhysicalVolume* volume)
{
  // G4AssemblyVolumes naming convention:
  //     av_WWW_impr_XXX_YYY_ZZZ
  // where:
  //     WWW - assembly volume instance number
  //     XXX - assembly volume imprint number
  //     YYY - the name of the placed logical volume
  //     ZZZ - the logical volume index inside the assembly volume
  // e.g. av_1_impr_4_mRICH_module_pv_11
  // 4 is the number of the mRICH sector volume
  // mRICH_module: name of mRICH module
  // 11: number of mRICH module logical volume
  // use boost tokenizer to separate the _, then take value
  // after "impr" for mRICH sector volume and after "pv" for mRICH module volume
  // use boost lexical cast for string -> int conversion
  int module_id = -1;
  int sector_id = -1;
  int mRICH_id = -1;

  boost::char_separator<char> sep("_");
  boost::tokenizer<boost::char_separator<char>> tok(volume->GetName(), sep);
  boost::tokenizer<boost::char_separator<char>>::const_iterator tokeniter;

  for (tokeniter = tok.begin(); tokeniter != tok.end(); ++tokeniter)
  {
    if (*tokeniter == "impr")
    {
      ++tokeniter;
      if (tokeniter != tok.end())
      {
        sector_id = boost::lexical_cast<int>(*tokeniter);
      }
      else
      {
        std::cout << PHWHERE << " Error parsing " << volume->GetName()
                  << " for mRICH sector id " << std::endl;
        gSystem->Exit(1);
      }
    }
    else if (*tokeniter == "pv")
    {
      ++tokeniter;
      if (tokeniter != tok.end())
      {
        mRICH_id = boost::lexical_cast<int>(*tokeniter);
      }
      else
      {
        std::cout << PHWHERE << " Error parsing " << volume->GetName()
                  << " for mRICH id " << std::endl;
        gSystem->Exit(1);
      }
    }
  }

  module_id = (sector_id - 1) * 100 + mRICH_id;

  if (Verbosity() >= Fun4AllBase::VERBOSITY_SOME) std::cout << "name of volume: " << volume->GetName() << ", sector_id = " << sector_id << ", mRICH_id = " << mRICH_id << ", module_id = " << module_id << std::endl;
  //cout << endl;

  return module_id;
}