..  _api:

API
===

The oimodeler library contains the following modules:

+--------------------------------------+----------------------------------------------+
|  Module                              | Description                                  |
+======================================+==============================================+
| :ref:`oimParam`                      | Model parameters and parameter interpolators |
+--------------------------------------+----------------------------------------------+
| :ref:`oimModel`                      | Main class for model creation                |
+--------------------------------------+----------------------------------------------+
| :ref:`oimComponent`                  | Base classes for all model components        |
+--------------------------------------+----------------------------------------------+
| :ref:`oimBasicFourierComponents`     | Basic components defined in the Fourier plan |
+--------------------------------------+----------------------------------------------+
| :ref:`oimCustomComponents`           | Custom components added by the community     |
+--------------------------------------+----------------------------------------------+
| :ref:`oimFTBackends`                 | Backends for Fast Fourier Transform          |
+--------------------------------------+----------------------------------------------+
| :ref:`oimData`                       | Main class for manipulating oifits data      |
+--------------------------------------+----------------------------------------------+
| :ref:`oimFluxData`                   | Photometric and spectrascopic data wrappers  |
+--------------------------------------+----------------------------------------------+
| :ref:`oimDataFilter`                 | Data filtering and modifying                 |
+--------------------------------------+----------------------------------------------+
| :ref:`oimSimulator`                  | Data/Model simulation  and comparison        |
+--------------------------------------+----------------------------------------------+
| :ref:`oimFitter`                     | Classes for Model fitting                    |
+--------------------------------------+----------------------------------------------+
| :ref:`oimPlots`                      | Plotting functions and classes               |
+--------------------------------------+----------------------------------------------+
| :ref:`oimUtils`                      | Various utilities for optical interferometry |
+--------------------------------------+----------------------------------------------+
| :ref:`oimOptions`                    | Global options of the oimodeler software     |
+--------------------------------------+----------------------------------------------+

.. toctree::
   :hidden:
   
   oimParam
   oimModel
   oimComponent
   oimBasicFourierComponents
   oimCustomComponents
   oimFTBackends
   oimData
   oimFluxData
   oimDataFilter
   oimSimulator
   oimFitter
   oimPlots
   oimUtils
   oimOptions