opengate.geometry.solids
========================

.. py:module:: opengate.geometry.solids


Attributes
----------

.. autoapisummary::

   opengate.geometry.solids.logger


Classes
-------

.. autoapisummary::

   opengate.geometry.solids.SolidBase
   opengate.geometry.solids.BooleanSolid
   opengate.geometry.solids.BoxSolid
   opengate.geometry.solids.HexagonSolid
   opengate.geometry.solids.ConsSolid
   opengate.geometry.solids.PolyhedraSolid
   opengate.geometry.solids.SphereSolid
   opengate.geometry.solids.TrapSolid
   opengate.geometry.solids.TrdSolid
   opengate.geometry.solids.TubsSolid
   opengate.geometry.solids.TesselatedSolid
   opengate.geometry.solids.ImageSolid


Module Contents
---------------

.. py:data:: logger

.. py:class:: SolidBase(*args, **kwargs)

   Bases: :py:obj:`opengate.base.GateObject`


   .. py:attribute:: g4_solid
      :value: None



   .. py:method:: close()


   .. py:method:: release_g4_references()


   .. py:method:: __getstate__()


   .. py:property:: solid_info

      Computes the properties of the solid associated with this volume.



   .. py:property:: bounding_limits

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



   .. py:property:: bounding_box_size

      Return the size of the bounding box of the given volume



   .. py:method:: construct_solid()

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



.. py:class:: BooleanSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


   .. py:attribute:: constructor_functions


   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()

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



   .. py:method:: from_dictionary(d)


.. py:class:: BoxSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()


.. py:class:: HexagonSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


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



   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()


.. py:class:: ConsSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


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



   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()


.. py:class:: PolyhedraSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


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



   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()


.. py:class:: SphereSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()


.. py:class:: TrapSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


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



   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()


.. py:class:: TrdSolid(*args, **kwargs)

   Bases: :py:obj:`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



   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()


.. py:class:: TubsSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


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



   .. py:attribute:: user_info_defaults


   .. py:method:: build_solid()


.. py:class:: TesselatedSolid(*args, **kwargs)

   Bases: :py:obj:`SolidBase`


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


   .. py:attribute:: user_info_defaults


   .. py:attribute:: g4_solid
      :value: None



   .. py:attribute:: facetArray
      :value: None



   .. py:attribute:: tessellated_solid
      :value: None



   .. py:method:: read_file()


   .. py:method:: translate_mesh_to_center(mesh_to_translate)


   .. py:method:: build_solid()


.. py:class:: ImageSolid(*args, **kwargs)

   Bases: :py:obj:`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.


   .. py:attribute:: half_size_mm
      :value: None



   .. py:attribute:: half_spacing
      :value: None



   .. py:attribute:: g4_solid_x
      :value: None



   .. py:attribute:: g4_solid_y
      :value: None



   .. py:attribute:: g4_solid_z
      :value: None



   .. py:method:: __getstate__()


   .. py:method:: close()


   .. py:method:: release_g4_references()


   .. py:method:: construct_solid()

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