A deformed XYZ-geometry. More...
#include <egs_nd_geometry.h>
Inheritance diagram for EGS_DeformedXYZ:
Public Member Functions | |
| EGS_DeformedXYZ (EGS_PlanesX *Xp, EGS_PlanesY *Yp, EGS_PlanesZ *Zp, const char *defFile, const string &Name="") | |
| int | isWhere (const EGS_Vector &x) |
| int | inside (const EGS_Vector &x) |
| int | medium (int ireg) const |
| int | howfar (int ireg, const EGS_Vector &x, const EGS_Vector &u, EGS_Float &t, int *newmed=0, EGS_Vector *normal=0) |
| EGS_Float | hownear (int ireg, const EGS_Vector &x) |
| int | computeIntersections (int ireg, int n, const EGS_Vector &X, const EGS_Vector &u, EGS_GeometryIntersections *isections) |
| EGS_Float | howfarToOutside (int ireg, const EGS_Vector &x, const EGS_Vector &u) |
| int | getMaxStep () const |
| const string & | getType () const |
| void | printInfo () const |
| int | setDeformations (const char *defFile) |
| bool | inTriangle (const EGS_Vector &n0, const EGS_Vector &n1, const EGS_Vector &n2, const EGS_Vector &x) |
 Public Member Functions inherited from EGS_XYZGeometry | |
| EGS_XYZGeometry (EGS_PlanesX *Xp, EGS_PlanesY *Yp, EGS_PlanesZ *Zp, const string &Name="") | |
| bool | isInside (const EGS_Vector &x) |
| EGS_Float | getVolume (int ireg) |
| EGS_Float | getBound (int idir, int ind) |
| int | getNRegDir (int idir) |
| int | getNx () const |
| int | getNy () const |
| int | getNz () const |
| EGS_Float * | getXPositions () |
| EGS_Float * | getYPositions () |
| EGS_Float * | getZPositions () |
| void | voxelizeGeometry (EGS_Input *input) |
| void | setXYZLabels (EGS_Input *input) |
| virtual void | getLabelRegions (const string &str, vector< int > ®s) |
| void | getXLabelRegions (const string &str, vector< int > ®s) |
| void | getYLabelRegions (const string &str, vector< int > ®s) |
| void | getZLabelRegions (const string &str, vector< int > ®s) |
| Public Member Functions inherited from EGS_BaseGeometry | |
| EGS_BaseGeometry (const string &Name) | |
| Construct a geometry named Name. More... | |
| virtual | ~EGS_BaseGeometry () |
| Destructor. More... | |
| bool | isConvex () const |
| Is the geometry convex? More... | |
| int | regions () const |
| Returns the number of local regions in this geometry. More... | |
| virtual bool | isRealRegion (int ireg) const |
| Returnes true if ireg is a real region, false otherwise. More... | |
| void | setMedium (const string &Name) |
| Set all regions to a medium with name Name. More... | |
| void | setMedium (int start, int end, const string &Name, int delta=1) |
| Set every delta'th region between start and end to the medium named Name. More... | |
| void | setMedium (int imed) |
| Set all regions to a medium with index imed. More... | |
| void | setMedium (int istart, int iend, int imed, int delta=1) |
| Set every delta'th region between start and end (inclusive) to imed. More... | |
| void | setMedia (EGS_Input *inp) |
| Set the media in the geometry from the input pointed to by inp. More... | |
| bool | hasRhoScaling () const |
| Does this geometry object have a mass density scaling feature? More... | |
| virtual EGS_Float | getRelativeRho (int ireg) const |
| Get the relative mass density in region ireg. More... | |
| virtual void | setRelativeRho (int start, int end, EGS_Float rho) |
| Set the relative mass density in regions. More... | |
| virtual void | setRelativeRho (EGS_Input *) |
| Set the relative mass density from an user input. More... | |
| EGS_Float | getMediumRho (int ind) const |
| virtual void | setApplication (EGS_Application *app) |
| bool | hasBScaling () const |
| Does this geometry object have a B field scaling feature? | |
| virtual EGS_Float | getBScaling (int ireg) const |
| Get the B field scaling factor in region ireg. | |
| virtual void | setBScaling (int start, int end, EGS_Float bf) |
| Set the B field scaling factor in regions. More... | |
| virtual void | setBScaling (EGS_Input *) |
| Set the B field scaling factor from an user input. More... | |
| const string & | getName () const |
| Get the name of this geometry. More... | |
| void | setDebug (bool deb) |
| Turn debugging on. More... | |
| void | setName (EGS_Input *inp) |
| Set the name of the geometry from the input inp. More... | |
| void | setBoundaryTolerance (EGS_Input *inp) |
| Set the value of the boundary tolerance from the input inp. More... | |
| void | setBoundaryTolerance (EGS_Float tol) |
| Set the value of the boundary tolerance from argument. | |
| virtual bool | hasBooleanProperty (int ireg, EGS_BPType prop) const |
| Is the boolean property prop set for region ireg ? | |
| virtual void | setBooleanProperty (EGS_BPType prop) |
| Set the boolean properties of the entire geometry to prop. More... | |
| virtual void | addBooleanProperty (int bit) |
| Add a boolean property for the entire geometry by setting the bit'th bit. More... | |
| virtual void | setBooleanProperty (EGS_BPType prop, int start, int end, int step=1) |
| Set the boolean properties of every step'th region between start and end (inclusive) to prop. More... | |
| virtual void | addBooleanProperty (int bit, int start, int end, int step=1) |
| Add a boolean property to every step'th region between start and end (inclusive) by setting the bit'th bit. More... | |
| int | ref () |
| Increase the reference count to this geometry. More... | |
| int | deref () |
| Decrease the reference count to this geometry. More... | |
| EGS_Float | getBoundaryTolerance () |
| Get the value of the boundary tolerance. | |
| virtual void | getNumberRegions (const string &str, vector< int > ®s) |
| Get a list of all the regions labeled with a number. | |
| virtual const string & | getLabelName (const int i) |
| Get the name of the i-th explicit label in the geometry. | |
| virtual int | getLabelCount () |
| Get the number of explicit labels in the geometry. | |
| int | setLabels (EGS_Input *input) |
| Set the labels from an input block. | |
| int | setLabels (const string &inp) |
| Set the labels from an input string. | |
Protected Attributes | |
| EGS_Vector * | vectors |
| int | tnodes [24] |
| int | np [3] |
| int | nxyp1 |
| Protected Attributes inherited from EGS_XYZGeometry | |
| EGS_PlanesX * | xp |
| EGS_PlanesY * | yp |
| EGS_PlanesZ * | zp |
| EGS_Float * | xpos |
| EGS_Float * | ypos |
| EGS_Float * | zpos |
| int | nx |
| int | ny |
| int | nz |
| int | nxy |
| Protected Attributes inherited from EGS_BaseGeometry | |
| int | nreg |
| Number of local regions in this geometry. More... | |
| string | name |
| Name of this geometry. More... | |
| short * | region_media |
| Array of media indeces. More... | |
| int | med |
| Medium index. More... | |
| bool | has_rho_scaling |
| Does this geometry have relative mass density scvaling? More... | |
| EGS_Float * | rhor |
| Array with relative mass densities. More... | |
| bool | has_B_scaling |
| Does this geometry has B field scaling factor? More... | |
| bool | has_Ref_rho |
| EGS_Float * | bfactor |
| Array with B field scaling factors. More... | |
| EGS_Float | rhoRef |
| Reference density for B field scaling. More... | |
| int | nref |
| Number of references to this geometry. More... | |
| bool | debug |
| Debugging flag. More... | |
| bool | is_convex |
| Is this geometry convex? More... | |
| EGS_BPType | bproperty |
| A bit mask of boolean properties for the entire geometry. More... | |
| EGS_BPType * | bp_array |
| An array of boolean properties on a region by region basis. More... | |
| EGS_Float | boundaryTolerance |
| Boundary tolerance for geometries that need it. | |
| EGS_Float | halfBoundaryTolerance |
| vector< label > | labels |
| Labels. More... | |
| EGS_Application * | app |
| The application this object belongs to. | |
Static Protected Attributes | |
| static string | def_type = "EGS_DeformedXYZ" |
| static char | tetrahedra [] |
| static char | plane_order [] = {0,1,2, 0,2,3, 0,3,1, 1,3,2} |
| static char | tetra_data [] |
| static char | enter_tetra1 [] = {0, 3, 4, 0, 0, 2} |
| static char | enter_plane1 [] = {1, 1, 1, 3, 0, 3} |
| static char | enter_tetra2 [] = {2, 5, 5, 1, 3, 5} |
| static char | enter_plane2 [] = {0, 0, 2, 3, 2, 2} |
| Static Protected Attributes inherited from EGS_XYZGeometry | |
| static string | type = "EGS_XYZGeometry" |
| Static Protected Attributes inherited from EGS_BaseGeometry | |
| static int | error_flag = 0 |
| Set to non-zero status if a geometry problem is encountered. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from EGS_XYZGeometry | |
| static int | getDigits (int i) |
| static EGS_XYZGeometry * | constructGeometry (const char *dens_or_egphant_file, const char *ramp_file, int dens_or_egphant=0) |
| static EGS_XYZGeometry * | constructCTGeometry (const char *dens_or_egphant_file) |
| Static Public Member Functions inherited from EGS_BaseGeometry | |
| static int | findRegion (EGS_Float xp, int np, const EGS_Float *p) |
| Find the bin to which xp belongs, given np bin edges p. More... | |
| static int | nMedia () |
| Get the number of media registered so far by all geometries. More... | |
| static const char * | getMediumName (int ind) |
| Get the name of medium with index ind. More... | |
| static int | addMedium (const string &medname) |
| Add a medium or get the index of an existing medium. More... | |
| static int | getMediumIndex (const string &medname) |
| Get the index of a medium named medname. More... | |
| static EGS_BaseGeometry * | createGeometry (EGS_Input *) |
| Create a geometry (or geometries) from a given input. More... | |
| static EGS_BaseGeometry * | createSingleGeometry (EGS_Input *inp) |
| Create a single geometry from the input inp. More... | |
| static void | clearGeometries () |
| Clears (deletes) all geometries in the currently active geometry list. More... | |
| static EGS_BaseGeometry * | getGeometry (const string &Name) |
| Get a pointer to the geometry named Name. More... | |
| static EGS_BaseGeometry ** | getGeometries () |
| static int | getNGeometries () |
| static string | getUniqueName () |
| Get a unique geometry name. More... | |
| static void | describeGeometries () |
| Describes all existing geometries. More... | |
| static void | setActiveGeometryList (int list) |
| Set the currently active geometry list. More... | |
| static int | getLastError () |
| static void | resetErrorFlag () |
| Protected Member Functions inherited from EGS_XYZGeometry | |
| void | setup () |
| void | setMedia (EGS_Input *inp, int nmed, const int *med_ind) |
| int | howfarFromOut (const EGS_Vector &x, const EGS_Vector &u, EGS_Float &t, int &ix, int &iy, int &iz, int &face, EGS_Vector *normal=0) |
Detailed Description
A deformed XYZ-geometry.
This class modelas a XYZ geometry where the voxel corners are transformed to new locations according to a user defined deformation field. This implementation divides each voxel into 6 tetrahedra, which makes howfar() and hownear() computations much easier. The downside of this approach is that the number of regions increases by a factor of 6.
Note: this geometry is not usable yet because there is no way to define it in the input file.
Definition at line 1367 of file egs_nd_geometry.h.
Member Function Documentation
| int EGS_DeformedXYZ::setDeformations | ( | const char * | defFile | ) |
Set deformations contained in the file defFile. defFile must be a binary file containing
- number Nv of vectors (32 bit integer)
- 3*Nv 32 bit floating point numbers defining the Nv deformation vectors. Note that the number of deformation vectors must be consistent with the number of voxels in the underlying XYZ geometry. The deformation for the corner of voxel (ix,iy,iz) is at localtion ix + iy*(Nx+1) + iz*(Nx+1)*(Ny+1) where Nx,Ny,Nz are the number of voxels.
Definition at line 828 of file egs_nd_geometry.cpp.
References egsWarning, and EGS_BaseGeometry::nreg.
Member Data Documentation
|
staticprotected |
Initial value:
= {0,2,3,6, 0,6,3,7, 0,4,6,7,
7,0,1,3, 7,1,0,4, 7,5,1,4
}
Definition at line 1613 of file egs_nd_geometry.h.
The documentation for this class was generated from the following files:
- /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_nd_geometry/egs_nd_geometry.h
- /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_nd_geometry/egs_nd_geometry.cpp
