Factor module and class documentation
=====================================

The primary Factor modules that are used to set up and run the pipeline are documented here.

factor.process
--------------

.. automodule:: factor.process
    :members:
    :undoc-members:
    :show-inheritance:
    :private-members:

factor.cluster
--------------

.. automodule:: factor.cluster
    :members:
    :undoc-members:
    :show-inheritance:

factor.directions
-----------------

.. automodule:: factor.directions
    :members:
    :undoc-members:
    :show-inheritance:

factor.parset
-------------

.. automodule:: factor.parset
    :members:
    :undoc-members:
    :show-inheritance:


Classes
-------

.. autoclass:: factor.lib.band.Band
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: factor.lib.direction.Direction
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: factor.lib.operation.Operation
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: factor.lib.scheduler.Scheduler
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: factor.lib.polygon.Polygon
    :members:
    :undoc-members:
    :show-inheritance: