#include <G4PhantomParameterisation.hh>

Inheritance diagram for G4PhantomParameterisation:

Public Member Functions
	G4PhantomParameterisation ()

	~G4PhantomParameterisation ()

virtual void	ComputeTransformation (const G4int, G4VPhysicalVolume *) const

virtual G4VSolid *	ComputeSolid (const G4int, G4VPhysicalVolume *)

virtual G4Material *	ComputeMaterial (const G4int repNo, G4VPhysicalVolume currentVol, const G4VTouchable parentTouch=0)

void	ComputeDimensions (G4Box &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Tubs &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Trd &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Trap &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Cons &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Orb &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Sphere &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Ellipsoid &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Torus &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Para &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Hype &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Polycone &, const G4int, const G4VPhysicalVolume *) const

void	ComputeDimensions (G4Polyhedra &, const G4int, const G4VPhysicalVolume *) const

void	BuildContainerSolid (G4VPhysicalVolume *pPhysicalVol)

void	BuildContainerSolid (G4VSolid *pMotherSolid)

virtual G4int	GetReplicaNo (const G4ThreeVector &localPoint, const G4ThreeVector &localDir)

void	SetMaterials (std::vector< G4Material * > &mates)

void	SetMaterialIndices (size_t *matInd)

void	SetVoxelDimensions (G4double halfx, G4double halfy, G4double halfz)

void	SetNoVoxel (size_t nx, size_t ny, size_t nz)

G4double	GetVoxelHalfX () const

G4double	GetVoxelHalfY () const

G4double	GetVoxelHalfZ () const

size_t	GetNoVoxelX () const

size_t	GetNoVoxelY () const

size_t	GetNoVoxelZ () const

size_t	GetNoVoxel () const

std::vector< G4Material * >	GetMaterials () const

size_t *	GetMaterialIndices () const

G4VSolid *	GetContainerSolid () const

G4ThreeVector	GetTranslation (const G4int copyNo) const

G4bool	SkipEqualMaterials () const

void	SetSkipEqualMaterials (G4bool skip)

size_t	GetMaterialIndex (size_t nx, size_t ny, size_t nz) const

size_t	GetMaterialIndex (size_t copyNo) const

G4Material *	GetMaterial (size_t nx, size_t ny, size_t nz) const

G4Material *	GetMaterial (size_t copyNo) const

void	CheckVoxelsFillContainer (G4double contX, G4double contY, G4double contZ) const

Public Member Functions inherited from G4VPVParameterisation
	G4VPVParameterisation ()

virtual	~G4VPVParameterisation ()

virtual G4bool	IsNested () const

virtual G4VVolumeMaterialScanner *	GetMaterialScanner ()

Protected Attributes
G4double	fVoxelHalfX

G4double	fVoxelHalfY

G4double	fVoxelHalfZ

size_t	fNoVoxelX

size_t	fNoVoxelY

size_t	fNoVoxelZ

size_t	fNoVoxelXY

size_t	fNoVoxel

std::vector< G4Material * >	fMaterials

size_t *	fMaterialIndices

G4VSolid *	fContainerSolid

G4double	fContainerWallX

G4double	fContainerWallY

G4double	fContainerWallZ

G4double	kCarTolerance

G4bool	bSkipEqualMaterials

Detailed Description

Definition at line 73 of file G4PhantomParameterisation.hh.

Constructor & Destructor Documentation

G4PhantomParameterisation::G4PhantomParameterisation ( )

Definition at line 46 of file G4PhantomParameterisation.cc.

References G4GeometryTolerance::GetInstance(), G4GeometryTolerance::GetSurfaceTolerance(), and kCarTolerance.

   : fVoxelHalfX(0.), fVoxelHalfY(0.), fVoxelHalfZ(0.),
     fNoVoxelX(0), fNoVoxelY(0), fNoVoxelZ(0), fNoVoxelXY(0), fNoVoxel(0),
     fMaterialIndices(0), fContainerSolid(0),
     fContainerWallX(0.), fContainerWallY(0.), fContainerWallZ(0.),
     bSkipEqualMaterials(true)
 {
   kCarTolerance = G4GeometryTolerance::GetInstance()->GetSurfaceTolerance();
 }

G4PhantomParameterisation::~G4PhantomParameterisation ( )

Definition at line 58 of file G4PhantomParameterisation.cc.

59 {

60 }

Member Function Documentation

void G4PhantomParameterisation::BuildContainerSolid ( G4VPhysicalVolume * pPhysicalVol )

Definition at line 65 of file G4PhantomParameterisation.cc.

References fContainerSolid, fContainerWallX, fContainerWallY, fContainerWallZ, fNoVoxelX, fNoVoxelY, fNoVoxelZ, fVoxelHalfX, fVoxelHalfY, fVoxelHalfZ, G4VPhysicalVolume::GetLogicalVolume(), and G4LogicalVolume::GetSolid().

 {
   fContainerSolid = pMotherPhysical->GetLogicalVolume()->GetSolid();
   fContainerWallX = fNoVoxelX * fVoxelHalfX;
   fContainerWallY = fNoVoxelY * fVoxelHalfY;
   fContainerWallZ = fNoVoxelZ * fVoxelHalfZ;
 
   // CheckVoxelsFillContainer();
 }

void G4PhantomParameterisation::BuildContainerSolid ( G4VSolid * pMotherSolid )

Definition at line 77 of file G4PhantomParameterisation.cc.

References fContainerSolid, fContainerWallX, fContainerWallY, fContainerWallZ, fNoVoxelX, fNoVoxelY, fNoVoxelZ, fVoxelHalfX, fVoxelHalfY, and fVoxelHalfZ.

 {
   fContainerSolid = pMotherSolid;
   fContainerWallX = fNoVoxelX * fVoxelHalfX;
   fContainerWallY = fNoVoxelY * fVoxelHalfY;
   fContainerWallZ = fNoVoxelZ * fVoxelHalfZ;
 
   // CheckVoxelsFillContainer();
 }

void G4PhantomParameterisation::CheckVoxelsFillContainer	(	G4double	contX,
		G4double	contY,
		G4double	contZ
	)		const

Definition at line 184 of file G4PhantomParameterisation.cc.

References FatalException, fContainerSolid, fNoVoxelX, fNoVoxelY, fNoVoxelZ, fVoxelHalfX, fVoxelHalfY, fVoxelHalfZ, G4endl, G4Exception(), G4VSolid::GetName(), JustWarning, and kCarTolerance.

 {
   G4double toleranceForWarning = 0.25*kCarTolerance;
 
   // Any bigger value than 0.25*kCarTolerance will give a warning in
   // G4NormalNavigation::ComputeStep(), because the Inverse of a container
   // translation that is Z+epsilon gives -Z+epsilon (and the maximum tolerance
   // in G4Box::Inside is 0.5*kCarTolerance
   //
   G4double toleranceForError = 1.*kCarTolerance;  
 
   // Any bigger value than kCarTolerance will give an error in GetReplicaNo()
   //
   if( std::fabs(contX-fNoVoxelX*fVoxelHalfX) >= toleranceForError
    || std::fabs(contY-fNoVoxelY*fVoxelHalfY) >= toleranceForError  
    || std::fabs(contZ-fNoVoxelZ*fVoxelHalfZ) >= toleranceForError )
   {
     std::ostringstream message;
     message << "Voxels do not fully fill the container: "
             << fContainerSolid->GetName() << G4endl
             << "        DiffX= " << contX-fNoVoxelX*fVoxelHalfX << G4endl
             << "        DiffY= " << contY-fNoVoxelY*fVoxelHalfY << G4endl
             << "        DiffZ= " << contZ-fNoVoxelZ*fVoxelHalfZ << G4endl
             << "        Maximum difference is: " << toleranceForError;
     G4Exception("G4PhantomParameterisation::CheckVoxelsFillContainer()",
                 "GeomNav0002", FatalException, message);
 
   }
   else if( std::fabs(contX-fNoVoxelX*fVoxelHalfX) >= toleranceForWarning
         || std::fabs(contY-fNoVoxelY*fVoxelHalfY) >= toleranceForWarning  
         || std::fabs(contZ-fNoVoxelZ*fVoxelHalfZ) >= toleranceForWarning )
   {
     std::ostringstream message;
     message << "Voxels do not fully fill the container: "
             << fContainerSolid->GetName() << G4endl
             << "          DiffX= " << contX-fNoVoxelX*fVoxelHalfX << G4endl
             << "          DiffY= " << contY-fNoVoxelY*fVoxelHalfY << G4endl
             << "          DiffZ= " << contZ-fNoVoxelZ*fVoxelHalfZ << G4endl
             << "          Maximum difference is: " << toleranceForWarning;
     G4Exception("G4PhantomParameterisation::CheckVoxelsFillContainer()",
                 "GeomNav1002", JustWarning, message);
   }
 }

void G4PhantomParameterisation::ComputeDimensions	(	G4Box &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 89 of file G4PhantomParameterisation.hh.

90 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Tubs &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 91 of file G4PhantomParameterisation.hh.

92 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Trd &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 93 of file G4PhantomParameterisation.hh.

94 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Trap &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 95 of file G4PhantomParameterisation.hh.

96 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Cons &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 97 of file G4PhantomParameterisation.hh.

98 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Orb &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 99 of file G4PhantomParameterisation.hh.

100 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Sphere &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 101 of file G4PhantomParameterisation.hh.

102 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Ellipsoid &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 103 of file G4PhantomParameterisation.hh.

104 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Torus &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 105 of file G4PhantomParameterisation.hh.

106 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Para &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 107 of file G4PhantomParameterisation.hh.

108 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Hype &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 109 of file G4PhantomParameterisation.hh.

110 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Polycone &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 111 of file G4PhantomParameterisation.hh.

112 {}

void G4PhantomParameterisation::ComputeDimensions	(	G4Polyhedra &	,
		const G4int	,
		const G4VPhysicalVolume *
	)		const

inlinevirtual

Reimplemented from G4VPVParameterisation.

Definition at line 113 of file G4PhantomParameterisation.hh.

114 {}

G4Material * G4PhantomParameterisation::ComputeMaterial	(	const G4int	repNo,
		G4VPhysicalVolume *	currentVol,
		const G4VTouchable *	parentTouch = `0`
	)

virtual

Reimplemented from G4VPVParameterisation.

Reimplemented in G4PartialPhantomParameterisation, and DicomPhantomParameterisationColour.

Definition at line 129 of file G4PhantomParameterisation.cc.

References fMaterials, and GetMaterialIndex().

Referenced by G4GMocrenFileSceneHandler::AddSolid(), DicomPhantomParameterisationColour::ComputeMaterial(), G4RegularNavigation::ComputeStepSkippingEqualMaterials(), and G4RegularNavigation::LevelLocate().

 { 
   CheckCopyNo( copyNo );
   size_t matIndex = GetMaterialIndex(copyNo);
 
   return fMaterials[ matIndex ];
 }

G4VSolid * G4PhantomParameterisation::ComputeSolid	(	const G4int	,
		G4VPhysicalVolume *	pPhysicalVol
	)

virtual

Reimplemented from G4VPVParameterisation.

Definition at line 121 of file G4PhantomParameterisation.cc.

References G4VPhysicalVolume::GetLogicalVolume(), and G4LogicalVolume::GetSolid().

 {
   return pPhysicalVol->GetLogicalVolume()->GetSolid();
 }

void G4PhantomParameterisation::ComputeTransformation	(	const G4int	copyNo,
		G4VPhysicalVolume *	physVol
	)		const

virtual

Implements G4VPVParameterisation.

Reimplemented in G4PartialPhantomParameterisation.

Definition at line 90 of file G4PhantomParameterisation.cc.

References GetTranslation(), and G4VPhysicalVolume::SetTranslation().

Referenced by G4RegularNavigation::LevelLocate().

 {
   // Voxels cannot be rotated, return translation
   //
   G4ThreeVector trans = GetTranslation( copyNo );
 
   physVol->SetTranslation( trans );
 }

G4VSolid* G4PhantomParameterisation::GetContainerSolid ( ) const

inline

Referenced by G4RegularNavigation::ComputeStepSkippingEqualMaterials().

G4Material * G4PhantomParameterisation::GetMaterial	(	size_t	nx,
		size_t	ny,
		size_t	nz
	)		const

Definition at line 159 of file G4PhantomParameterisation.cc.

References fMaterials, and GetMaterialIndex().

Referenced by DicomIntersectVolume::SetNewValue(), and G4EnergySplitter::SplitEnergyInVolumes().

 {
   return fMaterials[GetMaterialIndex(nx,ny,nz)];
 }

G4Material * G4PhantomParameterisation::GetMaterial ( size_t copyNo ) const

Definition at line 165 of file G4PhantomParameterisation.cc.

References fMaterials, and GetMaterialIndex().

 {
   return fMaterials[GetMaterialIndex(copyNo)];
 }

size_t G4PhantomParameterisation::GetMaterialIndex	(	size_t	nx,
		size_t	ny,
		size_t	nz
	)		const

Definition at line 151 of file G4PhantomParameterisation.cc.

References fNoVoxelX, and fNoVoxelXY.

Referenced by ComputeMaterial(), GetMaterial(), and DicomIntersectVolume::SetNewValue().

 {
   size_t copyNo = nx + fNoVoxelX*ny + fNoVoxelXY*nz;
   return GetMaterialIndex( copyNo );
 }

size_t G4PhantomParameterisation::GetMaterialIndex ( size_t copyNo ) const

Definition at line 140 of file G4PhantomParameterisation.cc.

References fMaterialIndices.

 {
   CheckCopyNo( copyNo );
 
   if( !fMaterialIndices ) { return 0; }
   return *(fMaterialIndices+copyNo);
 }

size_t* G4PhantomParameterisation::GetMaterialIndices ( ) const

inline

std::vector<G4Material*> G4PhantomParameterisation::GetMaterials ( ) const

inline

Referenced by DicomIntersectVolume::SetNewValue().

size_t G4PhantomParameterisation::GetNoVoxel ( ) const

inline

Referenced by G4RegularNavigation::LevelLocate().

size_t G4PhantomParameterisation::GetNoVoxelX ( ) const

inline

Referenced by G4GMocrenFileSceneHandler::AddSolid(), and DicomIntersectVolume::SetNewValue().

size_t G4PhantomParameterisation::GetNoVoxelY ( ) const

inline

Referenced by G4GMocrenFileSceneHandler::AddSolid(), and DicomIntersectVolume::SetNewValue().

size_t G4PhantomParameterisation::GetNoVoxelZ ( ) const

inline

Referenced by G4GMocrenFileSceneHandler::AddSolid(), and DicomIntersectVolume::SetNewValue().

G4int G4PhantomParameterisation::GetReplicaNo	(	const G4ThreeVector &	localPoint,
		const G4ThreeVector &	localDir
	)

virtual

Reimplemented in G4PartialPhantomParameterisation.

Definition at line 231 of file G4PhantomParameterisation.cc.

References FatalErrorInArgument, fContainerSolid, fContainerWallX, fContainerWallY, fContainerWallZ, fNoVoxelX, fNoVoxelXY, fNoVoxelY, fNoVoxelZ, fVoxelHalfX, fVoxelHalfY, fVoxelHalfZ, G4endl, G4Exception(), G4VSolid::GetName(), G4VSolid::Inside(), JustWarning, kCarTolerance, kOutside, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by G4RegularNavigation::ComputeStep(), G4RegularNavigation::ComputeStepSkippingEqualMaterials(), and G4RegularNavigation::LevelLocate().

 {
 
   // Check first that point is really inside voxels
   //
   if( fContainerSolid->Inside( localPoint ) == kOutside )
   {
     std::ostringstream message;
     message << "Point outside voxels!" << G4endl
             << "        localPoint - " << localPoint
             << " - is outside container solid: "
             << fContainerSolid->GetName() << G4endl;
     G4Exception("G4PhantomParameterisation::GetReplicaNo()", "GeomNav0003",
                 FatalErrorInArgument, message);
   }
   
   // Check the voxel numbers corresponding to localPoint
   // When a particle is on a surface, it may be between -kCarTolerance and
   // +kCartolerance. By a simple distance as:
   //   G4int nx = G4int( (localPoint.x()+)/fVoxelHalfX/2.);
   // those between -kCartolerance and 0 will be placed on voxel N-1 and those
   // between 0 and kCarTolerance on voxel N.
   // To avoid precision problems place the tracks that are on the surface on
   // voxel N-1 if they have negative direction and on voxel N if they have
   // positive direction.
   // Add +kCarTolerance so that they are first placed on voxel N, and then
   // if the direction is negative substract 1
 
   G4double fx = (localPoint.x()+fContainerWallX+kCarTolerance)/(fVoxelHalfX*2.);
   G4int nx = G4int(fx);
 
   G4double fy = (localPoint.y()+fContainerWallY+kCarTolerance)/(fVoxelHalfY*2.);
   G4int ny = G4int(fy);
 
   G4double fz = (localPoint.z()+fContainerWallZ+kCarTolerance)/(fVoxelHalfZ*2.);
   G4int nz = G4int(fz);
 
   // If it is on the surface side, check the direction: if direction is
   // negative place it on the previous voxel (if direction is positive it is
   // already in the next voxel...). 
   // Correct also cases where n = -1 or n = fNoVoxel. It is always traced to be
   // due to multiple scattering: track is entering a voxel but multiple
   // scattering changes the angle towards outside
   //
   if( fx - nx < kCarTolerance/fVoxelHalfX )
   {
     if( localDir.x() < 0 )
     {
       if( nx != 0 )
       {
         nx -= 1;
       }
     }
     else
     {
       if( nx == G4int(fNoVoxelX) )  
       {
         nx -= 1;       
       }
     }
   }
   if( fy - ny < kCarTolerance/fVoxelHalfY )
   {
     if( localDir.y() < 0 )
     {
       if( ny != 0 )
       {
         ny -= 1;
       }
     }
     else
     {
       if( ny == G4int(fNoVoxelY) )  
       {
         ny -= 1;       
       }
     }
   }
   if( fz - nz < kCarTolerance/fVoxelHalfZ )
   {
     if( localDir.z() < 0 )
     {
       if( nz != 0 )
       {
         nz -= 1;
       }
     }
     else
     {
       if( nz == G4int(fNoVoxelZ) )  
       {
         nz -= 1;       
       }
     }
   }
   
   G4int copyNo = nx + fNoVoxelX*ny + fNoVoxelXY*nz;
 
   // Check if there are still errors 
   //
   G4bool isOK = true;
   if( nx < 0 )
   {
     nx = 0;
     isOK = false;
   }
   else if( nx >= G4int(fNoVoxelX) )
   {
     nx = fNoVoxelX-1;
     isOK = false;
   }
   if( ny < 0 )
   {
     ny = 0;
     isOK = false;
   }
   else if( ny >= G4int(fNoVoxelY) )
   {
     ny = fNoVoxelY-1;
     isOK = false;
   }
   if( nz < 0 )
   {
     nz = 0;
     isOK = false;
   }
   else if( nz >= G4int(fNoVoxelZ) )
   {
     nz = fNoVoxelZ-1;
     isOK = false;
   }
   if( !isOK )
   {
     std::ostringstream message;
     message << "Corrected the copy number! It was negative or too big" << G4endl
             << "          LocalPoint: " << localPoint << G4endl
             << "          LocalDir: " << localDir << G4endl
             << "          Voxel container size: " << fContainerWallX
             << " " << fContainerWallY << " " << fContainerWallZ << G4endl
             << "          LocalPoint - wall: "
             << localPoint.x()-fContainerWallX << " "
             << localPoint.y()-fContainerWallY << " "
             << localPoint.z()-fContainerWallZ;
     G4Exception("G4PhantomParameterisation::GetReplicaNo()",
                 "GeomNav1002", JustWarning, message);
     copyNo = nx + fNoVoxelX*ny + fNoVoxelXY*nz;
   }
 
   // CheckCopyNo( copyNo ); // not needed, just for debugging code
 
   return copyNo;
 }

G4ThreeVector G4PhantomParameterisation::GetTranslation ( const G4int copyNo ) const

Definition at line 102 of file G4PhantomParameterisation.cc.

References fContainerWallX, fContainerWallY, fContainerWallZ, fVoxelHalfX, fVoxelHalfY, and fVoxelHalfZ.

Referenced by G4RegularNavigation::ComputeStep(), G4RegularNavigation::ComputeStepSkippingEqualMaterials(), and ComputeTransformation().

 {
   CheckCopyNo( copyNo );
 
   size_t nx;
   size_t ny;
   size_t nz;
 
   ComputeVoxelIndices( copyNo, nx, ny, nz );
 
   G4ThreeVector trans( (2*nx+1)*fVoxelHalfX - fContainerWallX,
                        (2*ny+1)*fVoxelHalfY - fContainerWallY,
                        (2*nz+1)*fVoxelHalfZ - fContainerWallZ);
   return trans;
 }