PHG4HcalPrototypeSteppingAction.cc

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

// This is the steppingaction code for the hcal prototype
// created on 1/27/2014, Liang, HeXC
//
#include "PHG4HcalPrototypeSteppingAction.h"
#include "PHG4HcalPrototypeDetector.h"

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

#include <phool/getClass.h>

#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, fUndefined
#include <Geant4/G4String.hh>                 // for G4String
#include <Geant4/G4SystemOfUnits.hh>          // for cm, GeV, nanosecond
#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 G4int, G4double
#include <Geant4/G4VPhysicalVolume.hh>        // for G4VPhysicalVolume
#include <Geant4/G4VTouchable.hh>             // for G4VTouchable
#include <Geant4/G4VUserTrackInformation.hh>  // for G4VUserTrackInformation

#include <iostream>
#include <string>  // for operator+, string, ope...

class PHCompositeNode;

using namespace std;
//____________________________________________________________________________..
PHG4HcalPrototypeSteppingAction::PHG4HcalPrototypeSteppingAction(PHG4HcalPrototypeDetector* detector)
  : PHG4SteppingAction(detector->GetName())
  , detector_(detector)
  , hits_(nullptr)
  , absorberhits_(nullptr)
  , hit(nullptr)
{
}

//____________________________________________________________________________..
bool PHG4HcalPrototypeSteppingAction::UserSteppingAction(const G4Step* aStep, bool)
{
  G4TouchableHandle touch = aStep->GetPreStepPoint()->GetTouchableHandle();
  // get volume of the current step
  G4VPhysicalVolume* volume = touch->GetVolume();

  // We simply use ourown scintID to test on this condition
  //  int whichactive = detector_->IsInHcalPrototype(volume);

  /*
    if (!whichactive)
    {
    return false;
    }
  */

  // 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();

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

  // Add detector element ID into to the hit

  G4int scintSheetCopyNumber, scintSheetLayerNumber;

  G4int sectionID = 0;
  G4int scintID = 0x0;
  //  G4int absID = 0;

  if (volume->GetName() == "hcal1AbsLayer")
  {
    sectionID = 1;
    //      absID = volume->GetCopyNo()+100;   // Inner section absorber layer ID's are 100, 101, ..., 115
    scintID = -1;  // scintID is not valid, we set it to -1
  }
  else if (volume->GetName() == "hcal2AbsLayer")
  {
    sectionID = 2;
    //      absID = volume->GetCopyNo()+200;   // Outer section absorber layer ID's are 200, 201, ..., 215
    scintID = -1;  // scintID is not valid, we set it to -1
  }
  else if (volume->GetName() == "inner1USheet")
  {
    sectionID = 1;
    scintSheetCopyNumber = volume->GetCopyNo();  // either 1 or 0
    scintSheetLayerNumber = aStep->GetPreStepPoint()->GetTouchableHandle()->GetVolume(1)->GetCopyNo();
    scintID = (scintSheetLayerNumber << 2) + (1 << 1) + scintSheetCopyNumber;
    //      absID = -1;                        // absID is not valid, we set it to -1
    //G4cout << " **************** scintID: " << scintID << G4endl;
  }
  else if (volume->GetName() == "inner2USheet")
  {
    sectionID = 1;
    scintSheetCopyNumber = volume->GetCopyNo();  // either 1 or 0
    scintSheetLayerNumber = aStep->GetPreStepPoint()->GetTouchableHandle()->GetVolume(1)->GetCopyNo();
    scintID = (scintSheetLayerNumber << 2) + (0 << 1) + scintSheetCopyNumber;
    //      absID = -1;                        // absID is not valid, we set it to -1
    //G4cout << " **************** scintID: " << scintID << G4endl;
  }
  else if (volume->GetName() == "outer1USheet")
  {
    sectionID = 2;
    scintSheetCopyNumber = volume->GetCopyNo();  // either 1 or 0
    scintSheetLayerNumber = aStep->GetPreStepPoint()->GetTouchableHandle()->GetVolume(1)->GetCopyNo();
    scintID = (scintSheetLayerNumber << 2) + (1 << 1) + scintSheetCopyNumber;
    //      absID = -1;                        // absID is not valid, we set it to -1
    //G4cout << " **************** scintID: " << scintID << G4endl;
  }
  else if (volume->GetName() == "outer2USheet")
  {
    sectionID = 2;
    scintSheetCopyNumber = volume->GetCopyNo();  // either 1 or 0
    scintSheetLayerNumber = aStep->GetPreStepPoint()->GetTouchableHandle()->GetVolume(1)->GetCopyNo();
    scintID = (scintSheetLayerNumber << 2) + (0 << 1) + scintSheetCopyNumber;
    //      absID = -1;                        // absID is not valid, we set it to -1
    //G4cout << " **************** scintID: " << scintID << G4endl;
  }
  else
  {
    return false;
  }

  // make sure we are in a volume
  if (detector_->IsActive())
  {
    bool geantino = false;
    // the check for the pdg code speeds things up, I do not want to make
    // an expensive string compare for every track when we know
    // geantino or chargedgeantino has pid=0
    if (aTrack->GetParticleDefinition()->GetPDGEncoding() == 0 &&
        aTrack->GetParticleDefinition()->GetParticleName().find("geantino") != string::npos)
    {
      geantino = true;
    }

    G4StepPoint* prePoint = aStep->GetPreStepPoint();
    G4StepPoint* postPoint = aStep->GetPostStepPoint();
    //       cout << "track id " << aTrack->GetTrackID() << endl;
    //       cout << "time prepoint: " << prePoint->GetGlobalTime() << endl;
    //       cout << "time postpoint: " << postPoint->GetGlobalTime() << endl;
    switch (prePoint->GetStepStatus())
    {
    case fGeomBoundary:
    case fUndefined:
      hit = new PHG4Hitv1();
      hit->set_layer((unsigned int) sectionID);
      hit->set_scint_id(scintID);
      //here we set the entrance values in cm
      hit->set_x(0, prePoint->GetPosition().x() / cm);
      hit->set_y(0, prePoint->GetPosition().y() / cm);
      hit->set_z(0, prePoint->GetPosition().z() / cm);
      // time in ns
      hit->set_t(0, prePoint->GetGlobalTime() / nanosecond);
      //set the track ID
      {
        hit->set_trkid(aTrack->GetTrackID());
        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());
          }
        }
      }

      //set the initial energy deposit
      hit->set_edep(0);
      hit->set_eion(0);
      if (scintID > 0)  // return of isinHcalTestDetector, > 0 hit in scintillator, < 0 hit in absorber
      {
        // Now add the hit
        hits_->AddHit(sectionID, hit);

        {
          if (G4VUserTrackInformation* p = aTrack->GetUserInformation())
          {
            if (PHG4TrackUserInfoV1* pp = dynamic_cast<PHG4TrackUserInfoV1*>(p))
            {
              pp->GetShower()->add_g4hit_id(hits_->GetID(), hit->get_hit_id());
            }
          }
        }
      }
      else
      {
        absorberhits_->AddHit(sectionID, hit);

        {
          if (G4VUserTrackInformation* p = aTrack->GetUserInformation())
          {
            if (PHG4TrackUserInfoV1* pp = dynamic_cast<PHG4TrackUserInfoV1*>(p))
            {
              pp->GetShower()->add_g4hit_id(absorberhits_->GetID(), hit->get_hit_id());
            }
          }
        }
      }
      break;
    default:
      break;
    }

    // here we just update the exit values, it will be overwritten
    // for every step until we leave the volume or the particle
    // ceases to exist
    hit->set_x(1, postPoint->GetPosition().x() / cm);
    hit->set_y(1, postPoint->GetPosition().y() / cm);
    hit->set_z(1, postPoint->GetPosition().z() / cm);

    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 (edep > 0)
    {
      if (G4VUserTrackInformation* p = aTrack->GetUserInformation())
      {
        if (PHG4TrackUserInfoV1* pp = dynamic_cast<PHG4TrackUserInfoV1*>(p))
        {
          pp->SetKeep(1);  // we want to keep the track
        }
      }
    }

    //       hit->identify();
    // return true to indicate the hit was used
    return true;
  }
  else
  {
    return false;
  }
}

//____________________________________________________________________________..
void PHG4HcalPrototypeSteppingAction::SetInterfacePointers(PHCompositeNode* topNode)
{
  string hitnodename;
  string absorbernodename;
  if (detector_->SuperDetector() != "NONE")
  {
    hitnodename = "G4HIT_" + detector_->SuperDetector();
    absorbernodename = "G4HIT_ABSORBER_" + detector_->SuperDetector();
  }
  else
  {
    hitnodename = "G4HIT_" + detector_->GetName();
    absorbernodename = "G4HIT_ABSORBER_" + detector_->GetName();
  }

  //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_)
  {
    std::cout << "PHG4HcalPrototypeSteppingAction::SetTopNode - unable to find " << hitnodename << std::endl;
  }
  if (!absorberhits_)
  {
    if (Verbosity() > 0)
    {
      cout << "PHG4HcalSteppingAction::SetTopNode - unable to find " << absorbernodename << endl;
    }
  }
}