.. include:: icons.rst

Interface Overview
==================

.. image:: ../images/gui_layout.png
    :align: center

Main Menu
---------

The |Menu button| button opens the main menu where:

* A new project can be created by pressing the |New button| button
* Previously create projects can be opened by pressing the |Open button| button
* The current project can be saved by pressing the |Save button| button
* The current project can be saved as a different name by pressing the
  |Save button| save as button
* Settings can be changed by pressing the |Settings button| button.
* Links to this documentation and other resources can be reached through the
  |Help button| button.
* Information about the application including library versions can be reached by
  pressing the |Info button| button.
* The application can be closed by pressing the |Close button| button.

Viewer Controls
---------------

If media is opened (images, video, etc.) the the viewer controls can be used to:

* Save an image of the current frame with the |Camera button| button.
* Zoom in with the |Zoom in button| button.
* Zoom out with the |Zoom out button| button.
* Show the entire image using the |Fit button| button.

Image Tools
-----------

If media is opened, the image tools can be used to:

* Move the image around by clicking and dragging (panning) with the |Pan button|
  selected.
* Draw a circle, reporting the area and radius (in pixels), by clicking and
  dragging on the image when the |Circle button| is selected.
* Draw a line, reporting the length (in pixels), by clicking and dragging on the
  image when the |Ruler button| is selected.

Frame Controls
--------------

If media is opened, the frames of the media can be traversed using the
following buttons:

* |First button| button to go to the first frame.
* |Back button| button to go to the previous frame.
* |Play button| button to go to start moving through all the frames.
* |Pause button| button to stop moving through the frames.
* |Next button| button to go to the next frame.
* |Last button| button to go to the last frame.
* |Repeat button| button to go back to the first frame after the last frame has
  been reached.

Moving to a specific frame can be accomplished by entering a integer in the
current frame line-edit.

Media Viewer
------------

The media viewer is where the current frame and other post processing is
display in different tabs. The current frame can be manipulated by using the
mouse:

* Pan the image by holding the left mouse button.
* Zoom in/out using the scroll wheel.
* Zoom to a particular rectangle by holding the right mouse button and dragging
  a rectangle.


Processing Tabs
---------------

The processing tabs are where all the options sit to load, process, track,
visualize, and post-process the media (image, video, etc.). The processing
workflow moves from left to right through these tabs. The subsequent sections
of this documentation describe these tabs.

Status
------

The status bar indicates what the program is currently doing:

+------------+--------------------------------------+
| Text       | State                                |
+============+======================================+
| Ready      | Sitting idle waiting for user input. |
+------------+--------------------------------------+
| Processing | Currently processing a frame.        |
+------------+--------------------------------------+

CPU and RAM Monitor
-------------------

The CPU and RAM monitor shows the current level of resourcing being used by all
processes running on the current machine.