Code Documentation
==================

.. automodule:: trvtool

Main Driver
-----------
.. autofunction:: start_trv_GUI

Classes
-------

basic tensor class
^^^^^^^^^^^^^^^^^^
.. autoclass:: SumSeparableTensor
   :members:

to hold the state of the visualization
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: StateHolder
   :members:

.. autoclass:: StateHolder_complex
   :members:

GUI windows and frames
^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: TrimFrame
   :members:

.. autoclass:: LineFrame
   :members:

.. autoclass:: ALSFrame
   :members:

.. autoclass:: PostScriptFrame
   :members:

.. autoclass:: state_display_dialog
   :members:

.. autoclass:: trv_visual_gui
   :members:

.. autoclass:: new_random_dialog
   :members:

.. autoclass:: new_manual_dialog
   :members:

.. autoclass:: new_manual_dialog_complex
   :members:

.. autoclass:: trv_start_frame
   :members:

Functions
---------

.. autofunction:: assigncolor

.. autofunction:: sortTuples

.. autofunction:: makeEPSplot

.. autofunction:: makeRandomSSTensor

.. autofunction:: makeNearbySSTensor

.. autofunction:: makeLineofSSTensors

.. autofunction:: makeGrammMatrix

.. autofunction:: makeRHSVector

.. autofunction:: findMainGeometry

.. autofunction:: SSTensor_to_xyangle

.. autofunction:: SSTensor_to_xyangle_complex

.. autofunction:: xy_to_SSTensor

.. autofunction:: xy_to_SSTensor_complex

.. autofunction:: iscovered

.. autofunction:: trimcovered

.. autofunction:: trimcovered_recursive

.. autofunction:: Fit_SSTensor

.. autofunction:: Fit_SSTensor_growing

.. autofunction:: xytgrid_ALS

.. autofunction:: xytgrid_ALS_complex

Test Routines
-------------

These routines should be called using the 
`nosetests package <http://somethingaboutorange.com/mrl/projects/nose/>`_ 
with::

   nosetests trvtool.py 

.. autofunction:: test_SSTensoradd

.. autofunction:: test_SSTensorrmul

.. autofunction:: test_SSTensorIP

.. autofunction:: test_findMainGeometry

.. autofunction:: test_SSTensor_to_xyangle

.. autofunction:: test_makeEPSplot

.. autofunction:: test_StateHolder

.. autofunction:: test_makeNearbyEPSplot

.. autofunction:: test_makeLineEPSplot

.. autofunction:: test_Fit_SSTensor

.. autofunction:: test_Fit_SSTensor_complex

.. autofunction:: test_trimcovered

.. autofunction:: test_xytgrid_ALS