DREAM3D User Manual
Overview of the User Interface

DREAM3D has 4 main areas of its user interface:

  1. The Filter Library
  2. The Filter List
  3. The Errors Tab
  4. The Pipeline Area
OverView-1.png
Overview of DREAM3D user interface

The Filter Library

Area 1: This area of the user interface is broken into 3 basic groups: Filter Library, Prebuilt Pipelines and Favorite Pipelines. The Filter Library section contains the various groups into which the filters are organized. The user can click a specific group and just the filters associated with that group will be displayed in the Filter List area of the user interface.

Prebuilt Pipelines

DREAM3D provides several Prebuilt Pipelines that can aid the new user in getting started with DREAM3D. Double clicking a preset will clear any current filters in the pipeline area and populate the pipeline area with the filters from the Pipeline Preset.

Favorite Pipelines

After the user builds a pipeline that they may want to save for later the user can use the Pipeline menu and select the "Add Favorite" menu to save that specific pipeline configuration. If at a future point in time the user wants to remove the favorite from the Favorites list they user can select from the "Add Favorite" menu and choose Remove Favorite to remove it from the list.


PipelineMenu.png
Pipeline Menu

Additional shortcuts are available by right clicking on the Favorite Pipelines tree item which will display a contextual menu to create a new favorite pipeline entry.


FavoritesContextualMenu.png
Favorite Pipeline Contextual Menu

The user can also rename a Favorite Pipeline entry by right clicking on the entry item and selecting the desired action. The only valid characters that can be used are AlphaNumeric, the underscore (_) and the dash (-).


FavoritesContextualMenu-2.png
Renaming/Removing a Favorite

The user should also note that simply selecting a Favorite Pipeline from the list will display the filters in order of operation in the Filter List area.

Getting Help for a Filter

The user can Right Click in the title area of the filter to display a menu where the user can select the "Show Filter Help" menu selection. The user's default web browser will be opened to the page containing the documentation for the current filter.


FilterContextMenu.png
Getting Help for a filter

Filter List

Area 2: This section lists the filters that are associated with a specific group that is selected in the Filter Library area. If the Filter Library is itself selected, then all filters will be shown in this list. The user typically will select a filter from this list and drag it over to the pipeline area.

Errors & Warnings Tab

Area 3: This area displays any errors and/or warnings associated with the filter when it is actively being used in a pipeline. The display of the errors can be toggled on and off by pressing the appropriate buttons. Also clicking the **?** icon will display all of the help (including filter reference, tutorials and user manual) in the users default web browser.

OverView-2.png
Errors and Warnings Tab

Pipeline Area

Area 4:This area is where the user will construct their pipeline by either double clicking on a filter in the filter list area or dragging a filter from the filter list and dropping the filter into the pipeline area. Filters in this section can be rearranged by dragging the filter into a new location. As the user updates the pipeline a process called the Preflight will be executed to make sure that the pipeline will have all the necessary data available during the actual execution of the processing pipeline.

OverView-3.png
Pipeline area populated with filters
| | Navigation | | |----|---------|------| | [Back](supportedfileformats.html) | [Top](usermanual.html) | [Next Section](creatingpipeline.html) |