*****************
Modules & Classes
*****************

.. _aggregate-module:

===========================
The :mod:`aggregate` Module
===========================

.. automodule:: aggregate

----------------------------
The :class:`Aggregate` Class
----------------------------

.. autoclass:: aggregate.Aggregate
  :members:
  :private-members:
  :show-inheritance:

.. autofunction:: aggregate.main

.. _compare-module:

=========================
The :mod:`compare` Module
=========================

.. automodule:: compare
  :private-members:
  :special-members:
  :show-inheritance:

--------------------------
The :class:`Metrics` Class
--------------------------

.. autoclass:: compare.Metrics
  :members:
  :private-members:
  :show-inheritance:

.. _correlate-module:

===========================
The :mod:`correlate` Module
===========================

.. automodule:: correlate
  :members:
  :private-members:
  :show-inheritance:

.. _database-module:

==========================
The :mod:`database` Module
==========================

.. automodule:: database

---------------------------
The :class:`Database` Class
---------------------------

.. autoclass:: database.Database
  :members:
  :private-members:
  :show-inheritance:

.. _new-module:

=====================
The :mod:`new` Module
=====================

.. automodule:: new
  :members:
  :private-members:
  :show-inheritance:

.. _operations-module:

============================
The :mod:`operations` Module
============================

.. automodule:: operations

-----------------------------
The :class:`Operations` Class
-----------------------------

.. autoclass:: operations.Operations
  :members:
  :private-members:
  :show-inheritance:

-------------------------
The :class:`Images` Class
-------------------------

.. autoclass:: operations.Images
  :members:
  :private-members:
  :show-inheritance:

-------------------------------
The :class:`Downsamplers` Class
-------------------------------

.. autoclass:: operations.Downsamplers
  :members:
  :private-members:
  :show-inheritance:

-------------------------
The :class:`Ratios` Class
-------------------------

.. autoclass:: operations.Ratios
  :members:
  :private-members:
  :show-inheritance:

-----------------------------
The :class:`Upsamplers` Class
-----------------------------

.. autoclass:: operations.Upsamplers
  :members:
  :private-members:
  :show-inheritance:

.. _parsing-module:

=========================
The :mod:`parsing` Module
=========================

.. automodule:: parsing

.. autofunction:: parsing._format_doc
.. autofunction:: parsing._remove_duplicates

---------------------------------
The :class:`ExquiresParser` Class
---------------------------------

.. autoclass:: parsing.ExquiresParser
  :members:
  :private-members:
  :show-inheritance:

-----------------------------------
The :class:`OperationsParser` Class
-----------------------------------

.. autoclass:: parsing.OperationsParser
  :members:
  :private-members:
  :show-inheritance:

------------------------------
The :class:`StatsParser` Class
------------------------------

.. autoclass:: parsing.StatsParser
  :members:
  :private-members:
  :show-inheritance:

-------------------------------
The :class:`ExquiresHelp` Class
-------------------------------

.. autoclass:: parsing.ExquiresHelp
  :members:
  :private-members:
  :special-members:
  :show-inheritance:

--------------------------------
The :class:`ProjectAction` Class
--------------------------------

.. autoclass:: parsing.ProjectAction
  :members:
  :private-members:
  :special-members:
  :show-inheritance:

-----------------------------
The :class:`ListAction` Class
-----------------------------

.. autoclass:: parsing.ListAction
  :members:
  :private-members:
  :special-members:
  :show-inheritance:

------------------------------
The :class:`RatioAction` Class
------------------------------

.. autoclass:: parsing.RatioAction
  :members:
  :private-members:
  :special-members:
  :show-inheritance:

-------------------------------
The :class:`AnchorAction` Class
-------------------------------

.. autoclass:: parsing.AnchorAction
  :members:
  :private-members:
  :special-members:
  :show-inheritance:

-----------------------------
The :class:`SortAction` Class
-----------------------------

.. autoclass:: parsing.SortAction
  :members:
  :private-members:
  :special-members:
  :show-inheritance:

.. _progress-module:

==========================
The :mod:`progress` Module
==========================

.. automodule:: progress

---------------------------
The :class:`Progress` Class
---------------------------

.. autoclass:: progress.Progress
  :members:
  :private-members:
  :show-inheritance:

.. _report-module:

========================
The :mod:`report` Module
========================

.. automodule:: report
  :members:
  :private-members:
  :show-inheritance:

.. _run-module:

=====================
The :mod:`run` Module
=====================

.. automodule:: run
  :members:
  :private-members:
  :show-inheritance:

.. _stats-module:

=======================
The :mod:`stats` Module
=======================

.. automodule:: stats
  :members:
  :private-members:
  :show-inheritance:

.. _tools-module:

=======================
The :mod:`tools` Module
=======================

.. automodule:: tools
  :members:
  :private-members:
  :show-inheritance:

.. _update-module:

========================
The :mod:`update` Module
========================

.. automodule:: update
  :members:
  :private-members:
  :show-inheritance:
