#include <HadrontherapyDetectorConstruction.hh>

Collaboration diagram for HadrontherapyDetectorConstruction:

Public Member Functions
	HadrontherapyDetectorConstruction (G4VPhysicalVolume *)

	~HadrontherapyDetectorConstruction ()

void	InitializeDetectorROGeometry (HadrontherapyDetectorROGeometry *, G4ThreeVector detectorToWorldPosition)

G4ThreeVector	GetDetectorToWorldPosition ()

G4ThreeVector	GetDetectorToPhantomPosition ()

void	SetDetectorPosition ()

bool	IsInside (G4double detectorX, G4double detectorY, G4double detectorZ, G4double phantomX, G4double phantomY, G4double phantomZ, G4ThreeVector pos)

G4bool	SetPhantomMaterial (G4String material)

void	SetVoxelSize (G4double sizeX, G4double sizeY, G4double sizeZ)

void	SetDetectorSize (G4double sizeX, G4double sizeY, G4double sizeZ)

void	SetPhantomSize (G4double sizeX, G4double sizeY, G4double sizeZ)

void	SetPhantomPosition (G4ThreeVector)

void	SetDetectorToPhantomPosition (G4ThreeVector DetectorToPhantomPosition)

void	UpdateGeometry ()

void	PrintParameters ()

G4LogicalVolume *	GetDetectorLogicalVolume ()

Static Public Member Functions
static HadrontherapyDetectorConstruction *	GetInstance ()

Public Attributes
G4VPhysicalVolume *	motherPhys

HadrontherapyDetectorSD *	detectorSD

Private Member Functions
void	ConstructPhantom ()

void	ConstructDetector ()

void	ParametersCheck ()

void	CheckOverlaps ()

Private Attributes
HadrontherapyDetectorMessenger *	detectorMessenger

G4VisAttributes *	skyBlue

G4VisAttributes *	red

HadrontherapyDetectorROGeometry *	detectorROGeometry

HadrontherapyMatrix *	matrix

HadrontherapyLet *	let

G4Box *	phantom

G4Box *	detector

G4LogicalVolume *	phantomLogicalVolume

G4LogicalVolume *	detectorLogicalVolume

G4VPhysicalVolume *	phantomPhysicalVolume

G4VPhysicalVolume *	detectorPhysicalVolume

G4double	phantomSizeX

G4double	phantomSizeY

G4double	phantomSizeZ

G4double	detectorSizeX

G4double	detectorSizeY

G4double	detectorSizeZ

G4ThreeVector	phantomPosition

G4ThreeVector	detectorPosition

G4ThreeVector	detectorToPhantomPosition

G4double	sizeOfVoxelAlongX

G4double	sizeOfVoxelAlongY

G4double	sizeOfVoxelAlongZ

G4int	numberOfVoxelsAlongX

G4int	numberOfVoxelsAlongY

G4int	numberOfVoxelsAlongZ

G4double	volumeOfVoxel

G4double	massOfVoxel

G4Material *	phantomMaterial

G4Material *	detectorMaterial

G4Region *	aRegion

Static Private Attributes
static HadrontherapyDetectorConstruction *	instance = 0

Detailed Description

Definition at line 48 of file HadrontherapyDetectorConstruction.hh.

Constructor & Destructor Documentation

◆ HadrontherapyDetectorConstruction()

HadrontherapyDetectorConstruction::HadrontherapyDetectorConstruction ( G4VPhysicalVolume * physicalTreatmentRoom )

Definition at line 62 of file HadrontherapyDetectorConstruction.cc.

 : motherPhys(physicalTreatmentRoom), // pointer to WORLD volume
 detectorSD(0), detectorROGeometry(0), matrix(0),
 phantom(0), detector(0),
 phantomLogicalVolume(0), detectorLogicalVolume(0),
 phantomPhysicalVolume(0), detectorPhysicalVolume(0),
 aRegion(0)
 {
     HadrontherapyAnalysisManager::GetInstance();
     
     /* NOTE! that the HadrontherapyDetectorConstruction class
      * does NOT inherit from G4VUserDetectorConstruction G4 class
      * So the Construct() mandatory virtual method is inside another geometric class
      * like the passiveProtonBeamLIne, ...
      */
     
     // Messenger to change parameters of the phantom/detector geometry
     detectorMessenger = new HadrontherapyDetectorMessenger(this);
     
     // Default detector voxels size
     // 200 slabs along the beam direction (X)
     sizeOfVoxelAlongX = 200 *um;
     sizeOfVoxelAlongY = 4 *cm;
     sizeOfVoxelAlongZ = 4 *cm;
     
     // Define here the material of the water phantom and of the detector
     SetPhantomMaterial("G4_WATER");
     // Construct geometry (messenger commands)
     SetDetectorSize(4.*cm, 4.*cm, 4.*cm);
     SetPhantomSize(40. *cm, 40. *cm, 40. *cm);
     SetPhantomPosition(G4ThreeVector(20. *cm, 0. *cm, 0. *cm));
     SetDetectorToPhantomPosition(G4ThreeVector(0. *cm, 18. *cm, 18. *cm));
     SetDetectorPosition();
     //GetDetectorToWorldPosition();
     
     // Write virtual parameters to the real ones and check for consistency
     UpdateGeometry();
 }

Here is the call graph for this function:

◆ ~HadrontherapyDetectorConstruction()

HadrontherapyDetectorConstruction::~HadrontherapyDetectorConstruction ( )

Definition at line 102 of file HadrontherapyDetectorConstruction.cc.

 {
     delete detectorROGeometry;
     delete matrix;
     delete detectorMessenger;
 }

Member Function Documentation

◆ CheckOverlaps()

void HadrontherapyDetectorConstruction::CheckOverlaps ( )

private

Definition at line 410 of file HadrontherapyDetectorConstruction.cc.

 {
     G4PhysicalVolumeStore* thePVStore = G4PhysicalVolumeStore::GetInstance();
     G4cout << thePVStore->size() << " physical volumes are defined" << G4endl;
     G4bool overlapFlag = false;
     G4int res=1000;
     G4double tol=0.; //tolerance
     for (size_t i=0;i<thePVStore->size();i++)
     {
         //overlapFlag = (*thePVStore)[i]->CheckOverlaps(res,tol,fCheckOverlapsVerbosity) | overlapFlag;
         overlapFlag = (*thePVStore)[i]->CheckOverlaps(res,tol,true) | overlapFlag;    }
     if (overlapFlag)
         G4cout << "Check: there are overlapping volumes" << G4endl;
 }

Here is the call graph for this function:

◆ ConstructDetector()

void HadrontherapyDetectorConstruction::ConstructDetector ( )

private

Definition at line 170 of file HadrontherapyDetectorConstruction.cc.

 {
     // Definition of the solid volume of the Detector
     detector = new G4Box("Detector",
                          detectorSizeX/2,
                          detectorSizeY/2,
                          detectorSizeZ/2);
     
     // Definition of the logic volume of the Phantom
     detectorLogicalVolume = new G4LogicalVolume(detector,
                                                 detectorMaterial,
                                                 "DetectorLog",
                                                 0,0,0);
     // Definition of the physical volume of the Phantom
     detectorPhysicalVolume = new G4PVPlacement(0,
                                                detectorPosition, // Setted by displacement
                                                "DetectorPhys",
                                                detectorLogicalVolume,
                                                phantomPhysicalVolume,
                                                false,0);
     
     // Visualisation attributes of the detector
     skyBlue = new G4VisAttributes( G4Colour(135/255. , 206/255. ,  235/255. ));
     skyBlue -> SetVisibility(true);
     skyBlue -> SetForceSolid(true);
     //skyBlue -> SetForceWireframe(true);
     detectorLogicalVolume -> SetVisAttributes(skyBlue);
     
     // **************
     // Cut per Region
     // **************
     //
     // A smaller cut is fixed in the phantom to calculate the energy deposit with the
     // required accuracy
     if (!aRegion)
     {
         aRegion = new G4Region("DetectorLog");
         detectorLogicalVolume -> SetRegion(aRegion);
         aRegion -> AddRootLogicalVolume(detectorLogicalVolume);
     }
 }

Here is the caller graph for this function:

◆ ConstructPhantom()

void HadrontherapyDetectorConstruction::ConstructPhantom ( )

private

Definition at line 119 of file HadrontherapyDetectorConstruction.cc.

 {
     // Definition of the solid volume of the Phantom
     phantom = new G4Box("Phantom",
                         phantomSizeX/2,
                         phantomSizeY/2,
                         phantomSizeZ/2);
     
     // Definition of the logical volume of the Phantom
     phantomLogicalVolume = new G4LogicalVolume(phantom,
                                                phantomMaterial,
                                                "phantomLog", 0, 0, 0);
     
     // Definition of the physics volume of the Phantom
     phantomPhysicalVolume = new G4PVPlacement(0,
                                               phantomPosition,
                                               "phantomPhys",
                                               phantomLogicalVolume,
                                               motherPhys,
                                               false,
                                               0);
     
     // Visualisation attributes of the phantom
     red = new G4VisAttributes(G4Colour(255/255., 0/255. ,0/255.));
     red -> SetVisibility(true);
     red -> SetForceSolid(true);
     red -> SetForceWireframe(true);
     phantomLogicalVolume -> SetVisAttributes(red);
 }

Here is the caller graph for this function:

◆ GetDetectorLogicalVolume()

G4LogicalVolume* HadrontherapyDetectorConstruction::GetDetectorLogicalVolume ( )

inline

Definition at line 160 of file HadrontherapyDetectorConstruction.hh.

160 { return detectorLogicalVolume;}

HadrontherapyDetectorConstruction::detectorLogicalVolume

G4LogicalVolume * detectorLogicalVolume

Definition: HadrontherapyDetectorConstruction.hh:174

◆ GetDetectorToPhantomPosition()

G4ThreeVector HadrontherapyDetectorConstruction::GetDetectorToPhantomPosition ( )

inline

Definition at line 78 of file HadrontherapyDetectorConstruction.hh.

 {
     return G4ThreeVector(phantomSizeX/2 - detectorSizeX/2 + detectorPosition.getX(),
                          phantomSizeY/2 - detectorSizeY/2 + detectorPosition.getY(),
                          phantomSizeZ/2 - detectorSizeZ/2 + detectorPosition.getZ()
                   );
 }

Here is the call graph for this function:

◆ GetDetectorToWorldPosition()

G4ThreeVector HadrontherapyDetectorConstruction::GetDetectorToWorldPosition ( )

inline

Definition at line 72 of file HadrontherapyDetectorConstruction.hh.

   { 
     return phantomPosition + detectorPosition;
   }

Here is the caller graph for this function:

◆ GetInstance()

HadrontherapyDetectorConstruction * HadrontherapyDetectorConstruction::GetInstance ( )

static

Definition at line 110 of file HadrontherapyDetectorConstruction.cc.

 {
     return instance;
 }

◆ InitializeDetectorROGeometry()

void HadrontherapyDetectorConstruction::InitializeDetectorROGeometry	(	HadrontherapyDetectorROGeometry *	RO,
		G4ThreeVector	detectorToWorldPosition
	)

Definition at line 213 of file HadrontherapyDetectorConstruction.cc.

 {
     RO->Initialize(detectorToWorldPosition,
                    detectorSizeX/2,
                    detectorSizeY/2,
                    detectorSizeZ/2,
                    numberOfVoxelsAlongX,
                    numberOfVoxelsAlongY,
                    numberOfVoxelsAlongZ);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsInside()

bool HadrontherapyDetectorConstruction::IsInside	(	G4double	detectorX,
		G4double	detectorY,
		G4double	detectorZ,
		G4double	phantomX,
		G4double	phantomY,
		G4double	phantomZ,
		G4ThreeVector	pos
	)

inline

Definition at line 99 of file HadrontherapyDetectorConstruction.hh.

 {
 // Dimensions check... X Y and Z
 // Firstly check what dimension we are modifying
     {
         if (detectorX > phantomX) 
          {
             G4cout << "Error: Detector X dimension must be smaller or equal to the corrispondent of the phantom" << G4endl;
             return false;
          }
         if ( (phantomX - detectorX) < pos.getX()) 
              {
             G4cout << "Error: X dimension doesn't fit with detector to phantom relative position" << G4endl;
             return false;
              }
     }
 
     {
         if (detectorY > phantomY) 
          {
             G4cout << "Error: Detector Y dimension must be smaller or equal to the corrispondent of the phantom" << G4endl;
             return false;
          }
         if ( (phantomY - detectorY) < pos.getY()) 
          {
            G4cout << "Error: Y dimension doesn't fit with detector to phantom relative position" << G4endl;
            return false;
          }
     }            
 
     {
         if (detectorZ > phantomZ) 
          {
             G4cout << "Error: Detector Z dimension must be smaller or equal to the corrispondent of the phantom" << G4endl;
             return false;
          }
         if ( (phantomZ - detectorZ) < pos.getZ()) 
          {
            G4cout << "Error: Z dimension doesn't fit with detector to phantom relative position" << G4endl;
            return false;
          }
     }
 
     return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParametersCheck()

void HadrontherapyDetectorConstruction::ParametersCheck ( )

private

Definition at line 228 of file HadrontherapyDetectorConstruction.cc.

 {
     // Check phantom/detector sizes & relative position
     if (!IsInside(detectorSizeX,
                   detectorSizeY,
                   detectorSizeZ,
                   phantomSizeX,
                   phantomSizeY,
                   phantomSizeZ,
                   detectorToPhantomPosition
                   ))
         G4Exception("HadrontherapyDetectorConstruction::ParametersCheck()", "Hadrontherapy0001", FatalException, "Error: Detector is not fully inside Phantom!");
     
     // Check Detector sizes respect to the voxel ones
     
     if ( detectorSizeX < sizeOfVoxelAlongX) {
         G4Exception("HadrontherapyDetectorConstruction::ParametersCheck()", "Hadrontherapy0002", FatalException, "Error:  Detector X size must be bigger or equal than that of Voxel X!");
     }
     if ( detectorSizeY < sizeOfVoxelAlongY) {
         G4Exception(" HadrontherapyDetectorConstruction::ParametersCheck()", "Hadrontherapy0003", FatalException, "Error:  Detector Y size must be bigger or equal than that of Voxel Y!");
     }
     if ( detectorSizeZ < sizeOfVoxelAlongZ) {
         G4Exception(" HadrontherapyDetectorConstruction::ParametersCheck()", "Hadrontherapy0004", FatalException, "Error:  Detector Z size must be bigger or equal than that of Voxel Z!");
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrintParameters()

void HadrontherapyDetectorConstruction::PrintParameters ( )

Definition at line 426 of file HadrontherapyDetectorConstruction.cc.

 {
     
     G4cout << "The (X,Y,Z) dimensions of the phantom are : (" <<
     G4BestUnit( phantom -> GetXHalfLength()*2., "Length") << ',' <<
     G4BestUnit( phantom -> GetYHalfLength()*2., "Length") << ',' <<
     G4BestUnit( phantom -> GetZHalfLength()*2., "Length") << ')' << G4endl;
     
     G4cout << "The (X,Y,Z) dimensions of the detector are : (" <<
     G4BestUnit( detector -> GetXHalfLength()*2., "Length") << ',' <<
     G4BestUnit( detector -> GetYHalfLength()*2., "Length") << ',' <<
     G4BestUnit( detector -> GetZHalfLength()*2., "Length") << ')' << G4endl;
     
     G4cout << "Displacement between Phantom and World is: ";
     G4cout << "DX= "<< G4BestUnit(phantomPosition.getX(),"Length") <<
     "DY= "<< G4BestUnit(phantomPosition.getY(),"Length") <<
     "DZ= "<< G4BestUnit(phantomPosition.getZ(),"Length") << G4endl;
     
     G4cout << "The (X,Y,Z) sizes of the Voxels are: (" <<
     G4BestUnit(sizeOfVoxelAlongX, "Length")  << ',' <<
     G4BestUnit(sizeOfVoxelAlongY, "Length")  << ',' <<
     G4BestUnit(sizeOfVoxelAlongZ, "Length") << ')' << G4endl;
     
     G4cout << "The number of Voxels along (X,Y,Z) is: (" <<
     numberOfVoxelsAlongX  << ',' <<
     numberOfVoxelsAlongY  <<','  <<
     numberOfVoxelsAlongZ  << ')' << G4endl;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDetectorPosition()

void HadrontherapyDetectorConstruction::SetDetectorPosition ( )

inline

Definition at line 88 of file HadrontherapyDetectorConstruction.hh.

   { 
       // Adjust detector position
       detectorPosition.setX(detectorToPhantomPosition.getX() - phantomSizeX/2 + detectorSizeX/2);
       detectorPosition.setY(detectorToPhantomPosition.getY() - phantomSizeY/2 + detectorSizeY/2);
       detectorPosition.setZ(detectorToPhantomPosition.getZ() - phantomSizeZ/2 + detectorSizeZ/2);
      
     
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDetectorSize()

void HadrontherapyDetectorConstruction::SetDetectorSize	(	G4double	sizeX,
		G4double	sizeY,
		G4double	sizeZ
	)

Definition at line 291 of file HadrontherapyDetectorConstruction.cc.

 {
     if (sizeX > 0.) {detectorSizeX = sizeX;}
     if (sizeY > 0.) {detectorSizeY = sizeY;}
     if (sizeZ > 0.) {detectorSizeZ = sizeZ;}
     SetVoxelSize(sizeOfVoxelAlongX, sizeOfVoxelAlongY, sizeOfVoxelAlongZ);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDetectorToPhantomPosition()

void HadrontherapyDetectorConstruction::SetDetectorToPhantomPosition ( G4ThreeVector DetectorToPhantomPosition )

Definition at line 314 of file HadrontherapyDetectorConstruction.cc.

 {
     detectorToPhantomPosition = displ;
 }

Here is the caller graph for this function:

◆ SetPhantomMaterial()

G4bool HadrontherapyDetectorConstruction::SetPhantomMaterial ( G4String material )

Definition at line 255 of file HadrontherapyDetectorConstruction.cc.

 {
     
     if (G4Material* pMat = G4NistManager::Instance()->FindOrBuildMaterial(material, false) )
     {
         phantomMaterial  = pMat;
         detectorMaterial = pMat;
         if (detectorLogicalVolume && phantomLogicalVolume)
         {
             detectorLogicalVolume -> SetMaterial(pMat);
             phantomLogicalVolume ->  SetMaterial(pMat);
             
             G4RunManager::GetRunManager() -> PhysicsHasBeenModified();
             G4RunManager::GetRunManager() -> GeometryHasBeenModified();
             G4cout << "The material of Phantom/Detector has been changed to " << material << G4endl;
         }
     }
     else
     {
         G4cout << "WARNING: material \"" << material << "\" doesn't exist in NIST elements/materials"
         " table [located in $G4INSTALL/source/materials/src/G4NistMaterialBuilder.cc]" << G4endl;
         G4cout << "Use command \"/parameter/nist\" to see full materials list!" << G4endl;
         return false;
     }
     
     return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPhantomPosition()

void HadrontherapyDetectorConstruction::SetPhantomPosition ( G4ThreeVector pos )

Definition at line 308 of file HadrontherapyDetectorConstruction.cc.

 {
     phantomPosition = pos;
 }

Here is the caller graph for this function:

◆ SetPhantomSize()

void HadrontherapyDetectorConstruction::SetPhantomSize	(	G4double	sizeX,
		G4double	sizeY,
		G4double	sizeZ
	)

Definition at line 283 of file HadrontherapyDetectorConstruction.cc.

 {
     if (sizeX > 0.) phantomSizeX = sizeX;
     if (sizeY > 0.) phantomSizeY = sizeY;
     if (sizeZ > 0.) phantomSizeZ = sizeZ;
 }

Here is the caller graph for this function:

◆ SetVoxelSize()

void HadrontherapyDetectorConstruction::SetVoxelSize	(	G4double	sizeX,
		G4double	sizeY,
		G4double	sizeZ
	)

Definition at line 300 of file HadrontherapyDetectorConstruction.cc.

 {
     if (sizeX > 0.) {sizeOfVoxelAlongX = sizeX;}
     if (sizeY > 0.) {sizeOfVoxelAlongY = sizeY;}
     if (sizeZ > 0.) {sizeOfVoxelAlongZ = sizeZ;}
 }

Here is the caller graph for this function:

◆ UpdateGeometry()

void HadrontherapyDetectorConstruction::UpdateGeometry ( )

Definition at line 320 of file HadrontherapyDetectorConstruction.cc.

 {
     /*
      * Check parameters consistency
      */
     ParametersCheck();
     
     G4GeometryManager::GetInstance() -> OpenGeometry();
     if (phantom)
     {
         phantom -> SetXHalfLength(phantomSizeX/2);
         phantom -> SetYHalfLength(phantomSizeY/2);
         phantom -> SetZHalfLength(phantomSizeZ/2);
         phantomPhysicalVolume -> SetTranslation(phantomPosition);
     }
     else   ConstructPhantom();
     
     // Get the center of the detector
     SetDetectorPosition();
     if (detector)
     {
         detector -> SetXHalfLength(detectorSizeX/2);
         detector -> SetYHalfLength(detectorSizeY/2);
         detector -> SetZHalfLength(detectorSizeZ/2);
         detectorPhysicalVolume -> SetTranslation(detectorPosition);
     }
     else    ConstructDetector();
     
     // Round to nearest integer number of voxel
     
     numberOfVoxelsAlongX = G4lrint(detectorSizeX / sizeOfVoxelAlongX);
     sizeOfVoxelAlongX = ( detectorSizeX / numberOfVoxelsAlongX );
     numberOfVoxelsAlongY = G4lrint(detectorSizeY / sizeOfVoxelAlongY);
     sizeOfVoxelAlongY = ( detectorSizeY / numberOfVoxelsAlongY );
     numberOfVoxelsAlongZ = G4lrint(detectorSizeZ / sizeOfVoxelAlongZ);
     sizeOfVoxelAlongZ = ( detectorSizeZ / numberOfVoxelsAlongZ );
     PassiveProtonBeamLine *ppbl= (PassiveProtonBeamLine*)
     
     G4RunManager::GetRunManager()->GetUserDetectorConstruction();
     
     HadrontherapyDetectorROGeometry* RO = (HadrontherapyDetectorROGeometry*) ppbl->GetParallelWorld(0);
     
     //Set parameters, either for the Construct() or for the UpdateROGeometry()
     RO->Initialize(GetDetectorToWorldPosition(),
                    detectorSizeX/2,
                    detectorSizeY/2,
                    detectorSizeZ/2,
                    numberOfVoxelsAlongX,
                    numberOfVoxelsAlongY,
                    numberOfVoxelsAlongZ);
     
     //This method below has an effect only if the RO geometry is already built.
     RO->UpdateROGeometry();
     
     
     
     volumeOfVoxel = sizeOfVoxelAlongX * sizeOfVoxelAlongY * sizeOfVoxelAlongZ;
     massOfVoxel = detectorMaterial -> GetDensity() * volumeOfVoxel;
     //  This will clear the existing matrix (together with all data inside it)!
     matrix = HadrontherapyMatrix::GetInstance(numberOfVoxelsAlongX,
                                               numberOfVoxelsAlongY,
                                               numberOfVoxelsAlongZ,
                                               massOfVoxel);
     
     
     // Comment out the line below if let calculation is not needed!
     // Initialize LET with energy of primaries and clear data inside
     if ( (let = HadrontherapyLet::GetInstance(this)) )
     {
         HadrontherapyLet::GetInstance() -> Initialize();
     }
     
     
     // Initialize analysis
 #ifdef G4ANALYSIS_USE_ROOT
     HadrontherapyAnalysisManager* analysis = HadrontherapyAnalysisManager::GetInstance();
     analysis -> flush();     // Finalize the root file
     analysis -> book();
 #endif
     // Inform the kernel about the new geometry
     G4RunManager::GetRunManager() -> GeometryHasBeenModified();
     G4RunManager::GetRunManager() -> PhysicsHasBeenModified();
     
     PrintParameters();
     // CheckOverlaps();
 }