===============
Module Contents
===============

This documentation is automatically generated by scanning all the source code. Parts
may be incomplete.

Defines and variables
---------------------

.. automodule:: pyg4ometry.gdml.Defines
   :members: upgradeToStringExpression, sin, cos, tan, asin, acos, atan, exp, log, log10, sqrt, upgradeToVector, upgradeToTransformation

.. autoclass:: pyg4ometry.gdml.Defines.ScalarBase
   :members: 
   :undoc-members:
   :show-inheritance:
   :special-members: __add__, __sub__, __rsub__, __mul__, __div__, __rdiv__, __neg__

.. autoclass:: pyg4ometry.gdml.Defines.Constant
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.gdml.Defines.Quantity
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.gdml.Defines.Variable
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.gdml.Defines.Expression
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.gdml.Defines
   :members: sin, cos, tan, asin, acos, atan, exp, log, log10, sqrt

.. autoclass:: pyg4ometry.gdml.Defines.VectorBase
   :members: 
   :undoc-members:
   :show-inheritance:
   :special-members: __add__, __sub__, __mul__, __rmul__, __div__ 

.. autoclass:: pyg4ometry.gdml.Position
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.gdml.Rotation
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.gdml.Scale
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.gdml.Matrix
   :members:
   :undoc-members:
   :show-inheritance:

.. autofunction:: pyg4ometry.gdml.MatrixFromVectors

.. _all-solids:

Geant4 solids
-------------
.. automodule:: pyg4ometry.geant4.solid.Plane
   :members:
.. automodule:: pyg4ometry.geant4.solid.Wedge
   :members:
.. automodule:: pyg4ometry.geant4.solid.Box
   :members:
.. automodule:: pyg4ometry.geant4.solid.Tubs
   :members:
.. automodule:: pyg4ometry.geant4.solid.CutTubs
   :members:
.. automodule:: pyg4ometry.geant4.solid.Cons
   :members:
.. automodule:: pyg4ometry.geant4.solid.Para
   :members:
.. automodule:: pyg4ometry.geant4.solid.Trd
   :members:
.. automodule:: pyg4ometry.geant4.solid.Trap
   :members:
.. automodule:: pyg4ometry.geant4.solid.Sphere
   :members:
.. automodule:: pyg4ometry.geant4.solid.Orb
   :members:
.. automodule:: pyg4ometry.geant4.solid.Torus
   :members:
.. automodule:: pyg4ometry.geant4.solid.Polycone
   :members:
.. automodule:: pyg4ometry.geant4.solid.GenericPolycone
   :members:
.. automodule:: pyg4ometry.geant4.solid.GenericPolyhedra
   :members:
.. automodule:: pyg4ometry.geant4.solid.Polyhedra
   :members:
.. automodule:: pyg4ometry.geant4.solid.EllipticalCone
   :members:
.. automodule:: pyg4ometry.geant4.solid.EllipticalTube
   :members:
.. automodule:: pyg4ometry.geant4.solid.Ellipsoid
   :members:
.. automodule:: pyg4ometry.geant4.solid.Paraboloid
   :members:
.. automodule:: pyg4ometry.geant4.solid.Hype
   :members:
.. automodule:: pyg4ometry.geant4.solid.Tet
   :members:
.. automodule:: pyg4ometry.geant4.solid.ExtrudedSolid
   :members:
.. automodule:: pyg4ometry.geant4.solid.TwistedBox
   :members:
.. automodule:: pyg4ometry.geant4.solid.TwistedTrap
   :members:
.. automodule:: pyg4ometry.geant4.solid.TwistedTrd
   :members:
.. automodule:: pyg4ometry.geant4.solid.TwistedTubs
   :members:
.. automodule:: pyg4ometry.geant4.solid.GenericTrap 
   :members: 
.. automodule:: pyg4ometry.geant4.solid.TessellatedSolid
   :members:
.. automodule:: pyg4ometry.geant4.solid.Union
   :members:
.. automodule:: pyg4ometry.geant4.solid.MultiUnion
   :members:
.. automodule:: pyg4ometry.geant4.solid.Intersection
   :members:
.. automodule:: pyg4ometry.geant4.solid.Subtraction
   :members:
.. automodule:: pyg4ometry.geant4.solid.OpticalSurface
   :members:

.. _g4-module:
      
Geant4 module
-------------
.. autoclass:: pyg4ometry.geant4.Registry
   :members: addDefine, addMaterial, addSolid, addLogicalVolume, addPhysicalVolume
   :undoc-members:
   :show-inheritance:
.. autofunction:: pyg4ometry.geant4.AnalyseGeometryComplexity

.. autoclass:: pyg4ometry.geant4.Material
   :members:
   :undoc-members:
   :show-inheritance:
.. automodule:: pyg4ometry.geant4.LogicalVolume
   :members:
   :undoc-members:
   :show-inheritance:
.. automodule:: pyg4ometry.geant4.PhysicalVolume
   :members:
   :undoc-members:
   :show-inheritance:
.. automodule:: pyg4ometry.geant4.ReplicaVolume
   :members:
   :undoc-members:
   :show-inheritance:
.. automodule:: pyg4ometry.geant4.ParameterisedVolume
   :members:
   :undoc-members:
   :show-inheritance:
.. automodule:: pyg4ometry.geant4.BorderSurface
   :members:
   :undoc-members:
   :show-inheritance:
.. automodule:: pyg4ometry.geant4.SkinSurface
   :members:
   :undoc-members:
   :show-inheritance:

.. _module-docs-visualisation:
      
Visualisation module
--------------------

.. automodule:: pyg4ometry.visualisation.VtkViewer
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.visualisation.ViewerBase
   :members:
   :undoc-members:
   :show-inheritance:

STL module
----------

.. automodule:: pyg4ometry.stl.Reader
   :members:
   :undoc-members:
   :show-inheritance:

GDML module 
-----------
.. automodule:: pyg4ometry.gdml.Reader
   :members:
   :undoc-members:
   :show-inheritance:
.. automodule:: pyg4ometry.gdml.Writer
   :members:
   :undoc-members:
   :show-inheritance:


CGAL module
-----------

.. automodule:: pyg4ometry.pycgal.Aff_transformation_3
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.CGAL
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.core
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.geom
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.Nef_polyhedron_3
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.Point_2
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.Point_3
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.Polygon_2
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.Polygon_mesh_processing
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.Polyhedron_3
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.Surface_mesh
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pycgal.Vector_3
   :members:
   :undoc-members:
   :show-inheritance:

OpenCascade module
------------------

.. automodule:: pyg4ometry.pyoce.pythonHelpers
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.BRep
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.BRepMesh
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.Geom
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.gp
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.Message
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.Poly
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.Reader
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.STEPCAFControl
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.StlAPI
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TCollection
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TDataStd
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TDF
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TDocStd
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TKernel
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TNaming
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TopAbs
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TopExp
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TopLoc
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.TopoDS
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.XCAFApp
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.pyoce.XCAFDoc
   :members:
   :undoc-members:
   :show-inheritance:

Fluka bodies
------------
.. automodule:: pyg4ometry.fluka.body
   :members:
   :private-members:
   :undoc-members:
   :show-inheritance:

Fluka module
------------

.. automodule:: pyg4ometry.fluka.card
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.directive
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.flair
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.fluka_registry
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.lattice
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.material
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.preprocessor
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.reader
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.region
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.vector
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.vis
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.fluka.Writer
   :members:
   :undoc-members:
   :show-inheritance:

IO Module
---------

.. automodule:: pyg4ometry.io.ROOTTGeo
   :members:
   :undoc-members:
   :show-inheritance:

.. _transformation-module:

Transformation
--------------

.. automodule:: pyg4ometry.transformation
   :members:
   :undoc-members:

Misc
--------------

.. automodule:: pyg4ometry.misc.NestedSolids
   :members:
   :undoc-members:


Convert
-------

.. automodule:: pyg4ometry.convert.fluka2g4materials
   :members:
   :undoc-members:

.. automodule:: pyg4ometry.convert.fluka2Geant4
   :members:
   :undoc-members:

.. automodule:: pyg4ometry.convert.freecad2Fluka
   :members:
   :undoc-members:

.. automodule:: pyg4ometry.convert.geant42Fluka
   :members:
   :undoc-members:

.. automodule:: pyg4ometry.convert.geant42Geant4
   :members:
   :undoc-members:

.. automodule:: pyg4ometry.convert.stl2gdml
   :members:
   :undoc-members:

.. automodule:: pyg4ometry.convert.oce2Geant4
   :members:
   :undoc-members:


.. _geometry-compare-module:
      
Compare
-------

.. autoclass:: pyg4ometry.compare.ComparisonResult
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.compare.Tests
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.compare.TestResult
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: pyg4ometry.compare.TestResultNamed
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: pyg4ometry.compare._Compare
   :members:
   :undoc-members:

Features
--------

.. automodule:: pyg4ometry.features.algos
   :members:
   :undoc-members: