:topic: home

.. _home:


.. figure:: Introduction/Images/NX_Banner_Logo.png
   :alt: DREAM3D-NX Banner

######################################################
DREAM3D-NX Version |release|
######################################################

.. ...........................................................................

.. topic:: Overview

   DREAM3D-NX is a user-friendly and versatile desktop application that leverages the 
   open-source `simplnx <https://www.gtithub.com/bluequartzsoftware/simplnx>`__ software 
   library to enable users to manipulate, analyze, and 
   visualize multidimensional, multimodal data with ease. With its advanced reconstruction, 
   quantification, meshing, data organization, and visualization capabilities, 
   DREAM3D-NX has emerged as a go-to tool for the materials science community to 
   reconstruct and quantify 3D microstructures.
   Its flexibility and adaptability make it suitable for a broad range of multidimensional data analysis applications 
   beyond materials science and engineering domain.

.. figure:: Introduction/Images/NX_Overview_Commercial.png
   :alt: DREAM3D-NX including visualization capabilities

   DREAM3D-NX with visualization

Capabilities
==================

DREAM3D-NX has almost 250 individual **filters** that can import, process or export multidimensional data. The filters
can be divided into three main groups.

Data Import
^^^^^^^^^^^
This group allows the user to read various data files into the running instance of DREAM3D-NX. There are approximately 15
different kinds of files that can be imported.

   - EBSD Data from EDAX (.ang and .h5), Oxford Instruments (.ctf) and BrukerNano (.ctf and .h5)
   - Image Files as either single or 3D stacks (TIF, BMP, JPEG, PNG, MHA)
   - CT data files [North Star Imagings (.nsihdr/.nsidat) Volume Graphics (.vgi/.vol)]
   - Generic HDF5 files
   - Binary files
   - ASCII formatted text files
   - CSV formatted text files
   - STL triangle mesh files

Data Export
^^^^^^^^^^^^

  - HDF5 (.dream3d file) Compatibility with `ParaView <http://www.paraview.org>`__ to visualize raw and processed data through an XDMF file.
  - Binary Files
  - ASCII Files
  - STL files
  - Abaqus File
  - Image Files as either single or 3D stacks (TIF, BMP, JPEG, PNG, MHA)
  - Avizo files
  - VTK legacy files (Rectilinear Grids only)

Data Processing
^^^^^^^^^^^^^^^

   - Slice to Slice Image Alignment
   - Cleaning/Processing to remove/mask unwanted data
   - Segmentation: Mark areas that represent the features of your microstructure
   - Size and shape Analysis of segmented features


Architecture
==================

   The above items represent only a subset of the specific capabilities of
   DREAM3D-NX. In general, DREAM3D-NX can be considered a generic tool for
   processing multidimensional, multimodal data. The main `DREAM3D-NX web
   site <https://www.dream3d.io>`__ has more information on the
   project, in addition to official binary distributions and example data
   files. DREAM3D-NX is built with a **Plugin** system that allows other
   institutions to build additional **Filters** using their own programming
   resources and intellectual property. `simplnx <https://www.gtithub.com/bluequartzsoftware/simplnx>`__ 
   is a rewrite of the `SIMPL <https://www.github.com/bluequartzsoftware/simpl>`__
   library upon which the original `DREAM.3D <https://www.github.com/bluequartzsoftware/dream3d>`__
   is written. This library aims to be fully C++17 compliant, removes the need 
   for Qt at the library level and brings more flexible data organization and 
   grouping options. The library is under active development by BlueQuartz Software at the current time.

.. ...........................................................................

.. toctree::
   :caption: Table of Contents
   :numbered: 2
   :maxdepth: 3
   :hidden:
   :includehidden:

   
   Introduction
   Concepts
   UserInterface
   Visualization
   WorkflowParameters
   ReleaseNotes
   SimplnxCore
   ITKImageProcessing
   OrientationAnalysis
   License

Indices and tables
==================

* :ref:`genindex`