MedicalBeam Class Reference

#include <MedicalBeam.hh>

Inheritance diagram for MedicalBeam:

Collaboration diagram for MedicalBeam:

Public Types
enum	FieldShape {   SQUARE =0, CIRCLE, kSQUARE =0, kCIRCLE,   kSQUARE =0, kCIRCLE }
enum	FieldShape {   SQUARE =0, CIRCLE, kSQUARE =0, kCIRCLE,   kSQUARE =0, kCIRCLE }
enum	FieldShape {   SQUARE =0, CIRCLE, kSQUARE =0, kCIRCLE,   kSQUARE =0, kCIRCLE }

Public Member Functions
	MedicalBeam ()
	~MedicalBeam ()
void	SetParticleDefinition (G4ParticleDefinition *pd)
const G4ParticleDefinition *	GetParticleDefinition () const
void	SetKineticE (G4double e)
G4double	GetKineticE () const
void	SetSourcePosition (const G4ThreeVector &pos)
G4ThreeVector	GetSourcePosition () const
void	SetFieldShape (FieldShape shape)
FieldShape	GetFieldShape () const
void	SetSSD (G4double ssd)
G4double	GetSSD () const
void	SetFieldXY (G4double fx, G4double fy)
G4double	GetFieldX () const
G4double	GetFieldY () const
void	SetFieldR (G4double r)
G4double	GetFieldR () const
virtual void	GeneratePrimaries (G4Event *anEvent)
	MedicalBeam ()
	~MedicalBeam ()
void	SetParticleDefinition (G4ParticleDefinition *pd)
const G4ParticleDefinition *	GetParticleDefinition () const
void	SetKineticE (G4double e)
G4double	GetKineticE () const
void	SetSourcePosition (const G4ThreeVector &pos)
G4ThreeVector	GetSourcePosition () const
void	SetFieldShape (FieldShape shape)
FieldShape	GetFieldShape () const
void	SetSSD (G4double ssd)
G4double	GetSSD () const
void	SetFieldXY (G4double fx, G4double fy)
G4double	GetFieldX () const
G4double	GetFieldY () const
void	SetFieldR (G4double r)
G4double	GetFieldR () const
virtual void	GeneratePrimaries (G4Event *anEvent)
	MedicalBeam ()
	~MedicalBeam ()
void	SetParticleDefinition (G4ParticleDefinition *pd)
const G4ParticleDefinition *	GetParticleDefinition () const
void	SetKineticE (G4double e)
G4double	GetKineticE () const
void	SetSourcePosition (const G4ThreeVector &pos)
G4ThreeVector	GetSourcePosition () const
void	SetFieldShape (FieldShape shape)
FieldShape	GetFieldShape () const
void	SetSSD (G4double ssd)
G4double	GetSSD () const
void	SetFieldXY (G4double fx, G4double fy)
G4double	GetFieldX () const
G4double	GetFieldY () const
void	SetFieldR (G4double r)
G4double	GetFieldR () const
virtual void	GeneratePrimaries (G4Event *anEvent)
Public Member Functions inherited from G4VUserPrimaryGeneratorAction
	G4VUserPrimaryGeneratorAction ()
virtual	~G4VUserPrimaryGeneratorAction ()

Protected Member Functions
G4ThreeVector	GenerateBeamDirection () const

Protected Attributes
G4ParticleDefinition *	particle
G4double	kineticE
G4ThreeVector	sourcePosition
G4double	SSD
FieldShape	fieldShape
G4double	fieldXY [2]
G4double	fieldR

Private Member Functions
G4ThreeVector	GenerateBeamDirection () const
G4ThreeVector	GenerateBeamDirection () const

Private Attributes
G4ParticleDefinition *	fparticle
G4double	fkineticE
G4ThreeVector	fsourcePosition
G4double	fSSD
FieldShape	ffieldShape
G4double	ffieldXY [2]
G4double	ffieldR

Detailed Description

Definition at line 46 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

Member Enumeration Documentation

FieldShape [1/3]

enum MedicalBeam::FieldShape

Enumerator
SQUARE
CIRCLE
kSQUARE
kCIRCLE
kSQUARE
kCIRCLE

Definition at line 42 of file examples/extended/parallel/MPI/examples/exMPI02/include/MedicalBeam.hh.

{ kSQUARE=0, kCIRCLE };

FieldShape [2/3]

enum MedicalBeam::FieldShape

Enumerator
SQUARE
CIRCLE
kSQUARE
kCIRCLE
kSQUARE
kCIRCLE

Definition at line 42 of file examples/extended/parallel/MPI/examples/exMPI03/include/MedicalBeam.hh.

{ kSQUARE=0, kCIRCLE };

FieldShape [3/3]

enum MedicalBeam::FieldShape

Enumerator
SQUARE
CIRCLE
kSQUARE
kCIRCLE
kSQUARE
kCIRCLE

Definition at line 48 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ SQUARE=0, CIRCLE };

Constructor & Destructor Documentation

MedicalBeam() [1/3]

MedicalBeam::MedicalBeam

(

)

~MedicalBeam() [1/3]

MedicalBeam::~MedicalBeam

(

)

MedicalBeam() [2/3]

MedicalBeam::MedicalBeam

(

)

~MedicalBeam() [2/3]

MedicalBeam::~MedicalBeam

(

)

MedicalBeam() [3/3]

MedicalBeam::MedicalBeam

(

)

Definition at line 49 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.cc.

  : particle(0), 
    kineticE(1.*MeV),
    sourcePosition(G4ThreeVector()),
    SSD(1.*m), 
    fieldShape(MedicalBeam::SQUARE),
    fieldR(10.*cm)
{
  fieldXY[0]= fieldXY[1]= 10.*cm;
}

~MedicalBeam() [3/3]

MedicalBeam::~MedicalBeam

(

)

Definition at line 63 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.cc.

{
}

Member Function Documentation

GenerateBeamDirection() [1/3]

G4ThreeVector MedicalBeam::GenerateBeamDirection ( ) const

protected

Here is the caller graph for this function:

GenerateBeamDirection() [2/3]

G4ThreeVector MedicalBeam::GenerateBeamDirection ( ) const

private

GenerateBeamDirection() [3/3]

G4ThreeVector MedicalBeam::GenerateBeamDirection ( ) const

private

Definition at line 70 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.cc.

{
  // uniform distribution in a limitted solid angle
  G4double dr;
  if(fieldShape == MedicalBeam::SQUARE) {
    dr= std::sqrt(sqr(fieldXY[0]/2.)+sqr(fieldXY[1]/2.));
  } else {
    dr= fieldR;
  }

  G4double sin0= dr/SSD;
  G4double cos0= std::sqrt(1.-sqr(sin0));

  G4double dcos, dsin, dphi, z;

  G4double x= DBL_MAX;
  G4double y= DBL_MAX;

  G4double xmax, ymax;
  if(fieldShape == MedicalBeam::SQUARE) {
    xmax= fieldXY[0]/2./SSD;
    ymax= fieldXY[1]/2./SSD;
  } else {
    xmax= ymax= DBL_MAX-1.;
  }

  while(! (std::abs(x)< xmax && std::abs(y)< ymax) ) {
    dcos= RandFlat::shoot(cos0, 1.);
    dsin= std::sqrt(1.-sqr(dcos));
    dphi= RandFlat::shoot(0., twopi);

    x= std::cos(dphi)*dsin*dcos;
    y= std::sin(dphi)*dsin*dcos;
  }
  z= dcos;

  return G4ThreeVector(x,y,z);
}

Here is the call graph for this function:

GeneratePrimaries() [1/3]

virtual void MedicalBeam::GeneratePrimaries ( G4Event *  anEvent )

virtual

Implements G4VUserPrimaryGeneratorAction.

GeneratePrimaries() [2/3]

void MedicalBeam::GeneratePrimaries ( G4Event *  anEvent )

virtual

Implements G4VUserPrimaryGeneratorAction.

Definition at line 112 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.cc.

{
  if(particle==0) return;

  // create a new vertex
  G4PrimaryVertex* vertex= new G4PrimaryVertex(sourcePosition, 0.*ns);

  // momentum
  G4double mass= particle-> GetPDGMass();
  G4double p= std::sqrt(sqr(mass+kineticE)-sqr(mass));
  G4ThreeVector pmon= p*GenerateBeamDirection();
  G4PrimaryParticle* primary= new G4PrimaryParticle(particle, 
                            pmon.x(), 
                            pmon.y(), 
                            pmon.z());
  // set primary to vertex
  vertex-> SetPrimary(primary);

  // set vertex to event
  anEvent-> AddPrimaryVertex(vertex);
}

Here is the call graph for this function:

GeneratePrimaries() [3/3]

virtual void MedicalBeam::GeneratePrimaries ( G4Event *  anEvent )

virtual

Implements G4VUserPrimaryGeneratorAction.

GetFieldR() [1/3]

G4double MedicalBeam::GetFieldR

(

)

const

GetFieldR() [2/3]

G4double MedicalBeam::GetFieldR

(

)

const

GetFieldR() [3/3]

G4double MedicalBeam::GetFieldR ( ) const

inline

Definition at line 140 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ return fieldR; }

Here is the caller graph for this function:

GetFieldShape() [1/3]

FieldShape MedicalBeam::GetFieldShape

(

)

const

GetFieldShape() [2/3]

FieldShape MedicalBeam::GetFieldShape

(

)

const

GetFieldShape() [3/3]

MedicalBeam::FieldShape MedicalBeam::GetFieldShape ( ) const

inline

Definition at line 119 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ return fieldShape; }

Here is the caller graph for this function:

GetFieldX() [1/3]

G4double MedicalBeam::GetFieldX

(

)

const

GetFieldX() [2/3]

G4double MedicalBeam::GetFieldX

(

)

const

GetFieldX() [3/3]

G4double MedicalBeam::GetFieldX ( ) const

inline

Definition at line 131 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ return fieldXY[0]; }

Here is the caller graph for this function:

GetFieldY() [1/3]

G4double MedicalBeam::GetFieldY

(

)

const

GetFieldY() [2/3]

G4double MedicalBeam::GetFieldY

(

)

const

GetFieldY() [3/3]

G4double MedicalBeam::GetFieldY ( ) const

inline

Definition at line 134 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ return fieldXY[1]; }

Here is the caller graph for this function:

GetKineticE() [1/3]

G4double MedicalBeam::GetKineticE

(

)

const

GetKineticE() [2/3]

G4double MedicalBeam::GetKineticE

(

)

const

GetKineticE() [3/3]

G4double MedicalBeam::GetKineticE ( ) const

inline

Definition at line 107 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ return kineticE; }

Here is the caller graph for this function:

GetParticleDefinition() [1/3]

const G4ParticleDefinition* MedicalBeam::GetParticleDefinition

(

)

const

GetParticleDefinition() [2/3]

const G4ParticleDefinition* MedicalBeam::GetParticleDefinition

(

)

const

GetParticleDefinition() [3/3]

const G4ParticleDefinition * MedicalBeam::GetParticleDefinition ( ) const

inline

Definition at line 101 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ return particle; }

GetSourcePosition() [1/3]

G4ThreeVector MedicalBeam::GetSourcePosition

(

)

const

GetSourcePosition() [2/3]

G4ThreeVector MedicalBeam::GetSourcePosition

(

)

const

GetSourcePosition() [3/3]

G4ThreeVector MedicalBeam::GetSourcePosition ( ) const

inline

Definition at line 113 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ return sourcePosition; }

Here is the caller graph for this function:

GetSSD() [1/3]

G4double MedicalBeam::GetSSD

(

)

const

GetSSD() [2/3]

G4double MedicalBeam::GetSSD

(

)

const

GetSSD() [3/3]

G4double MedicalBeam::GetSSD ( ) const

inline

Definition at line 125 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ return SSD; }

Here is the caller graph for this function:

SetFieldR() [1/3]

void MedicalBeam::SetFieldR

(

G4double

r

)

SetFieldR() [2/3]

void MedicalBeam::SetFieldR

(

G4double

r

)

SetFieldR() [3/3]

void MedicalBeam::SetFieldR ( G4double  r )

inline

Definition at line 137 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ fieldR= r; }

Here is the caller graph for this function:

SetFieldShape() [1/3]

void MedicalBeam::SetFieldShape

(

FieldShape

shape

)

SetFieldShape() [2/3]

void MedicalBeam::SetFieldShape

(

FieldShape

shape

)

SetFieldShape() [3/3]

void MedicalBeam::SetFieldShape ( MedicalBeam::FieldShape  shape )

inline

Definition at line 116 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ fieldShape= shape; }

Here is the caller graph for this function:

