REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | Friends
TRestGeant4PrimaryGeneratorInfo Class Reference

Detailed Description

Definition at line 93 of file TRestGeant4PrimaryGeneratorInfo.h.

Public Member Functions

Double_t GetSpatialGeneratorCosmicRadius () const
 Returns cosmic generator radius (mm)
 
Double_t GetSpatialGeneratorCosmicSurfaceTermCm2 () const
 Returns cosmic surface term (cm2) for simulation time computation.
 
TString GetSpatialGeneratorFrom () const
 Returns the name of the GDML volume where primary events are produced. This value has meaning only when using volume or surface generator types.
 
TVector3 GetSpatialGeneratorPosition () const
 Returns a 3d-std::vector with the position of the primary event generator. This value has meaning only when using point and virtual generator types.
 
TVector3 GetSpatialGeneratorRotationAxis () const
 Returns a 3d-std::vector, fGenRotation, with the XYZ rotation angle values in degrees. This value is used by virtualWall, virtualCircleWall and virtualCylinder generator types.
 
Double_t GetSpatialGeneratorRotationValue () const
 Returns the degree of rotation.
 
TString GetSpatialGeneratorShape () const
 Returns a std::string specifying the generator shape (point, wall, box, etc )
 
TVector3 GetSpatialGeneratorSize () const
 Returns the main spatial dimension of virtual generator. It is the size of a virtualBox.
 
TString GetSpatialGeneratorSpatialDensityFunction () const
 Returns the density function of the generator.
 
TString GetSpatialGeneratorType () const
 Returns a std::string specifying the generator type (volume, surface, point, virtualWall, etc )
 
TVector3 GetSpatialGeneratorWorldSize () const
 
void Print () const
 

Private Attributes

TString fSpatialGeneratorFrom
 The volume name where the events are generated, in case of volume or surface generator types.
 
TVector3 fSpatialGeneratorPosition
 The position of the generator for virtual, and point, generator types.
 
TVector3 fSpatialGeneratorRotationAxis
 A 3d-std::vector with the angles, measured in degrees, of a XYZ rotation applied to the virtual generator. This rotation is used by virtualWall, virtualCircleWall and virtualCylinder generators.
 
Double_t fSpatialGeneratorRotationValue = 0
 degrees of rotation for generator virtual shape along the axis
 
TString fSpatialGeneratorShape
 Shape of spatial generator (wall, GDML, sphere, etc)
 
TVector3 fSpatialGeneratorSize
 The size of the generator. Stores up to three dimensions according to the shape box: length, width, height sphere: radius wall: length, width circle: radius cylinder: radius, length.
 
TString fSpatialGeneratorSpatialDensityFunction
 Defines density distribution of the generator shape. rho=F(x,y,z), in range 0~1.
 
TString fSpatialGeneratorType = "point"
 Type of spatial generator (point, surface, volume, custom)
 
TVector3 fSpatialGeneratorWorldSize
 The size of the world volume (box half lengths for x, y and z)
 

Friends

class DetectorConstruction
 
class TRestGeant4Metadata
 

Member Function Documentation

◆ GetSpatialGeneratorCosmicRadius()

Double_t TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorCosmicRadius ( ) const
inline

Returns cosmic generator radius (mm)

Definition at line 161 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorCosmicSurfaceTermCm2()

Double_t TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorCosmicSurfaceTermCm2 ( ) const
inline

Returns cosmic surface term (cm2) for simulation time computation.

Definition at line 164 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorFrom()

TString TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorFrom ( ) const
inline

Returns the name of the GDML volume where primary events are produced. This value has meaning only when using volume or surface generator types.

Definition at line 142 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorPosition()

TVector3 TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorPosition ( ) const
inline

Returns a 3d-std::vector with the position of the primary event generator. This value has meaning only when using point and virtual generator types.

Definition at line 146 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorRotationAxis()

TVector3 TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorRotationAxis ( ) const
inline

Returns a 3d-std::vector, fGenRotation, with the XYZ rotation angle values in degrees. This value is used by virtualWall, virtualCircleWall and virtualCylinder generator types.

Definition at line 150 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorRotationValue()

Double_t TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorRotationValue ( ) const
inline

Returns the degree of rotation.

Definition at line 153 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorShape()

TString TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorShape ( ) const
inline

Returns a std::string specifying the generator shape (point, wall, box, etc )

Definition at line 138 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorSize()

TVector3 TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorSize ( ) const
inline

Returns the main spatial dimension of virtual generator. It is the size of a virtualBox.

Definition at line 156 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorSpatialDensityFunction()

TString TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorSpatialDensityFunction ( ) const
inline

Returns the density function of the generator.

Definition at line 170 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorType()

TString TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorType ( ) const
inline

Returns a std::string specifying the generator type (volume, surface, point, virtualWall, etc )

Definition at line 135 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ GetSpatialGeneratorWorldSize()

TVector3 TRestGeant4PrimaryGeneratorInfo::GetSpatialGeneratorWorldSize ( ) const
inline

Definition at line 158 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ Print()

void TRestGeant4PrimaryGeneratorInfo::Print ( ) const

Definition at line 402 of file TRestGeant4PrimaryGeneratorInfo.cxx.

Friends And Related Symbol Documentation

◆ DetectorConstruction

friend class DetectorConstruction
friend

Definition at line 175 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ TRestGeant4Metadata

friend class TRestGeant4Metadata
friend

Definition at line 174 of file TRestGeant4PrimaryGeneratorInfo.h.

Field Documentation

◆ fSpatialGeneratorFrom

TString TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorFrom
private

The volume name where the events are generated, in case of volume or surface generator types.

Definition at line 107 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ fSpatialGeneratorPosition

TVector3 TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorPosition
private

The position of the generator for virtual, and point, generator types.

Definition at line 110 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ fSpatialGeneratorRotationAxis

TVector3 TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorRotationAxis
private

A 3d-std::vector with the angles, measured in degrees, of a XYZ rotation applied to the virtual generator. This rotation is used by virtualWall, virtualCircleWall and virtualCylinder generators.

Definition at line 114 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ fSpatialGeneratorRotationValue

Double_t TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorRotationValue = 0
private

degrees of rotation for generator virtual shape along the axis

Definition at line 117 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ fSpatialGeneratorShape

TString TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorShape
private

Shape of spatial generator (wall, GDML, sphere, etc)

Definition at line 104 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ fSpatialGeneratorSize

TVector3 TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorSize
private

The size of the generator. Stores up to three dimensions according to the shape box: length, width, height sphere: radius wall: length, width circle: radius cylinder: radius, length.

Definition at line 125 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ fSpatialGeneratorSpatialDensityFunction

TString TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorSpatialDensityFunction
private

Defines density distribution of the generator shape. rho=F(x,y,z), in range 0~1.

Definition at line 128 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ fSpatialGeneratorType

TString TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorType = "point"
private

Type of spatial generator (point, surface, volume, custom)

Definition at line 101 of file TRestGeant4PrimaryGeneratorInfo.h.

◆ fSpatialGeneratorWorldSize

TVector3 TRestGeant4PrimaryGeneratorInfo::fSpatialGeneratorWorldSize
private

The size of the world volume (box half lengths for x, y and z)

Definition at line 131 of file TRestGeant4PrimaryGeneratorInfo.h.

The documentation for this class was generated from the following files:
Generated on Mon Jan 20 2025 12:40:41 for REST-for-Physics by doxygen 1.9.8