.. _api:

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

Classes
-------

Atom lattice
============
.. autoclass:: atomap.atom_lattice.Atom_Lattice
    :members:
    :undoc-members:

Dumbbell lattice
============
.. autoclass:: atomap.atom_lattice.Dumbbell_Lattice
    :members:
    :undoc-members:

Sublattice
===========
.. autoclass:: atomap.sublattice.Sublattice
    :members:
    :undoc-members:

Atom plane
==========
.. autoclass:: atomap.atom_plane.Atom_Plane
    :members:
    :undoc-members:

Atom position
=============
.. autoclass:: atomap.atom_position.Atom_Position
    :members:
    :undoc-members:

Process parameters
==================
.. autoclass:: atomap.process_parameters.ModelParametersBase
    :members:
    :undoc-members:

.. autoclass:: atomap.process_parameters.GenericStructure
    :members:
    :undoc-members:

.. autoclass:: atomap.process_parameters.PerovskiteOxide110
    :members:
    :undoc-members:

.. autoclass:: atomap.process_parameters.SrTiO3_110
    :members:
    :undoc-members:

.. autoclass:: atomap.process_parameters.SublatticeParameterBase
    :members:
    :undoc-members:

.. autoclass:: atomap.process_parameters.GenericSublattice
    :members:
    :undoc-members:

.. autoclass:: atomap.process_parameters.PerovskiteOxide110SublatticeACation
    :members:
    :undoc-members:

.. autoclass:: atomap.process_parameters.PerovskiteOxide110SublatticeBCation
    :members:
    :undoc-members:

.. autoclass:: atomap.process_parameters.PerovskiteOxide110SublatticeOxygen
    :members:
    :undoc-members:

Modules
-------

Atom finding refining
=====================
.. automodule:: atomap.atom_finding_refining
    :members:
    :undoc-members:

Analysis tools
==============
.. automodule:: atomap.analysis_tools
    :members:
    :undoc-members:

Quantification
==============
.. automodule:: atomap.quantification
    :members:
    :undoc-members:

Initial position finding
========================
.. automodule:: atomap.initial_position_finding
    :members:
    :undoc-members:

Input output (IO)
=================
.. automodule:: atomap.io
    :members:
    :undoc-members:

Main
====
.. automodule:: atomap.main
    :members:
    :undoc-members:

Plotting
========
.. automodule:: atomap.plotting
    :members:
    :undoc-members:

Tools
=====
.. automodule:: atomap.tools
    :members:
    :undoc-members:

.. _dummy_data_module:

Dummy data
==========
.. automodule:: atomap.dummy_data
    :members:
    :undoc-members: