Singleton class performing the voxelization of the world volume and tracking of a voxel index given the three-dimensional coordinates. More...

#include <Doxymodules_medical.h>

Public Member Functions
	~VoxelizedSensitiveDetector ()
	Destructor.

void	SetVoxelWidth (G4ThreeVector voxWidth)
	Method to set the voxel shape to be a box with given sides.

void	SetVoxelWidthX (G4double voxWidthX)
	Method to set the voxel X width.

void	SetVoxelWidthY (G4double voxWidthY)
	Method to set the voxel Y width.

void	SetVoxelWidthZ (G4double voxWidthZ)
	Method to set the voxel Z width.

void	UpdateVoxelizedGeometry ()
	Method to update voxelized geometry.

void	InitializeWorldPtr (G4VPhysicalVolume *pWorld)
	Method to properly initialize the pointer to the World physical volume.

void	Construct ()
	Method to construct all the volumes for the voxelization of the geometry.

void	ConstructSD ()
	Method to make the proper volume sensitive to allow scoring.

G4ThreeVector	GetVoxelWidth () const
	Method to get the three vector containing the dimensions for the voxel.

G4double	GetVoxelWidthX () const
	Method to get X width of the voxel.

G4double	GetVoxelWidthY () const
	Method to get Y width of the voxel.

G4double	GetVoxelWidthZ () const
	Method to get Z width of the voxel.

G4double	GetVoxelVolume () const
	Method to get total voxel volume.

G4double	GetVoxelNumberAlongX () const
	Method to get the voxel number along X axis.

G4double	GetVoxelNumberAlongY () const
	Method to get the voxel number along Y axis.

G4double	GetVoxelNumberAlongZ () const
	Method to get the voxel number along Z axis.

G4int	GetTotalVoxelNumber () const
	Method to get the total voxel number.

G4double	GetVoxelMass () const
	Method to get the mass of a voxel.

G4double	GetVoxelDensity () const
	Method to get the density of a voxel.

G4int	GetThisVoxelNumber (G4int x, G4int j, G4int k) const
	Method to get the absolute voxel index given its indexes in the three dimensions.

Static Public Member Functions
static VoxelizedSensitiveDetector *	GetInstance ()
	Static method to retrieve a pointer to the only object existing in the simulation.

static VoxelizedSensitiveDetector *	CreateInstance (DetectorConstruction *det, double xWidth, double yWidth, double zWidth)
	Static method to create the pointer to the only object existing in the simulation.

Private Member Functions
	VoxelizedSensitiveDetector (DetectorConstruction *det, double xWidth, double yWidth, double zWidth)
	Private constructor using a pointer to DetectorConstruction and the three dimensions for one voxel.

G4bool	ConstructVoxelizedDetector ()
	Private method to construct the voxelized detector.

void	UpdateVoxelVolume ()
	Private method to calculate the total volume of a voxel given the parameters saved inside the object.

void	CalculateVoxelNumber ()
	Private method to calculate the total voxel number given the parameters saved inside the object.

void	ConstructXDivision ()
	Private method to slice the world volume along the X axis.

void	ConstructYDivision ()
	Private method to further slice the X slices along the Y axis, creating some "columns" of material.

void	ConstructZDivision ()
	Private method to further slice the Y columns along the Z axis, creating some boxes of material.

Private Attributes
DetectorConstruction *	fDetector = nullptr

G4double	fVoxelWidthX = -1.

G4double	fVoxelWidthY = -1.

G4double	fVoxelWidthZ = -1.

G4double	fVoxelVolume = -1.

G4int	fVoxelNumberAlongX = 1

G4int	fVoxelNumberAlongY = 1

G4int	fVoxelNumberAlongZ = 1

G4int	fTotalVoxelNumber = 1

G4double	fVoxelMass = 0.

G4double	fVoxelDensity = 0.

G4Box *	fVoxelizedDetectorXDivision = nullptr

G4Box *	fVoxelizedDetectorYDivision = nullptr

G4Box *	fVoxelizedDetectorZDivision = nullptr

G4LogicalVolume *	fVoxelizedDetectorXDivisionLog = nullptr

G4LogicalVolume *	fVoxelizedDetectorYDivisionLog = nullptr

G4LogicalVolume *	fVoxelizedDetectorZDivisionLog = nullptr

G4LogicalVolume *	fSensitiveLogicalVolume = nullptr

G4VPhysicalVolume *	fVoxelizedDetectorXDivisionPhys = nullptr

G4VPhysicalVolume *	fVoxelizedDetectorYDivisionPhys = nullptr

G4VPhysicalVolume *	fVoxelizedDetectorZDivisionPhys = nullptr

G4LogicalVolume *	fWorldLogical = nullptr

G4bool	fIsBuilt = false

VoxelizedSensitiveDetectorMessenger *	fVoxelizedSensitiveDetectorMessenger = nullptr

Static Private Attributes
static VoxelizedSensitiveDetector *	fInstance = nullptr

Detailed Description

Singleton class performing the voxelization of the world volume and tracking of a voxel index given the three-dimensional coordinates.

This class is used to voxelize the world volume created in DetectorConstruction class. It works only if the world already exists: the constructor needs a pointer to DetectorConstruction.

This class does not insert a further material, but uses the same material saved in DetectorConstruction class. It is responsible for the voxelization of the space and for the tracking of voxels index.

Internally, the voxel volume, mass and density are updated every time something relevant changes in the geometry

Note: Although in this class the word "sensitive" appears, this is class is not an implementation of the sensitive detector, nevertheless it crates the environment for sensitiveness. It is meant to be similar to a DetectorConstruction class, providing voxelization of the world.

Definition at line 148 of file Doxymodules_medical.h.

Constructor & Destructor Documentation

◆ VoxelizedSensitiveDetector()

RadioBio::VoxelizedSensitiveDetector::VoxelizedSensitiveDetector	(	DetectorConstruction *	det,
		double	xWidth,
		double	yWidth,
		double	zWidth
	)

private

Private constructor using a pointer to DetectorConstruction and the three dimensions for one voxel.

Definition at line 77 of file VoxelizedSensitiveDetector.cc.

  : fDetector(det), fVoxelWidthX(xWidth), fVoxelWidthY(yWidth), fVoxelWidthZ(zWidth)
{
  fVoxelizedSensitiveDetectorMessenger = new VoxelizedSensitiveDetectorMessenger(this);
  UpdateVoxelVolume();
  CalculateVoxelNumber();
}

◆ ~VoxelizedSensitiveDetector()

RadioBio::VoxelizedSensitiveDetector::~VoxelizedSensitiveDetector ( )

Destructor.

Definition at line 88 of file VoxelizedSensitiveDetector.cc.

{
  delete fVoxelizedSensitiveDetectorMessenger;
}

Member Function Documentation

◆ GetInstance()

VoxelizedSensitiveDetector * RadioBio::VoxelizedSensitiveDetector::GetInstance ( )

static

Static method to retrieve a pointer to the only object existing in the simulation.

Definition at line 70 of file VoxelizedSensitiveDetector.cc.

{
  return fInstance;
}

◆ CreateInstance()

VoxelizedSensitiveDetector * RadioBio::VoxelizedSensitiveDetector::CreateInstance	(	DetectorConstruction *	det,
		double	xWidth,
		double	yWidth,
		double	zWidth
	)

static

Static method to create the pointer to the only object existing in the simulation.

Parameters

det	A pointer to the DetectorConstruction object
xWidth	X dimension of a single voxel
yWidth	Y dimension of a single voxel
zWidth	Z dimension of a single voxel

Definition at line 55 of file VoxelizedSensitiveDetector.cc.

{
  if (fInstance) {
    delete fInstance;
    G4Exception("VoxelizedSensitiveDetector::createInstance", "RecreatingVoxelization",
                FatalException, "Creating another, new, instance of VoxelizedSensitiveDetector");
  }
  fInstance = new VoxelizedSensitiveDetector(det, xWidth, yWidth, zWidth);
  return fInstance;
}

◆ SetVoxelWidth()

void RadioBio::VoxelizedSensitiveDetector::SetVoxelWidth ( G4ThreeVector voxWidth )

Method to set the voxel shape to be a box with given sides.

Parameters

voxWidth ThreeVector containing the three-dimensionals sides for the voxel

Definition at line 104 of file VoxelizedSensitiveDetector.cc.

{
  fVoxelWidthX = voxWidth.getX();
  fVoxelWidthY = voxWidth.getY();
  fVoxelWidthZ = voxWidth.getZ();
  CalculateVoxelNumber();
}

◆ SetVoxelWidthX()

void RadioBio::VoxelizedSensitiveDetector::SetVoxelWidthX ( G4double voxWidthX )

Method to set the voxel X width.

Parameters

voxWidthX X width for the voxel

Definition at line 114 of file VoxelizedSensitiveDetector.cc.

{
  if (fVoxelWidthX == voxWidthX) return;
  fVoxelWidthX = voxWidthX;
  CalculateVoxelNumber();
}

◆ SetVoxelWidthY()

void RadioBio::VoxelizedSensitiveDetector::SetVoxelWidthY ( G4double voxWidthY )

Method to set the voxel Y width.

Parameters

voxWidthY Y width for the voxel

Definition at line 123 of file VoxelizedSensitiveDetector.cc.

{
  if (fVoxelWidthY == voxWidthY) return;
  fVoxelWidthY = voxWidthY;
  CalculateVoxelNumber();
}

◆ SetVoxelWidthZ()

void RadioBio::VoxelizedSensitiveDetector::SetVoxelWidthZ ( G4double voxWidthZ )

Method to set the voxel Z width.

Parameters

voxWidthZ Z width for the voxel

Definition at line 132 of file VoxelizedSensitiveDetector.cc.

{
  if (fVoxelWidthZ == voxWidthZ) return;
  fVoxelWidthZ = voxWidthZ;
  CalculateVoxelNumber();
}

◆ UpdateVoxelizedGeometry()

void RadioBio::VoxelizedSensitiveDetector::UpdateVoxelizedGeometry ( )

Method to update voxelized geometry.

If voxelized geometry is not built, it returns immediately. Otherwise, geometrical parameters are re-calculated and voxelized geometry is destroyed, de-registered and built once again from scratch.

Definition at line 250 of file VoxelizedSensitiveDetector.cc.

{
  // Nothing happens if the voxelized geometry is not built. But parameters are properly set.
  if (!fIsBuilt) {
    return;
  }
 
  CalculateVoxelNumber();
 
  // Volume that will be deleted in order to update
  G4VPhysicalVolume* myVol;
 
  G4PhysicalVolumeStore* store = G4PhysicalVolumeStore::GetInstance();
 
  myVol = store->GetVolume("VoxelizedDetectorXDivisionPhys");
  store->DeRegister(myVol);
  myVol = store->GetVolume("VoxelizedDetectorYDivisionPhys");
  store->DeRegister(myVol);
  myVol = store->GetVolume("VoxelizedDetectorZDivisionPhys");
  store->DeRegister(myVol);
  fVoxelizedDetectorXDivisionPhys =
    new G4PVReplica("VoxelizedDetectorXDivisionPhys", fVoxelizedDetectorXDivisionLog, fWorldLogical,
                    kXAxis, fVoxelNumberAlongX, fVoxelWidthX);
 
  fVoxelizedDetectorYDivisionPhys =
    new G4PVReplica("VoxelizedDetectorYDivisionPhys", fVoxelizedDetectorYDivisionLog,
                    fVoxelizedDetectorXDivisionPhys, kYAxis, fVoxelNumberAlongY, fVoxelWidthY);
 
  fVoxelizedDetectorZDivisionPhys =
    new G4PVReplica("VoxelizedDetectorZDivisionPhys", fVoxelizedDetectorZDivisionLog,
                    fVoxelizedDetectorYDivisionPhys, kZAxis, fVoxelNumberAlongZ, fVoxelWidthZ);
 
  G4RunManager::GetRunManager()->GeometryHasBeenModified();
  G4RunManager::GetRunManager()->PhysicsHasBeenModified();
}

◆ InitializeWorldPtr()

void RadioBio::VoxelizedSensitiveDetector::InitializeWorldPtr ( G4VPhysicalVolume * pWorld )

Method to properly initialize the pointer to the World physical volume.

It is meant to be called only by DetectorConstruction itself.

Parameters

pWorld Pointer to the world physical volume

Definition at line 307 of file VoxelizedSensitiveDetector.cc.

{
  if (pWorld == nullptr)
    G4Exception("VoxelizedSensitiveDetector::InitializeWorldPtr", "WorldinitNull", FatalException,
                "Initializing Voxelization Class with a Null Pointer to World!");
  fWorldLogical = pWorld->GetLogicalVolume();
}

◆ Construct()

void RadioBio::VoxelizedSensitiveDetector::Construct ( )

Method to construct all the volumes for the voxelization of the geometry.

Definition at line 300 of file VoxelizedSensitiveDetector.cc.

{
  ConstructVoxelizedDetector();
}

◆ ConstructSD()

void RadioBio::VoxelizedSensitiveDetector::ConstructSD ( )

Method to make the proper volume sensitive to allow scoring.

Definition at line 288 of file VoxelizedSensitiveDetector.cc.

{
  G4String sensitiveDetectorName = "VoxelizedDetector";
  G4String HCname = "LETdata";
 
  SD* detectorSD = new SD(sensitiveDetectorName, HCname);
  G4SDManager::GetSDMpointer()->AddNewDetector(detectorSD);
  fSensitiveLogicalVolume->SetSensitiveDetector(detectorSD);
}

◆ GetVoxelWidth()

G4ThreeVector RadioBio::VoxelizedSensitiveDetector::GetVoxelWidth ( ) const

inline

Method to get the three vector containing the dimensions for the voxel.

Definition at line 161 of file VoxelizedSensitiveDetector.hh.

    {
      return G4ThreeVector{fVoxelWidthX, fVoxelWidthY, fVoxelWidthZ};
    }

◆ GetVoxelWidthX()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelWidthX ( ) const

inline

Method to get X width of the voxel.

Definition at line 167 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelWidthX;
    }

◆ GetVoxelWidthY()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelWidthY ( ) const

inline

Method to get Y width of the voxel.

Definition at line 173 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelWidthY;
    }

◆ GetVoxelWidthZ()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelWidthZ ( ) const

inline

Method to get Z width of the voxel.

Definition at line 179 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelWidthZ;
    }

◆ GetVoxelVolume()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelVolume ( ) const

inline

Method to get total voxel volume.

Definition at line 185 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelVolume;
    }

◆ GetVoxelNumberAlongX()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelNumberAlongX ( ) const

inline

Method to get the voxel number along X axis.

Definition at line 191 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelNumberAlongX;
    }

◆ GetVoxelNumberAlongY()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelNumberAlongY ( ) const

inline

Method to get the voxel number along Y axis.

Definition at line 197 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelNumberAlongY;
    }

◆ GetVoxelNumberAlongZ()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelNumberAlongZ ( ) const

inline

Method to get the voxel number along Z axis.

Definition at line 203 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelNumberAlongZ;
    }

◆ GetTotalVoxelNumber()

G4int RadioBio::VoxelizedSensitiveDetector::GetTotalVoxelNumber ( ) const

inline

Method to get the total voxel number.

Definition at line 209 of file VoxelizedSensitiveDetector.hh.

    {
      return fTotalVoxelNumber;
    }

◆ GetVoxelMass()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelMass ( ) const

inline

Method to get the mass of a voxel.

Note: In this implementation, there is only one material for the whole simulation. This means that all the voxels (that already share the same shape and dimensions) also share the same mass and density

Definition at line 222 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelMass;
    }

◆ GetVoxelDensity()

G4double RadioBio::VoxelizedSensitiveDetector::GetVoxelDensity ( ) const

inline

Method to get the density of a voxel.

Note: In this implementation, there is only one material for the whole simulation. This means that all the voxels (that already share the same shape and dimensions) also share the same mass and density

Definition at line 235 of file VoxelizedSensitiveDetector.hh.

    {
      return fVoxelDensity;
    }

◆ GetThisVoxelNumber()

G4int RadioBio::VoxelizedSensitiveDetector::GetThisVoxelNumber	(	G4int	x,
		G4int	j,
		G4int	k
	)		const

Method to get the absolute voxel index given its indexes in the three dimensions.

This helper function is heavily used throughout the simulation and is here because the voxelized detector is meant to know how many voxels there are and how they are ordered.

Definition at line 318 of file VoxelizedSensitiveDetector.cc.

{
  G4int nz = GetVoxelNumberAlongZ();
  G4int ny = GetVoxelNumberAlongY();
 
  return z + nz * (y + ny * (x));
}

◆ ConstructVoxelizedDetector()

G4bool RadioBio::VoxelizedSensitiveDetector::ConstructVoxelizedDetector ( )

private

Private method to construct the voxelized detector.

Definition at line 230 of file VoxelizedSensitiveDetector.cc.

{
  // Creating X division
  ConstructXDivision();
 
  // Creating Y division
  ConstructYDivision();
 
  // Creating Z division
  ConstructZDivision();
 
  // Set last, smallest volumes as sensitive
  fSensitiveLogicalVolume = fVoxelizedDetectorZDivisionLog;
  fIsBuilt = true;
 
  return true;
}

◆ UpdateVoxelVolume()

void RadioBio::VoxelizedSensitiveDetector::UpdateVoxelVolume ( )

private

Private method to calculate the total volume of a voxel given the parameters saved inside the object.

Definition at line 95 of file VoxelizedSensitiveDetector.cc.

{
  fVoxelVolume = fVoxelWidthX * fVoxelWidthY * fVoxelWidthZ;
  fVoxelDensity = fDetector->GetMaterial()->GetDensity();
  fVoxelMass = fVoxelVolume * fVoxelDensity;
}

◆ CalculateVoxelNumber()

void RadioBio::VoxelizedSensitiveDetector::CalculateVoxelNumber ( )

private

Private method to calculate the total voxel number given the parameters saved inside the object.

Definition at line 143 of file VoxelizedSensitiveDetector.cc.

{
  fVoxelNumberAlongX = G4int(fDetector->GetSizeX() / fVoxelWidthX);
  fVoxelWidthX = fDetector->GetSizeX() / G4double(fVoxelNumberAlongX);
 
  fVoxelNumberAlongY = G4int(fDetector->GetSizeY() / fVoxelWidthY);
  fVoxelWidthY = fDetector->GetSizeY() / G4double(fVoxelNumberAlongY);
 
  fVoxelNumberAlongZ = G4int(fDetector->GetSizeZ() / fVoxelWidthZ);
  fVoxelWidthZ = fDetector->GetSizeZ() / G4double(fVoxelNumberAlongZ);
 
  if (fVoxelNumberAlongY % 2 == 0)
    G4Exception("VoxelizedSensitiveDetector::CalculateVoxelNumber", "VoxelNumberYEven", JustWarning,
                "Trying to voxelize with an even number of voxels along the Y axis."
                "Please select an odd number to prevent from warnings due to tracking");
 
  if (fVoxelNumberAlongZ % 2 == 0)
    G4Exception("VoxelizedSensitiveDetector::CalculateVoxelNumber", "VoxelNumberZEven", JustWarning,
                "Trying to voxelize with an even number of voxels along the Z axis."
                "Please select an odd number to prevent from warnings due to tracking");
 
  fTotalVoxelNumber = fVoxelNumberAlongX * fVoxelNumberAlongY * fVoxelNumberAlongZ;
 
  UpdateVoxelVolume();
}

◆ ConstructXDivision()

void RadioBio::VoxelizedSensitiveDetector::ConstructXDivision ( )

private

Private method to slice the world volume along the X axis.

Definition at line 171 of file VoxelizedSensitiveDetector.cc.

{
  if (fWorldLogical == nullptr)
    G4Exception("VoxelizedSensitiveDetector::ConstructXDivision", "WorldNotInit", FatalException,
                "Voxelizing without having a pointer to world logical volume!");
 
  if (!fDetector)
    G4Exception("VoxelizedSensitiveDetector::ConstructXDivision", "DetConstInit", FatalException,
                "Voxelizing without having a pointer to DetectorConstruction!");
 
  fVoxelizedDetectorXDivision = new G4Box("VoxelizedDetectorXDivision", fVoxelWidthX / 2,
                                          fDetector->GetSizeY() / 2, fDetector->GetSizeZ() / 2);
 
  fVoxelizedDetectorXDivisionLog =
    new G4LogicalVolume(fVoxelizedDetectorXDivision, fWorldLogical->GetMaterial(),
                        "VoxelizedDetectorXDivisionLog", 0, 0, 0);
 
  fVoxelizedDetectorXDivisionPhys =
    new G4PVReplica("VoxelizedDetectorXDivisionPhys", fVoxelizedDetectorXDivisionLog, fWorldLogical,
                    kXAxis, fVoxelNumberAlongX, fVoxelWidthX);
}

◆ ConstructYDivision()

void RadioBio::VoxelizedSensitiveDetector::ConstructYDivision ( )

private

Private method to further slice the X slices along the Y axis, creating some "columns" of material.

Definition at line 195 of file VoxelizedSensitiveDetector.cc.

{
  fVoxelizedDetectorYDivision = new G4Box("VoxelizedDetectorYDivision", fVoxelWidthX / 2,
                                          fVoxelWidthY / 2, fDetector->GetSizeZ() / 2);
 
  fVoxelizedDetectorYDivisionLog =
    new G4LogicalVolume(fVoxelizedDetectorYDivision, fWorldLogical->GetMaterial(),
                        "VoxelizedDetectorYDivisionLog", 0, 0, 0);
 
  fVoxelizedDetectorYDivisionPhys =
    new G4PVReplica("VoxelizedDetectorYDivisionPhys", fVoxelizedDetectorYDivisionLog,
                    fVoxelizedDetectorXDivisionLog, kYAxis, fVoxelNumberAlongY, fVoxelWidthY);
}

◆ ConstructZDivision()

void RadioBio::VoxelizedSensitiveDetector::ConstructZDivision ( )

private

Private method to further slice the Y columns along the Z axis, creating some boxes of material.

This is the final step for voxelization of space.

Definition at line 211 of file VoxelizedSensitiveDetector.cc.

{
  fVoxelizedDetectorZDivision =
    new G4Box("VoxelizedDetectorZDivision", fVoxelWidthX / 2, fVoxelWidthY / 2, fVoxelWidthZ / 2);
 
  fVoxelizedDetectorZDivisionLog =
    new G4LogicalVolume(fVoxelizedDetectorZDivision, fWorldLogical->GetMaterial(),
                        "VoxelizedDetectorZDivisionLog", 0, 0, 0);
 
  fVoxelizedDetectorZDivisionPhys =
    new G4PVReplica("VoxelizedDetectorZDivisionPhys", fVoxelizedDetectorZDivisionLog,
                    fVoxelizedDetectorYDivisionPhys, kZAxis, fVoxelNumberAlongZ, fVoxelWidthZ);
 
  fSensitiveLogicalVolume = fVoxelizedDetectorZDivisionLog;
}