API reference
=============

Top-level API
-------------

.. autofunction:: radialpaths.build_geometry

.. autofunction:: radialpaths.radial_profile

Image preparation
-----------------

.. automodule:: radialpaths.preprocessing
   :members:
   :undoc-members:
   :show-inheritance:

Result objects
--------------

.. autoclass:: radialpaths.RadialGeometry
   :members:

.. autoclass:: radialpaths.RadialProfile
   :members:

.. autoclass:: radialpaths.CentreProfile
   :members:

Synthetic examples
------------------

.. automodule:: radialpaths.synthetic
   :members:

Plotting
--------

.. automodule:: radialpaths.plotting
   :members:

I/O
---

.. automodule:: radialpaths.io
   :members: