.. _api_doc:

=================
API documentation
=================

Classes
-------

Model Refiner
=============
.. This won't work because PyPrismatic isn't dependency
   This of course needs to be fixed, but the fix is to
   overhaul the Model Refiner class
.. autoclass:: temul.model_refiner.Model_Refiner
    :members:
    :undoc-members:


Modules
-------

TopoTEM (Polarisation)
======================
.. automodule:: temul.topotem.polarisation
    :members:
    :undoc-members:

.. automodule:: temul.topotem.fft_mapping
    :members:
    :undoc-members:

.. automodule:: temul.topotem.lattice_structure_tools
    :members:
    :undoc-members:

Element Tools
=============
.. automodule:: temul.element_tools
    :members:
    :undoc-members:

Intensity Tools
===============
.. automodule:: temul.intensity_tools
    :members:
    :undoc-members:

Model Creation
==============
.. automodule:: temul.model_creation
    :members:
    :undoc-members:

Image Simulation Functions
==========================
.. automodule:: temul.simulations
    :members:
    :undoc-members:

Signal Processing
=================
.. automodule:: temul.signal_processing
    :members:
    :undoc-members:

Signal Plotting
===============
.. automodule:: temul.signal_plotting
    :members:
    :undoc-members:

Input/Output (io)
=================
.. automodule:: temul.io
    :members:
    :undoc-members:

Dummy Data
==========
.. automodule:: temul.dummy_data
    :members:
    :undoc-members:

Example Data
============
.. automodule:: temul.example_data
    :members:
    :undoc-members: