.. _toolbar_top:

Toolbar
=======

.. contents::
   :depth: 1
   :local:
   :backlinks: top

Toolbar visibility and position
-------------------------------

The visibility of the main toolbar (:numref:`fig_main_toolbar`) is toggled on and off
using **View** > :ref:`Show Main Toolbar <view_show_toolbar>`.

By default, the main toolbar is docked on the right-hand side.
To select a different toolbar docking placement, use
File > :ref:`User Interface Options <interface_options>` >
:ref:`Main Toolbar Alignment <toolbar_alignment>`.
The position of the toolbar is changed immediately after this option
is changed in the User Interface Options.

When using FireVoxel on a laptop with a small screen,
it is recommended to dock the toolbar at the bottom of
the software window or leave the toolbar undocked, to have easy access
to all toolbar icons.

The toolbar can be undocked by hovering the mouse over its top edge
(if the toolbar is docked on the right or left) or over its leftmost
edge (if the toolbar is docked at the bottom). When the cursor becomes
a 4-arrow cross, the user may click and drag the toolbar to a new location.
An undocked toolbar can be positioned anywhere on the screen,
inside or outside FireVoxel's main software window.

To dock the toolbar, double-click its blue title bar.
The toolbar will return to its docking position indicated
in the User Interface Options.

   .. _fig_main_toolbar:
   .. figure:: ../images/toolbar.png
      :alt: Main toolbar
      :align: center
      :figclass: align-center

      Main toolbar.

Each icon on the toolbar launches an individual tool.
With few exceptions, most of these tools duplicate the commands
that are available via the main menu.

To exit from the tools such as **Zoom** or **Change Width/Level**,
press **Esc**.

If the tool opens a dialog (e.g., **Calculate Parametric Map** or
**EdgeWave Segmentation**), click **OK** on the tool dialog to start
processing or Cancel to exit from the tool.

.. _toolbar_icons:

Toolbar icons
-------------

|window_level_icon|  :ref:`Change Width/Level <grayscale_toolbar>`

|zoom_by_window|   :ref:`Zoom by window selection <zoom_by_window>`

|zoom_all|  :ref:`Zoom All and fit to View <zoom_all>`

|zoom_in| and |zoom_out|  :ref:`Zoom in and Zoom out with fixed upper corner <zoom_in_out>`

|set_project|  :ref:`View Projection of Selected Entity <view_set_projection>`

|play_4d_exp_icon|  :ref:`Play 4D Experiment <toolbar_play_4D>`

|voxel_tac_icon|  :ref:`Voxel Time Activity Curve Browser <toolbar_voxel_tac>`

|vroi_icon|  :ref:`Construct Vector ROI <vector_construct_vroi>`

|polyline|  :ref:`Insert Polyline <vector_insert_polyline>`

|add_text|  Insert Text - Currently inactive

|paintbrush|  :ref:`Voxel Paintbrush settings <paintbrush_settings>`

|edgewave|  :ref:`EdgeWave Basic <ew_dialog>`

|param_map|  :ref:`Calculate Parametric Map <param_map_top>`

|orthog_project|  :ref:`Display orthogonal projections <view_toolbar_3projections>`

|trace_magtrace_icon|  :ref:`Magnetic Trace <trace_start>`

|vector_rasterize_icon|  :ref:`Rasterize selected vector entities <vector_rasterize>`

|undo_active|  :ref:`Undo <undo_redo>` -- Active for selected commands
that change voxel values in the active layer.

|redo_active|  :ref:`Redo <undo_redo>` -- Becomes active after **Undo** is used.

.. _undo_redo:

Undo / Redo
-----------

**Undo** and **Redo** features are available via the main toolbar icons.
These features are inactive (grayed out: |undo|/|redo|) for most commands.

These features become active (|undo_active|/|redo_active|) for some of those
commands that change the voxel values in the active layer without creating
a new layer or document window.

The features do not apply to commands that create new document windows
and layers, or create or edit raster ROIs, vector ROIs, or contours.

Several such commands can be found in the **Volume** >
:ref:`Voxel value conversion <volume_value_conversion>` >
:ref:`Linear conversion over ROI <volume_linear_conversion>` OR
:ref:`Invert <volume_invert>`.

The Undo/Redo functionality is illustrated here using **Invert** as an example:

1. **Original image** -- When the original (Dixon) image is opened in FireVoxel,
the **Undo/Redo** features are inactive.

   .. _fig_kidney_orig:
   .. figure:: ../images/kidney_orig_img_histo.png
      :alt: Original kidney image and histogram
      :width: 700 px
      :align: center
      :figclass: align-center

      Original image and histogram. Undo/Redo inactive.

2. **Inverted image** -- Select **Volume** >
:ref:`Voxel value conversion <volume_value_conversion>` >
:ref:`Invert <volume_invert>`. The image is inverted and the histogram
is flipped around the middle of the interval.
**Undo** feature becomes active. **Redo** remains inactive.

   .. _fig_kidney_invert:
   .. figure:: ../images/kidney_invert_img_histo.png
      :alt: Result of Invert command
      :width: 700 px
      :align: center
      :figclass: align-center

      Result of Volume > Invert. Undo active/Redo inactive.

2. **Undo Invert** -- Click **Undo** |undo_active|. The kidney image is restored
to its original state (before **Invert** was used) and the histogram is again flipped.
The **Undo** is now inactive, but **Redo** becomes active.

   .. _fig_kidney_undo:
   .. figure:: ../images/kidney_undo_img_histo.png
      :alt: Result of Undo command
      :width: 700 px
      :align: center
      :figclass: align-center

      Result of Undo command. Undo inactive/Redo active.

3. **Redo Invert** -- Click **Redo** |redo_active|.
The image is inverted again, as after the first Invert
(:numref:`fig_kidney_invert`).

.. |window_level_icon| image:: ../images/toolbar_window_level_icon.png
.. |zoom_by_window| image:: ../images/toolbar_zoom_by_window_icon.png
.. |zoom_in| image:: ../images/toolbar_zoom_in_corner_icon.png
.. |zoom_out| image:: ../images/toolbar_zoom_out_corner_icon.png
.. |zoom_all| image:: ../images/toolbar_zoom_all_icon.png
.. |set_project| image:: ../images/toolbar_set_projection_icon.png
.. |orthog_project| image:: ../images/toolbar_orthog_projections_icon.png
.. |play_4d_exp_icon| image:: ../images/toolbar_play_4d_exp_icon.png
.. |voxel_tac_icon| image:: ../images/toolbar_voxel_tac_icon.png
.. |vector_rasterize_icon| image:: ../images/toolbar_rasterize_icon.png
.. |trace_magtrace_icon| image:: ../images/toolbar_magtrace_icon.png
.. |vroi_icon| image:: ../images/toolbar_vroi_icon.png
.. |paintbrush| image:: ../images/toolbar_paintbrush_icon.png
.. |edgewave| image:: ../images/toolbar_edgewave_icon.png
.. |param_map| image:: ../images/toolbar_param_map_icon.png
.. |polyline| image:: ../images/toolbar_polyline_icon.png
.. |add_text| image:: ../images/toolbar_text.png
.. |undo| image:: ../images/toolbar_undo.png
.. |undo_active| image:: ../images/toolbar_undo_active.png
.. |redo| image:: ../images/toolbar_redo.png
.. |redo_active| image:: ../images/toolbar_redo_active.png

|top|