tomography/xdesign

View on GitHub
docs/source/api/xdesign.geometry.rst

Summary

Maintainability
Test Coverage
:mod:`xdesign.geometry`
=======================

.. automodule:: xdesign.geometry
    :members:
    :show-inheritance:
    :inherited-members:


Zero dimensional entities
-------------------------

.. automodule:: xdesign.geometry.point
  :members:
  :show-inheritance:
  :undoc-members:

  .. rubric:: **Classes:**

  .. autosummary::

    Point


One dimensional entities
------------------------

.. automodule:: xdesign.geometry.line
  :members:
  :show-inheritance:
  :undoc-members:

  .. rubric:: **Classes:**

  .. autosummary::

    Line
    Segment


Two dimensional entities
-------------------------

.. automodule:: xdesign.geometry.area
  :members:
  :show-inheritance:
  :undoc-members:

  .. rubric:: **Classes:**

  .. autosummary::

      Curve
      Circle
      Polygon
      RegularPolygon
      Triangle
      Rectangle
      Square
      Mesh


Intersect
---------

.. automodule:: xdesign.geometry.intersect
  :members:
  :show-inheritance:
  :undoc-members:

  .. rubric:: **Functions:**

  .. autosummary::

    clip_SH
    halfspacecirc