3.10.1.11.1.2. opengate.geometry.solids

3.10.1.11.1.2.1. Attributes

logger

3.10.1.11.1.2.2. Classes

SolidBase

This is the base class used for all objects that handle user input in GATE.

BooleanSolid

This is the base class used for all objects that handle user input in GATE.

BoxSolid

This is the base class used for all objects that handle user input in GATE.

HexagonSolid

This is the special case of a six-sided polyhedron.

ConsSolid

Cone section.

PolyhedraSolid

https://geant4-userdoc.web.cern.ch/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html

SphereSolid

This is the base class used for all objects that handle user input in GATE.

TrapSolid

http://geant4-userdoc.web.cern.ch/geant4-userdoc/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html

TrdSolid

https://geant4-userdoc.web.cern.ch/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html?highlight=g4trd

TubsSolid

http://geant4-userdoc.web.cern.ch/geant4-userdoc/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html

TesselatedSolid

https://geant4-userdoc.web.cern.ch/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html?highlight=tesselated#tessellated-solids

ImageSolid

Utility to handle the solids of an ImageVolume.

3.10.1.11.1.2.3. Module Contents

opengate.geometry.solids.logger[source]
class opengate.geometry.solids.SolidBase(*args, **kwargs)[source]

Bases: opengate.base.GateObject

This is the base class used for all objects that handle user input in GATE.

The class is assumed to be processed by process_cls(), either explicitly or via the metaclass MetaUserInfo, before any instances of the class are created. Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.

g4_solid = None[source]
close()[source]

Dummy implementation for inherited classes which do not implement this method.

release_g4_references()[source]

Dummy implementation for inherited classes which do not implement this method.

__getstate__()[source]

Method needed for pickling. May be overridden in inheriting classes.

property solid_info[source]

Computes the properties of the solid associated with this volume.

property bounding_limits[source]

Return the min and max 3D points of the bounding box of the given volume

property bounding_box_size[source]

Return the size of the bounding box of the given volume

construct_solid()[source]

Attempts to build the solid according the build_solid() method either coming from a Solid mother class or implemented in a specific derived class.

class opengate.geometry.solids.BooleanSolid(*args, **kwargs)[source]

Bases: SolidBase

This is the base class used for all objects that handle user input in GATE.

The class is assumed to be processed by process_cls(), either explicitly or via the metaclass MetaUserInfo, before any instances of the class are created. Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.

constructor_functions[source]
user_info_defaults[source]
build_solid()[source]

Overrides the method from the base class. It constructs the solid according to the logic of the G4 boolean volumes.

from_dictionary(d)[source]
class opengate.geometry.solids.BoxSolid(*args, **kwargs)[source]

Bases: SolidBase

This is the base class used for all objects that handle user input in GATE.

The class is assumed to be processed by process_cls(), either explicitly or via the metaclass MetaUserInfo, before any instances of the class are created. Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.

user_info_defaults[source]
build_solid()[source]
class opengate.geometry.solids.HexagonSolid(*args, **kwargs)[source]

Bases: SolidBase

This is the special case of a six-sided polyhedron. https://geant4-userdoc.web.cern.ch/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html

user_info_defaults[source]
build_solid()[source]
class opengate.geometry.solids.ConsSolid(*args, **kwargs)[source]

Bases: SolidBase

Cone section. http://geant4-userdoc.web.cern.ch/geant4-userdoc/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html

user_info_defaults[source]
build_solid()[source]
class opengate.geometry.solids.PolyhedraSolid(*args, **kwargs)[source]

Bases: SolidBase

https://geant4-userdoc.web.cern.ch/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html

user_info_defaults[source]
build_solid()[source]
class opengate.geometry.solids.SphereSolid(*args, **kwargs)[source]

Bases: SolidBase

This is the base class used for all objects that handle user input in GATE.

The class is assumed to be processed by process_cls(), either explicitly or via the metaclass MetaUserInfo, before any instances of the class are created. Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.

user_info_defaults[source]
build_solid()[source]
class opengate.geometry.solids.TrapSolid(*args, **kwargs)[source]

Bases: SolidBase

http://geant4-userdoc.web.cern.ch/geant4-userdoc/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html

user_info_defaults[source]
build_solid()[source]
class opengate.geometry.solids.TrdSolid(*args, **kwargs)[source]

Bases: SolidBase

https://geant4-userdoc.web.cern.ch/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html?highlight=g4trd

dx1 Half-length along X at the surface positioned at -dz dx2 Half-length along X at the surface positioned at +dz dy1 Half-length along Y at the surface positioned at -dz dy2 Half-length along Y at the surface positioned at +dz zdz Half-length along Z axis

user_info_defaults[source]
build_solid()[source]
class opengate.geometry.solids.TubsSolid(*args, **kwargs)[source]

Bases: SolidBase

http://geant4-userdoc.web.cern.ch/geant4-userdoc/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html

user_info_defaults[source]
build_solid()[source]
class opengate.geometry.solids.TesselatedSolid(*args, **kwargs)[source]

Bases: SolidBase

https://geant4-userdoc.web.cern.ch/UsersGuides/ForApplicationDeveloper/html/Detector/Geometry/geomSolids.html?highlight=tesselated#tessellated-solids

user_info_defaults[source]
close()[source]

Dummy implementation for inherited classes which do not implement this method.

read_file()[source]
translate_mesh_to_center(mesh_to_translate)[source]
build_solid()[source]
class opengate.geometry.solids.ImageSolid(*args, **kwargs)[source]

Bases: SolidBase

Utility to handle the solids of an ImageVolume. It is not intended to be used stand-alone, but only as a base class of ImageVolume.

half_size_mm = None[source]
half_spacing = None[source]
g4_solid_x = None[source]
g4_solid_y = None[source]
g4_solid_z = None[source]
__getstate__()[source]

Method needed for pickling. May be overridden in inheriting classes.

close()[source]

Dummy implementation for inherited classes which do not implement this method.

release_g4_references()[source]

Dummy implementation for inherited classes which do not implement this method.

construct_solid()[source]

Attempts to build the solid according the build_solid() method either coming from a Solid mother class or implemented in a specific derived class.