Difference between revisions of "Documentation"

From VistrailsWiki
Jump to navigation Jump to search
m (Reverted edits by ZliMce (Talk); changed back to last version by Cscheid)
 
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Getting Started ==
Documentation for installing VisTrails and additional packages is available on the [[Downloads|Downloads]] page.
== User's Guide and FAQ ==
== User's Guide and FAQ ==


A (n always evolving) user's guide is [[Users_Guide|available here]]. A [[FAQ]] is also available.
An always evolving [[Users_Guide|user's guide]] and is available along with a list of [[FAQ|frequently asked questions]].
 
== Screen Shots ==
 
{|{{Prettytable}}
|[[Image:Corie_example.png|256px]]
|'''CORIE Example'''
An example of VisTrails used for visualizing time steps of data unstructured grid data from the CORIE project.  Left: The VisTrail builder is shown with a VTK pipeline that includes custom classes.  Right: The spreadsheet is used to compare salinity in the Columbia River Estuary during different time steps. 
|-
|[[Image:Memory_study.png|256px]]
|'''Memory Study'''
An example of VisTrails used for a visualizing measured data for a single patient in a memory study.  The pipeline utilizes the VisTrails execution model to combine VTK, ITK, and Matplotlib libraries.
|-
|[[Image:Mesh_example.png|256px]]
|'''Mesh Comparisons'''
An example of exploratory visualization for comparing isosurface extraction techniques using VisTrails. Complete provenance of the creation and exploration process is displayed in a history tree on the left. One pipeline that combines five different software libraries is shown
in the middle. A parameter exploration of this pipeline for three different datasets and isosurface parameters is shown in the Visualization
Spreadsheet on the right.
|-
|[[Image:Slicing.png|256px]]
|'''Interactive Visualization'''
An example of a VisTrails pipeline used to create an interactive visualization within the spreadsheet of the visible human. An interactive cutting plane separates volume rendering and isosurfacing algorithms and is used to update orthogonal slices in separate windows.
|-
|[[Image:Parameter_exploration.png|256px]]
|'''Parameter Exploration'''
A snapshot of the parameter exploration interface for a simple one-dimensional exploration of isosurface values in the visible human.
|-
|[[Image:visual_diff_composite.png|256px]]
|'''Visual Differences'''
The Visual Difference interface is shown for comparing volume rendering (top) and isosurfacing (bottom) visualizations of the visible human.  Orange modules are unique to the volume rendering pipeline, Blue modules are unique to the isosurfacing pipeline, light gray modules have different parameters set, and dark gray modules are common.
|-
 
 
|}
 
== Tutorials ==
 
For a list of tutorials given by members of the VisTrails group, see http://www.vistrails.org/index.php/Tutorials
 
Tutorial by [http://www.cs.unc.edu/~taylorr/ Russell M. Taylor II] from University of North Carolina -- http://www.cs.unc.edu/~taylorr/quammen_vistrails_tutorial/VisTrailsTutorial.html


== Video Tutorial  ==
== Video Tutorial  ==
Line 36: Line 78:
|}
|}


== Videos  ==
== Other Videos  ==


Please note that some of these videos were generated using versions of VisTrails, and the interface might look different than the one available in the most up-to-date version.
We have produced several videos exploring different features of the system.Please note that some of these videos were generated using older versions of VisTrails, and the interface might look different than the one available in the latest releases.


{| {{Prettytable}}
{| {{Prettytable}}

Latest revision as of 15:18, 28 September 2010

Getting Started

Documentation for installing VisTrails and additional packages is available on the Downloads page.

User's Guide and FAQ

An always evolving user's guide and is available along with a list of frequently asked questions.

Screen Shots

Corie example.png CORIE Example

An example of VisTrails used for visualizing time steps of data unstructured grid data from the CORIE project. Left: The VisTrail builder is shown with a VTK pipeline that includes custom classes. Right: The spreadsheet is used to compare salinity in the Columbia River Estuary during different time steps.

Memory study.png Memory Study

An example of VisTrails used for a visualizing measured data for a single patient in a memory study. The pipeline utilizes the VisTrails execution model to combine VTK, ITK, and Matplotlib libraries.

Mesh example.png Mesh Comparisons

An example of exploratory visualization for comparing isosurface extraction techniques using VisTrails. Complete provenance of the creation and exploration process is displayed in a history tree on the left. One pipeline that combines five different software libraries is shown in the middle. A parameter exploration of this pipeline for three different datasets and isosurface parameters is shown in the Visualization Spreadsheet on the right.

Slicing.png Interactive Visualization

An example of a VisTrails pipeline used to create an interactive visualization within the spreadsheet of the visible human. An interactive cutting plane separates volume rendering and isosurfacing algorithms and is used to update orthogonal slices in separate windows.

Parameter exploration.png Parameter Exploration

A snapshot of the parameter exploration interface for a simple one-dimensional exploration of isosurface values in the visible human.

Visual diff composite.png Visual Differences

The Visual Difference interface is shown for comparing volume rendering (top) and isosurfacing (bottom) visualizations of the visible human. Orange modules are unique to the volume rendering pipeline, Blue modules are unique to the isosurfacing pipeline, light gray modules have different parameters set, and dark gray modules are common.

Tutorials

For a list of tutorials given by members of the VisTrails group, see http://www.vistrails.org/index.php/Tutorials

Tutorial by Russell M. Taylor II from University of North Carolina -- http://www.cs.unc.edu/~taylorr/quammen_vistrails_tutorial/VisTrailsTutorial.html

Video Tutorial

We are in the process of creating a video tutorial that can be used to guide users through the process of learning to use VisTrails. The videos that follow below are a preliminary version of this tutorial, and will keep evolving towards a complete tutorial.

VT_Thumbs_PiplineBuilder.jpg The Pipeline Builder

These videos demonstrate the basic usage of the Pipeline Builder, including how to add modules, connect modules, and modify module parameters.

Quicktime.png Adding a Module

Quicktime.png Adding a Parameter

Quicktime.png Connecting Two Modules

Quicktime.png Adding a Parameter via Modules


VT_Thumbs_ParameterExplore.jpg Parameter Space Exploration

These videos demonstrate more advanced use of the Pipeline Builder window. Parameter exploration allows easy mutli-dimensional comparative visualization generation to quickly and thoroughly explore data.

Quicktime.png Parameter Space Exploration


VT_Thumbs_VersionTree.jpg The Version Tree

These videos show interaction with the Version Tree. Emphasis here is on interaction with the widgets, searching and refining the versions displayed, and performing diffs between versions to highlight changes.

Quicktime.png Version Tree Interaction

Quicktime.png The Visual Diff

Quicktime.png Querying the Version Tree and Pipelines


Other Videos

We have produced several videos exploring different features of the system.Please note that some of these videos were generated using older versions of VisTrails, and the interface might look different than the one available in the latest releases.

Demonstration_thumb.png Demonstration

This video shows basic usage of VisTrails by going through three examples. Some of the features shown are:

  • Manipulating a pipeline by adding modules and connections and setting parameters
  • Performing a parameter exploration

As this is an old version of the system, some of the features are not currently available.

Quicktime.png High Resolution(81 MB)

Quicktime.png Medium Resolution(29 MB)

Quicktime.png Low Resolution(16 MB)

Radiation_thumb.png Radiation Oncology

This video shows how some of VisTrails features were used on a Radiation Oncology study.

As this is an old version of the system, some of the features are not currently available.

Quicktime.png High Resolution(70 MB)