.. _help_top:

Help
====

This section describes the commands under the main menu's **Help** tab,
which provides access to basic diagnostic information about the computer
and FireVoxel installation. When images are open in FireVoxel, this tab
also contains the **Test** operations for pre-release software testing.

.. _help_about:

About this Application
----------------------

Shows dialog with build number, release date, version expiration date,
copyright information, contact information for license requests and support,
allocated memory and disclaimer, as well as web addresses of FireVoxel's main
website, development blog, and LinkedIn group (:numref:`fig_about_fv`).

   .. _fig_about_fv:
   .. figure:: ../images/help_about.png
      :alt: About FireVoxel panel
      :align: center
      :figclass: align-center

      About FireVoxel.

.. _help_ui_config:

Display current UI configuration
--------------------------------

Shows dialog with a snapshot of default folders and current options
(:numref:`fig_curr_ui`).

.. _help_cpu_info:

CPU Info
--------

Shows dialog with information about the computer CPU type and speed
and other parameters (:numref:`fig_cpu_info`).

.. _help_test:

Test (with images only)
-----------------------

.. _help_test_locoi:
.. _help_test_equinet_denoise:
.. _help_test_compress_equinet:
.. _help_test_compress_nlm:
.. _help_test_compress_ynet:
.. _help_test_compress_trivial_interslice:

- LOCOI compress
- EquiNet: Denoise Volume
- Compress Volume EquiNet
- Compress Volume NLM
- Ynet Compression
- Trivial interslice compression

.. _help_test_memory_leak:

Memory Leak Report (without images)
-----------------------------------

   .. _fig_curr_ui:
   .. figure:: ../images/help_curr_ui_config.png
      :alt: Display current UI configuration
      :align: center
      :scale: 80 %
      :figclass: align-center

      Display current UI configuration.

   .. _fig_cpu_info:
   .. figure:: ../images/help_cpu_info.png
      :alt: Display CPU info
      :align: center
      :scale: 80 %
      :figclass: align-center

      Display CPU info.


|top|