A Gaussian shape. More...

#include <egs_gaussian_shape.h>

Inheritance diagram for EGS_GaussianShape:

Public Member Functions
	EGS_GaussianShape (EGS_BaseShape Shape, EGS_Float sx, EGS_Float sy, EGS_Float sz, const string &Name="", EGS_ObjectFactory f=0)

EGS_Vector	getPoint (EGS_RandomGenerator *rndm)

bool	supportsDirectionMethod () const

void	getPointSourceDirection (const EGS_Vector &Xo, EGS_RandomGenerator *rndm, EGS_Vector &u, EGS_Float &wt)

Public Member Functions inherited from EGS_BaseShape
	EGS_BaseShape (const string &Name="", EGS_ObjectFactory *f=0)
	Construct a shape named Name.

virtual	~EGS_BaseShape ()
	Destructor. Deletes T if it is not `null`.

virtual EGS_Vector	getRandomPoint (EGS_RandomGenerator *rndm)
	Returns a random 3D vector. More...

void	setTransformation (EGS_Input *inp)
	Set the transformation attached to this shape. More...

void	setTransformation (EGS_AffineTransform *t)
	Set the transformation attached to this shape. More...

const EGS_AffineTransform *	getTransform () const
	Get a pointer to the affine transformation attached to this shape.

virtual EGS_Float	area () const

Public Member Functions inherited from EGS_Object
	EGS_Object (const string &Name="", EGS_ObjectFactory *f=0)
	Create an EGS_Object named Name belonging to the object factory f. More...

	EGS_Object (EGS_Input inp, EGS_ObjectFactory f=0)
	Create an EGS_Object from the information pointed to by inp that belongs to object factory f. More...

const string &	getObjectName () const
	Get the object name.

void	setObjectName (const string &Name)
	Set the object name to Name.

const string &	getObjectType () const
	Get the object type.

virtual EGS_Object *	createObject (EGS_Input *inp)
	Create an object from the infromation pointed to by inp. More...

void	setName (EGS_Input *inp)
	Set the name of the object from the information provided by inp. More...

int	ref ()
	Increase the reference count to this object.

int	deref ()
	Decrease the reference count to this object.

void	setFactory (EGS_ObjectFactory *f)
	Set the factory to which the object belongs. More...

Protected Attributes
EGS_BaseShape *	shape

EGS_Float	sig_x

EGS_Float	sig_y

EGS_Float	sig_z

Protected Attributes inherited from EGS_BaseShape
EGS_AffineTransform *	T
	The affine transformation attached to the shape.

Protected Attributes inherited from EGS_Object
string	name
	The object name.

string	otype
	The object type.

int	nref
	Number of references to the object.

EGS_ObjectFactory *	factory
	The factory this object belongs to.

Additional Inherited Members
Static Public Member Functions inherited from EGS_BaseShape
static EGS_BaseShape *	createShape (EGS_Input *inp)
	Create a shape from the information pointed to by inp. More...

static EGS_BaseShape *	getShape (const string &Name)
	Get a pointer to the shape named Name. More...

Static Public Member Functions inherited from EGS_Object
static string	getUniqueName (const EGS_Object *o=0)
	Create and return a unique object name. More...

static void	deleteObject (EGS_Object *o)
	Delete an object. More...

Detailed Description

A Gaussian shape.

A Gaussian shape is a shape that picks points randomly within another shape and then adds $\Delta \vec{x} = (\Delta x, \Delta y, \Delta z)$ to the points where $\Delta x, \Delta y$ and $\Delta z$ are sampled from Gaussian distributions with widths $\sigma_x, \sigma_y$ and $\sigma_z$ . A Gaussian shape is defined via

:start shape:
    library = egs_gaussian_shape
    :start shape:
        definition of the shape to be smeared
    :stop shape:
    sigma = 1 or 2 or 3 inputs
:stop shape:

If a single input is found for the sigma key, then $\sigma_y = \sigma_z = 0$ , if two inputs are found, then $\sigma_z = 0$ .

Definition at line 88 of file egs_gaussian_shape.h.

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

/home/rwtownson/EGSnrc/HEN_HOUSE/egs++/shapes/egs_gaussian_shape/egs_gaussian_shape.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description