SetFieldXY() [1/3]

void MedicalBeam::SetFieldXY	(	G4double	fx,
		G4double	fy
	)

SetFieldXY() [2/3]

void MedicalBeam::SetFieldXY	(	G4double	fx,
		G4double	fy
	)

SetFieldXY() [3/3]

void MedicalBeam::SetFieldXY ( G4double  fx, G4double  fy  )

inline

Definition at line 128 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ fieldXY[0]= fx; fieldXY[1]= fy; }

SetKineticE() [1/3]

void MedicalBeam::SetKineticE

(

G4double

e

)

SetKineticE() [2/3]

void MedicalBeam::SetKineticE

(

G4double

e

)

SetKineticE() [3/3]

void MedicalBeam::SetKineticE ( G4double  e )

inline

Definition at line 104 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ kineticE= e; }

Here is the caller graph for this function:

SetParticleDefinition() [1/3]

void MedicalBeam::SetParticleDefinition

(

G4ParticleDefinition *

pd

)

SetParticleDefinition() [2/3]

void MedicalBeam::SetParticleDefinition

(

G4ParticleDefinition *

pd

)

SetParticleDefinition() [3/3]

void MedicalBeam::SetParticleDefinition ( G4ParticleDefinition *  pd )

inline

Definition at line 98 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ particle= pd; }

SetSourcePosition() [1/3]

void MedicalBeam::SetSourcePosition

(

const G4ThreeVector &

pos

)

SetSourcePosition() [2/3]

void MedicalBeam::SetSourcePosition

(

const G4ThreeVector &

pos

)

SetSourcePosition() [3/3]

void MedicalBeam::SetSourcePosition ( const G4ThreeVector &  pos )

inline

Definition at line 110 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ sourcePosition= pos; }

Here is the caller graph for this function:

SetSSD() [1/3]

void MedicalBeam::SetSSD

(

G4double

ssd

)

SetSSD() [2/3]

void MedicalBeam::SetSSD

(

G4double

ssd

)

SetSSD() [3/3]

void MedicalBeam::SetSSD ( G4double  ssd )

inline

Definition at line 122 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

{ SSD= ssd; }

Here is the caller graph for this function:

Member Data Documentation

ffieldR

G4double MedicalBeam::ffieldR

private

Definition at line 84 of file examples/extended/parallel/MPI/examples/exMPI02/include/MedicalBeam.hh.

ffieldShape

FieldShape MedicalBeam::ffieldShape

private

Definition at line 82 of file examples/extended/parallel/MPI/examples/exMPI02/include/MedicalBeam.hh.

ffieldXY

G4double MedicalBeam::ffieldXY

private

Definition at line 83 of file examples/extended/parallel/MPI/examples/exMPI02/include/MedicalBeam.hh.

fieldR

G4double MedicalBeam::fieldR

protected

Definition at line 58 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

fieldShape

FieldShape MedicalBeam::fieldShape

protected

Definition at line 56 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

fieldXY

G4double MedicalBeam::fieldXY[2]

protected

Definition at line 57 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

fkineticE

G4double MedicalBeam::fkineticE

private

Definition at line 78 of file examples/extended/parallel/MPI/examples/exMPI02/include/MedicalBeam.hh.

fparticle

G4ParticleDefinition * MedicalBeam::fparticle

private

Definition at line 77 of file examples/extended/parallel/MPI/examples/exMPI02/include/MedicalBeam.hh.

fsourcePosition

G4ThreeVector MedicalBeam::fsourcePosition

private

Definition at line 79 of file examples/extended/parallel/MPI/examples/exMPI02/include/MedicalBeam.hh.

fSSD

G4double MedicalBeam::fSSD

private

Definition at line 81 of file examples/extended/parallel/MPI/examples/exMPI02/include/MedicalBeam.hh.

kineticE

G4double MedicalBeam::kineticE

protected

Definition at line 52 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

particle

G4ParticleDefinition* MedicalBeam::particle

protected

Definition at line 51 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

sourcePosition

G4ThreeVector MedicalBeam::sourcePosition

protected

Definition at line 53 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

SSD

G4double MedicalBeam::SSD

protected

Definition at line 55 of file environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh.

---

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

• environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.hh
• environments/g4py/site-modules/primaries/MedicalBeam/MedicalBeam.cc