Small helper class to facilitate debugging of VXD::SensitiveDetector implementation. More...

#include <SensitiveDetectorDebugHelper.h>

Classes
struct	info
	struct with all the branches needed More...

Public Member Functions
void	startTraversal (VxdID sensorID, const SensorTraversal &traversal)
	Start writing a new sensor traversal: Geant4 steps will be added to the ROOT entry.

void	addTrueHit (const VXDTrueHit *truehit)
	Write the information normally used when creating TrueHits to the entry.

void	addSimHit (const VXDSimHit *simhit, int startPoint, int endPoint)
	Write the information normally used when creating SimHits to the entry.

void	finishTraversal ()
	Finish the entry by calling Fill()

Static Public Member Functions
static SensitiveDetectorDebugHelper &	getInstance ()
	Singleton class: get instance.

Private Types
enum	{ MAX_STEPS = 5000 , MAX_HITS = 500 , MAX_EDEP = 10000 , SIZE_STEP = 9 , SIZE_TRUE = 20 , SIZE_HITS = 13 , SIZE_EDEP = 2 }

Private Member Functions
	SensitiveDetectorDebugHelper ()
	Singleton class: private constructor.

	SensitiveDetectorDebugHelper (const SensitiveDetectorDebugHelper &)=delete
	Singleton class: no copy constructor.

SensitiveDetectorDebugHelper &	operator= (const SensitiveDetectorDebugHelper &)=delete
	Singleton class: no assignment operator.

	~SensitiveDetectorDebugHelper ()
	Destructor: write root file.

Private Attributes
TFile *	m_file {0}
	ROOT File to write information to.

TTree *	m_tree {0}
	ROOT Tree to write information to.

struct Belle2::VXD::SensitiveDetectorDebugHelper::info	m_info
	object to store all variables

Detailed Description

Small helper class to facilitate debugging of VXD::SensitiveDetector implementation.

This file will write a root file containing the Geant4 Step information as well as the information used for TrueHit and SimHit creation to check whether these are consistent. Normally this class should not be in use, a define can be set in VXD::SensitiveDetectorBase to enable its use.

This class is designed to make access very easy in python using numpy, e.g. the SimHits can be obtained as numpy array from the tree using

tree.GetEntry(i) simhits = np.array(tree.simhitInfo).reshape((-1, 13)) # HIT_SIZE=13

Definition at line 39 of file SensitiveDetectorDebugHelper.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
MAX_STEPS	assume maximum number of steps per sensor traversal
MAX_HITS	assume maximum number of simhits per sensor traversal
MAX_EDEP	assume maximum number of energy deposition points per sensor traversal
SIZE_STEP	number of values per step
SIZE_TRUE	number of values per truehit
SIZE_HITS	number of values per simhit
SIZE_EDEP	number of values per energy deposition point

Definition at line 73 of file SensitiveDetectorDebugHelper.h.

           {
        MAX_STEPS = 5000,
        MAX_HITS = 500,
        MAX_EDEP = 10000,
        SIZE_STEP = 9,
        SIZE_TRUE = 20,
        SIZE_HITS = 13,
        SIZE_EDEP = 2
      };

Constructor & Destructor Documentation

◆ SensitiveDetectorDebugHelper()

SensitiveDetectorDebugHelper ( )

private

Singleton class: private constructor.

Definition at line 26 of file SensitiveDetectorDebugHelper.cc.

    {
      m_file = new TFile("debug-vxdsensitivedetector.root", "RECREATE");
      m_tree = new TTree("sensortraversal", "Debug info for VXD Sensitive Detector implementation");
//Due to laziness, define some macros to create branches with less typing
#define ADDBRANCH__(name,var,type)   m_tree->Branch(#name,&m_info.var,#type)
#define ADDBARRAY__(name,var,n,type) ADDBRANCH__(name,var,name[n]/type)
#define ADDBRANCH(x,type)            ADDBRANCH__(x,x,x/type)
#define ADDBARRAY(x,n,type)          ADDBARRAY__(x,x,n,type)
      //and create all branches
      ADDBRANCH(sensorID, I);
      ADDBRANCH(pdg, I);
      ADDBRANCH(contained, I);
      ADDBRANCH(primary, I);
      ADDBRANCH(length, D);
      ADDBRANCH(stepN, I);
      ADDBARRAY(stepInfo, stepN, D);
      ADDBRANCH(trueN, I);
      ADDBARRAY(trueInfo, trueN, D);
      ADDBRANCH(edepN, I);
      ADDBARRAY(edepInfo, edepN, D);
      ADDBRANCH(simhitN, I);
      ADDBARRAY(simhitInfo, simhitN, D);
    }

◆ ~SensitiveDetectorDebugHelper()

~SensitiveDetectorDebugHelper ( )

inlineprivate

Destructor: write root file.

Definition at line 62 of file SensitiveDetectorDebugHelper.h.

      {
        m_tree->Write();
        m_file->Close();
      }

Member Function Documentation

◆ addSimHit()

void addSimHit	(	const VXDSimHit *	simhit,
		int	startPoint,
		int	endPoint )

Write the information normally used when creating SimHits to the entry.

Definition at line 103 of file SensitiveDetectorDebugHelper.cc.

    {
      assert(m_info.simhitN + SIZE_HITS < MAX_HITS * SIZE_HITS);
      m_info.simhitInfo[m_info.simhitN + 0] = simhit->getPosIn().X();
      m_info.simhitInfo[m_info.simhitN + 1] = simhit->getPosIn().Y();
      m_info.simhitInfo[m_info.simhitN + 2] = simhit->getPosIn().Z();
      m_info.simhitInfo[m_info.simhitN + 3] = simhit->getPosOut().X();
      m_info.simhitInfo[m_info.simhitN + 4] = simhit->getPosOut().Y();
      m_info.simhitInfo[m_info.simhitN + 5] = simhit->getPosOut().Z();
      m_info.simhitInfo[m_info.simhitN + 6] = simhit->getGlobalTime();
      m_info.simhitInfo[m_info.simhitN + 7] = startPoint;
      m_info.simhitInfo[m_info.simhitN + 8] = endPoint;
      //Add optimized energy deposition profile
      m_info.simhitInfo[m_info.simhitN + 9] = m_info.edepN / 2;
      for (auto step : simhit->getElectronProfile()) {
        m_info.edepInfo[m_info.edepN] = step.first;
        ++m_info.edepN;
        m_info.edepInfo[m_info.edepN] = step.second;
        ++m_info.edepN;
      }
      m_info.simhitInfo[m_info.simhitN + 10] = m_info.edepN / 2;
      //And also add electron profile sampled by distance
      for (auto step : simhit->getElectronsConstantDistance(50 * Unit::um)) {
        m_info.edepInfo[m_info.edepN] = step.first;
        ++m_info.edepN;
        m_info.edepInfo[m_info.edepN] = step.second;
        ++m_info.edepN;
      }
      m_info.simhitInfo[m_info.simhitN + 11] = m_info.edepN / 2;
      //And sampled by electrons
      for (auto step : simhit->getElectronsConstantNumber(1000)) {
        m_info.edepInfo[m_info.edepN] = step.first;
        ++m_info.edepN;
        m_info.edepInfo[m_info.edepN] = step.second;
        ++m_info.edepN;
      }
      m_info.simhitInfo[m_info.simhitN + 12] = m_info.edepN / 2;
      m_info.simhitN += SIZE_HITS;
    }

◆ addTrueHit()

void addTrueHit ( const VXDTrueHit * truehit )

Write the information normally used when creating TrueHits to the entry.

Definition at line 78 of file SensitiveDetectorDebugHelper.cc.

    {
      m_info.trueInfo[0] = truehit->getEntryU();
      m_info.trueInfo[1] = truehit->getEntryV();
      m_info.trueInfo[2] = truehit->getEntryW();
      m_info.trueInfo[3] = truehit->getU();
      m_info.trueInfo[4] = truehit->getV();
      m_info.trueInfo[5] = truehit->getW();
      m_info.trueInfo[6] = truehit->getExitU();
      m_info.trueInfo[7] = truehit->getExitV();
      m_info.trueInfo[8] = truehit->getExitW();
      m_info.trueInfo[9] = truehit->getEntryMomentum().X();
      m_info.trueInfo[10] = truehit->getEntryMomentum().Y();
      m_info.trueInfo[11] = truehit->getEntryMomentum().Z();
      m_info.trueInfo[12] = truehit->getMomentum().X();
      m_info.trueInfo[13] = truehit->getMomentum().Y();
      m_info.trueInfo[14] = truehit->getMomentum().Z();
      m_info.trueInfo[15] = truehit->getExitMomentum().X();
      m_info.trueInfo[16] = truehit->getExitMomentum().Y();
      m_info.trueInfo[17] = truehit->getExitMomentum().Z();
      m_info.trueInfo[18] = truehit->getEnergyDep();
      m_info.trueInfo[19] = truehit->getGlobalTime();
      m_info.trueN = SIZE_TRUE;
    }

◆ finishTraversal()

void finishTraversal ( )

inline

Finish the entry by calling Fill()

Definition at line 50 of file SensitiveDetectorDebugHelper.h.

      {
        m_tree->Fill();
      }

◆ getInstance()

SensitiveDetectorDebugHelper & getInstance ( )

static

Singleton class: get instance.

Definition at line 20 of file SensitiveDetectorDebugHelper.cc.

    {
      static SensitiveDetectorDebugHelper instance;
      return instance;
    }

◆ startTraversal()

void startTraversal	(	VxdID	sensorID,
		const SensorTraversal &	traversal )

Start writing a new sensor traversal: Geant4 steps will be added to the ROOT entry.

Definition at line 50 of file SensitiveDetectorDebugHelper.cc.

    {
      m_info.sensorID = sensorID;
      m_info.pdg = traversal.getPDGCode();
      m_info.contained = traversal.isContained();
      m_info.primary = traversal.isPrimary();
      m_info.length = traversal.getLength();
      m_info.stepN = 0;
      m_info.trueN = 0;
      m_info.edepN = 0;
      m_info.simhitN = 0;
 
      //add all steps if there is enough space
      assert(traversal.size() <= MAX_STEPS);
      for (const StepInformation& step : traversal) {
        m_info.stepInfo[m_info.stepN + 0] = step.position.x();
        m_info.stepInfo[m_info.stepN + 1] = step.position.y();
        m_info.stepInfo[m_info.stepN + 2] = step.position.z();
        m_info.stepInfo[m_info.stepN + 3] = step.momentum.x();
        m_info.stepInfo[m_info.stepN + 4] = step.momentum.y();
        m_info.stepInfo[m_info.stepN + 5] = step.momentum.z();
        m_info.stepInfo[m_info.stepN + 6] = step.electrons;
        m_info.stepInfo[m_info.stepN + 7] = step.time;
        m_info.stepInfo[m_info.stepN + 8] = step.length;
        m_info.stepN += SIZE_STEP;
      }
    }

Member Data Documentation

◆ m_file

TFile* m_file {0}

private

ROOT File to write information to.

Definition at line 69 of file SensitiveDetectorDebugHelper.h.

69{0};

◆ m_tree

TTree* m_tree {0}

private

ROOT Tree to write information to.

Definition at line 71 of file SensitiveDetectorDebugHelper.h.

71{0};

The documentation for this class was generated from the following files:

vxd/simulation/include/SensitiveDetectorDebugHelper.h
vxd/simulation/src/SensitiveDetectorDebugHelper.cc

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SensitiveDetectorDebugHelper()

◆ ~SensitiveDetectorDebugHelper()

Member Function Documentation

◆ addSimHit()

◆ addTrueHit()

◆ finishTraversal()

◆ getInstance()

◆ startTraversal()

Member Data Documentation

◆ m_file

◆ m_tree