Beginning GUI: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Introduction=
=Introduction=
This usecase presents a few of the more important new ParaView 3.X GUI features.  A full list of features can be found in the online help.
This usecase presents a few of the more important new ParaView GUI features.  A full list of features can be found in the ParaView Guide.


The paraview viewscreen can now be split.  This allows a user to see multiple aspects of their data at one time, or to display in multiple data files side by side.
Data is opened by going to '''File → Open'''.  Example data files can be found on the ParaView web page at http://www.paraview.org
 
==Customize Settings==
Paraview allows users to customize settings.  The most important ones are found in '''Edit → Settings → General'''.  These are:
**Auto Apply - Also found as an icon below the Macros menu.
**Auto Convert Properties - Automatically call '''Cell to Point''', '''Point to Cell''', or extract components from vectors as needed.
**'''Transfer Function Reset Mode''' - when to update the minimum and maximum for the '''Color Legend'''.
***'''Grow and update on Apply''' - default.  This means only update when told to.
***'''Grow and update every timestep'''.  This means to update the Minimum and/or Maximum only if the current timestep exceeds these numbers.  Basically, Add and grow.
***'''Clamp and update every timestep'''.  Set the minimum and maximum every timestep, from the data this timestep.  This is not recommended behavior, since it makes comparing frame to frame confusing.
**'''Scalar Bar Mode''' - just leave this one alone.
**'''Default timestep''' -
***'''Go to first timestep''' - default. 
***'''Go to last timestep'''
 
 
[[Image:beginning_gui_567.jpg]]
 
 
 
==Information tab==
*Open can.exo.  Turn all of the variables on.  Press '''Apply'''.
*Open the Information tab. 
**The first section tells you what blocks and sets you have in this dataset.
**Next comes properties on this dataset.
**The Statistics section tells you the number of cells and points in your dataset.  Note that Memory is incorrect.  (I believe it is actually memory used on the graphics card.)
**Data Arrays gives information on each variable, including the min and max.  Note that this is for the current timestep only.
**Bounds give the X, Y and Z bounds of the bounding box.
**Last is a list of all timesteps, with their associated time.
 
 
[[Image:beginning_gui_information_tab.jpg]]


Data is opened by going to '''File → Open'''.  Example data files can be found on the ParaView web page at http://www.paraview.org


==Right click menu based commands==
==Right click menu based commands==
*Open can.exo.  Press '''Apply'''.
*Open can.exo.  Press '''Apply'''.
*Right click on the object.   
*Right click on the object.   
'''Need more stuff here.'''
**Block Name
**Block specific visibility commands
**Block specific coloring and opacity
**Representation and coloring commands
**Link Camera
 
 
[[Image:beginning_gui_onscreenMenu.png]]
 


==Split windows==
==Split windows==
Line 41: Line 79:




[[Image:beginning_gui_3.png|800px]]
[[Image:beginning_gui_3.png|1000px]]
   
   
   
   
==Move/control windows==
==Move/control windows==
*Select the top window.  Apply a clip filter to this window.  '''Filters/ Common/ Clip/ Apply'''.  Deselect the '''Show Plane''' check box.
*Select the top window.   
*Click on the '''Maximize''' button of the upper window.   
*Click on the '''Maximize''' button of the upper window.   
[[Image:beginning_gui_1.png]]
[[Image:beginning_gui_1.png]]
Line 69: Line 107:
==Auto apply==
==Auto apply==
ParaView now has the ability to auto apply commands.  This button is to the left of the blue question mark, and looks like this:[[Image:autoApplyToggle.png]]
ParaView now has the ability to auto apply commands.  This button is to the left of the blue question mark, and looks like this:[[Image:autoApplyToggle.png]]
==Color palette==
ParaView allows users to easily control the color palette.  This is done with the '''Load a color palette''' icon.  [[Image:load_palette_icon.jpg]]  Changing color palettes does much more than just changing the background - it also changes the font colors for other annotations.  Options are default gray, black, white and gradient.  You can also create custom color palettes.
Here is an example of a gradient background, with the color palette menu displayed.
[[Image:beginning_gui_101.jpg|1000px]]


==Move the camera==
==Move the camera==
ParaView allows the user to change the position of the camera.  Such controls as '''Roll''', '''Elevation''' and '''Azimuth''' are available.  The '''Adjust Camera''' icon is on the right side of the row of icons at the top left of the 3d window.  It looks like this:  
ParaView allows the user to change and store the position of the camera.  Such controls as '''Roll''', '''Elevation''' and '''Azimuth''' are available.  The '''Adjust Camera''' icon is on the left side of the row of icons at the top left of the 3d window.  It looks like this:  


[[Image:beginning_gui_20.png]]
[[Image:beginning_gui_20.png]]


The A'''djust Camera''' dialog box looks like this:  
The '''Adjust Camera''' dialog box looks like this:  


[[Image:beginning_gui_21.png]]
[[Image:beginning_gui_21.png]]


Useful controls that I often use (in order) are as follows:
Useful controls that I often use (in order) are as follows:
*'''Custom Configure''' - Save up to 4 camera positions.
*'''Azimuth''' - rotate around the vertical axis.  Be sure to hit the button after entering a number.
*'''Azimuth''' - rotate around the vertical axis.  Be sure to hit the button after entering a number.
*'''Elevation''' - rotate around the horizontal axis in the plane of the screen.
*'''Elevation''' - rotate around the horizontal axis in the plane of the screen.
Line 91: Line 139:


==Color Map==
==Color Map==
*If needed, open can.exo and read in all of the variables. 
*Select the '''DISPL''' variable.  
*Select the '''DISPL''' variable.  
[[Image:beginning_gui_6.png]]
*Move forward one time step using the '''Next Frame''' icon.
*Move forward one time step using the '''Next Frame''' icon.
*Click on the '''Rescale to Data Range''' icon.  
*Here is the coloring toolbar.  Icons are as follows:
*Click on the Toggle '''Color Legend Visibility''' icon.
**Toggle color legend visibility.
**Edit color map.
**Rescale to data range (set Min and Max from this timestep).
**Rescale to custom data range (manually input Min and Max values.
**Rescale to visible data range (set Min and Max from visible objects this timestep)
 
 
[[Image:beginning_gui_61.png]]
 
 
*Click on the '''Edit Color Map''' icon.
*Click on the '''Edit Color Map''' icon.
[[Image:beginning_gui_6.png]]
[[Image:beginning_gui_6.png]]


   
   
[[Image:beginning_gui_7.png]]
 
*The '''Color Scale Editor''' is used to change the colormap.   
**Select the '''Use log scaling when mapping data to colors''' check box.  Notice what has happened to the colors on the can. Unselect '''Use log scaling...''' check box.
**Select the '''Enable opacity mapping for surfaces''' check box.  Notice what has happened to the colors on the can.  Unselect '''Enable opacity mapping ...''' check box.
**Select the '''Rescale to Data Range''' icon.  You already know what this does.
**Select the '''Rescale to Custom Range''' icon.  Set custom minimum and maximum values for the Color Legend.
**Select the '''Rescale to Data Range over all timesteps''' icon.  This will read in all of your data, and set the min and max based upon all timesteps.
**Select the '''Rescale to Visible Range''' icon.  Rescales based upon what is currently visible.  To see this work, click -Z, and then roll the can down slightly to hide the can itself.  Click the '''Rescale to Visible Range''' icon.
**Invert the transfer function.  Invert the color table.
**Select the '''Choose Preset''' icon.  Choose '''Cool to Warm''', then OK.  Notice what has happened to the colormap.  This is an easier to understand color map than the rainbow one that all of us are use to.  Next, choose the '''Black-Body Radiation''' preset.  Although harder to understand (requiring an understanding of the layout of the rainbow colors), this one makes prettier pictures.  The best color map to use is the default one.
 
[[Image:beginning_gui_66.png]]
 
*Advanced.  You can edit each color and opacity of the color map.
**Nan Color - this is the color ParaView will use to paint nans in your data.
**Click the advanced icon at the top.  You can mark cells or points that are outside of the normal range of the color map.
**Click the color legend with the '''e'''.  this is the '''Color Legend Editor'''.
 
 
[[Image:beginning_gui_81.png]]
   
   


*The '''Color Scale Editor''' is used to change the colormapThe online help covers the Color Scalar Editor ('''Help → Help → ParaView → Object Inspector → Display Panel → Color Selection''').  
==Matplotlib characters==
*Select the '''Use Logarithmic Scale''' icon.  Notice what has happened to the colors on the can.  Unselect '''Use Logarithmic Scale''' icon.
*If needed, open can.exo and read in all of the variables. 
   
*Select the '''DISPL''' variable.
*Select the '''Choose Preset''' icon.  Choose '''Cool to Warm''', then OK. Notice what has happened to the colormap.  This is an easier to understand colormap than the rainbow one that all of us are use toNext, choose the '''Blue to Red Rainbow''' presetAlthough harder to understand (requiring an understanding of the layout of the rainbow colors), this one makes prettier pictures.
*Move forward one time step using the '''Next Frame''' icon.
*We want to add an alpha character after DISPL.
**Open the color editor.   
**Open the Edit Color Legend icon.  It is the little color legend with the 'e' over it.
**Modify the Title '''DISPL''' to say '''DISPL $\alpha$'''
*Here is how to change a 2d plot of '''EQPS''' to '''EQPS (uV/m)'''  
**Plot Over Line.  ApplyTurn off all variables other than EQPS.
**Change the '''Legend Name''' from '''EQPS''' to '''EQPS ($\frac{\mu V}{m}$)'''
*Matplotlib Mathtext formats are described here:  http://matplotlib.org/users/mathtext.html
 
==Axes Grid==
 
*Open dataset disk_out_ref.exo.
*On the Display tab, scroll down and select Axis Grid
*Note that you can edit the Axis Grid attributes.
 
 
[[Image:advanced_gui_54.png|1000px]]
 
==Lighting - Specular==
It is possible to change the specular highlights in ParaView.  This is on the Properties tab, about half way down.  It is called Lighting: Specular.  Note that reflections can look like the center of the color map, thus specular highlights are turned off by default.
 
==Slice View and Layouts==
*Open disk_out_ref.exo.  Turn all variables on.  Apply.  Color by Temp.
*Clip.  Turn off the Show PlaneApply.
 
ParaView supports numerous simultaneous layouts, or windows, into your data.
*Select the X to the right of Layout #1 (upper left side of the 3d window).
 
ParaView also supports different views than 3d viewsHere is how to show your data as a slice view.
*Select Slice View
*Turn visiblity on for disk_out_ref.exo.  Color by Temp.
*Left click in the window, and drag disk_out_ref around. 
*Move the left, upper and right clip planes by dragging the black wedge.


You can intermix different view types.
*Split horizontal.
*Turn visibility on for disk_out_ref.  Paint by Temp.


[[Image:beginning_gui_8.png]]
You can also connect the cameras for the different viewsThis can be done through the '''Tools''' → '''Add Camera Links''' menu.
   


*Uncheck the '''Automatically Rescale to Fit Data Range''' checkbox.  Select '''Rescale Range'''.
*We can now select the variable ranges for the color range.  Since I know the range of the data for '''DISPL''', input 0 for the minimum and 20 for the maximum.  Hit the '''Rescale''' button.


[[Image:advanced_gui_55.png|1000px]]


[[Image:beginning_gui_9.png]]


*I found these numbers by going to time step 0, doing a '''Rescale to Data Range''' and using this number for the minimum, and repeating the process for the last time step to find the maximum.


   
==Render View (Comparison)==
ParaView can compare different time steps at the same time. This is called Comparative View.
*Open can.exo.  All vars on.  Apply.
*Split view horizontal.  Select '''Render View (Comparitive)'''
*Turn on visibility on the can.
*View/ Comparitive View inspector.
*Click on the blue +.  This creates a 2X2 set of views of can.exo at four different timesteps.


==Cube Axes==


*Open dataset disk_out_ref.exo.
[[Image:advanced_gui_59.png|1000px]]
*On the Display tab, scroll down to the Annotation section, and select Show Cube Axes.
*Note that you can edit the Cube Axes attributes.




[[Image:advanced_tips_and_tricks_1.png|800px]]


==Menus and Help==
==Menus and Help==
*Open help. Help/ Help/ Contents/ + ParaView
Cover all menus.
*File menu.  + File menu.  Go over these entries.
*Edit menu.  + Edit Menu.  Go over these entries.
*View menu.  + View Menu.  Go over these entries.
*Sources menu.  Show cone.  Mention use of Cone and Sphere.
*Filters Menu.  Show clip.
*Tools menu.  + Tools Menu




=Acknowledgements=
=Acknowledgements=
Sandia is a multiprogram laboratory operated by Sandia Corporation, a Lockheed Martin Company, for the United States Department of Energy’s National Nuclear Security Administration under contract DE-AC04-94AL85000.
Sandia National Laboratories is a multi-mission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy’s National Nuclear Security Administration under contract DE-NA-0003525.

Revision as of 20:30, 22 June 2017

Introduction

This usecase presents a few of the more important new ParaView GUI features. A full list of features can be found in the ParaView Guide.

Data is opened by going to File → Open. Example data files can be found on the ParaView web page at http://www.paraview.org

Customize Settings

Paraview allows users to customize settings. The most important ones are found in Edit → Settings → General. These are:

    • Auto Apply - Also found as an icon below the Macros menu.
    • Auto Convert Properties - Automatically call Cell to Point, Point to Cell, or extract components from vectors as needed.
    • Transfer Function Reset Mode - when to update the minimum and maximum for the Color Legend.
      • Grow and update on Apply - default. This means only update when told to.
      • Grow and update every timestep. This means to update the Minimum and/or Maximum only if the current timestep exceeds these numbers. Basically, Add and grow.
      • Clamp and update every timestep. Set the minimum and maximum every timestep, from the data this timestep. This is not recommended behavior, since it makes comparing frame to frame confusing.
    • Scalar Bar Mode - just leave this one alone.
    • Default timestep -
      • Go to first timestep - default.
      • Go to last timestep


Beginning gui 567.jpg


Information tab

  • Open can.exo. Turn all of the variables on. Press Apply.
  • Open the Information tab.
    • The first section tells you what blocks and sets you have in this dataset.
    • Next comes properties on this dataset.
    • The Statistics section tells you the number of cells and points in your dataset. Note that Memory is incorrect. (I believe it is actually memory used on the graphics card.)
    • Data Arrays gives information on each variable, including the min and max. Note that this is for the current timestep only.
    • Bounds give the X, Y and Z bounds of the bounding box.
    • Last is a list of all timesteps, with their associated time.


Beginning gui information tab.jpg


Right click menu based commands

  • Open can.exo. Press Apply.
  • Right click on the object.
    • Block Name
    • Block specific visibility commands
    • Block specific coloring and opacity
    • Representation and coloring commands
    • Link Camera


Beginning gui onscreenMenu.png


Split windows

  • Open can.exo. Press Apply.
  • Drag the can around with the left mouse button until you can see the can.
  • Split screen vertical – i.e., one above the other. This is the little box with the horizontal line.

Beginning gui 1.png

  • Select 3D View.
  • Turn the eyeball on for can, in the Pipeline Browser.
  • Split screen vertical – i.e., one above the other. This is the little box with the horizontal line.

Beginning gui 1.png

  • Select 3D View.
  • Turn the eyeball on for can, in the Pipeline Browser.
  • This last was a mistake. Undo, Undo, Undo. Undo is the red counter clockwise button.

Beginning gui 2.png

  • Select the bottom viewport.
  • Split screen horizontal – i.e., one next to the other. This is the little box with the vertical line.

Beginning gui 1.png

  • Select 3D View.
  • Turn the eyeball on for can, in the Pipeline Browser.
  • Now lets link the cameras. Right click on the upper window, and click on Link Camera. Click on the lower right window. Do the same between the two bottom windows.
  • Click in the lower left window, color by DISPL. Turn on Color Legend Visibility.
  • Click in the lower right window, color by ACCL. Turn on Color Legend Visibility.
  • Click in the upper window, color by VEL. Turn on Color Legend Visibility.
  • Go to the last frame, click on Rescale to Data Range, go to first frame, play.


Beginning gui 3.png


Move/control windows

  • Select the top window.
  • Click on the Maximize button of the upper window.

Beginning gui 1.png

  • Click the Restore button of the upper window.
  • Next, using the left mouse button, grab the title bar of the lower left window and drag/drop it into the upper window. These two windows have now switched places.
  • Finally, grab the divider between the two lower windows and drag it left and right. You can also move the divider between the upper and lower windows.

Unlink windows

  • To unlink the windows, we use the Link Manager. Tools/ Manage Links. Select the second link, and click Remove. Close.
  • Now, grab and rotate can in the three windows.
  • Finally, delete the bottom two windows, using the Close button.

Beginning gui 1.png

Control the center

  • Click on the Show Center icon. Notice that this toggles the center cross.
  • Click on the Pick Center icon, then select a location on the can. Rotate the can, and notice where it is rotating.
  • Click on the Reset Center icon, returning the rotation location and center cross to the center of the object.

Beginning gui 4.png

  • You can always recenter the object using the Reset icon.

Beginning gui 5.png


Auto apply

ParaView now has the ability to auto apply commands. This button is to the left of the blue question mark, and looks like this:AutoApplyToggle.png

Color palette

ParaView allows users to easily control the color palette. This is done with the Load a color palette icon. Load palette icon.jpg Changing color palettes does much more than just changing the background - it also changes the font colors for other annotations. Options are default gray, black, white and gradient. You can also create custom color palettes.

Here is an example of a gradient background, with the color palette menu displayed.

Beginning gui 101.jpg


Move the camera

ParaView allows the user to change and store the position of the camera. Such controls as Roll, Elevation and Azimuth are available. The Adjust Camera icon is on the left side of the row of icons at the top left of the 3d window. It looks like this:

Beginning gui 20.png

The Adjust Camera dialog box looks like this:

Beginning gui 21.png

Useful controls that I often use (in order) are as follows:

  • Custom Configure - Save up to 4 camera positions.
  • Azimuth - rotate around the vertical axis. Be sure to hit the button after entering a number.
  • Elevation - rotate around the horizontal axis in the plane of the screen.
  • Roll - rotate around the axis coming out of the screen.
  • View angle - basically a zoom in.
  • Camera position - where the camera is.
  • Focal point - where the camera is looking.
  • View Up - I don't know what this is.
  • You can always recenter the object using the Reset icon. First, however, be sure to change View angle back to 30.


Color Map

  • If needed, open can.exo and read in all of the variables.
  • Select the DISPL variable.
  • Move forward one time step using the Next Frame icon.
  • Here is the coloring toolbar. Icons are as follows:
    • Toggle color legend visibility.
    • Edit color map.
    • Rescale to data range (set Min and Max from this timestep).
    • Rescale to custom data range (manually input Min and Max values.
    • Rescale to visible data range (set Min and Max from visible objects this timestep)


Beginning gui 61.png


  • Click on the Edit Color Map icon.


Beginning gui 6.png


  • The Color Scale Editor is used to change the colormap.
    • Select the Use log scaling when mapping data to colors check box. Notice what has happened to the colors on the can. Unselect Use log scaling... check box.
    • Select the Enable opacity mapping for surfaces check box. Notice what has happened to the colors on the can. Unselect Enable opacity mapping ... check box.
    • Select the Rescale to Data Range icon. You already know what this does.
    • Select the Rescale to Custom Range icon. Set custom minimum and maximum values for the Color Legend.
    • Select the Rescale to Data Range over all timesteps icon. This will read in all of your data, and set the min and max based upon all timesteps.
    • Select the Rescale to Visible Range icon. Rescales based upon what is currently visible. To see this work, click -Z, and then roll the can down slightly to hide the can itself. Click the Rescale to Visible Range icon.
    • Invert the transfer function. Invert the color table.
    • Select the Choose Preset icon. Choose Cool to Warm, then OK. Notice what has happened to the colormap. This is an easier to understand color map than the rainbow one that all of us are use to. Next, choose the Black-Body Radiation preset. Although harder to understand (requiring an understanding of the layout of the rainbow colors), this one makes prettier pictures. The best color map to use is the default one.

Beginning gui 66.png

  • Advanced. You can edit each color and opacity of the color map.
    • Nan Color - this is the color ParaView will use to paint nans in your data.
    • Click the advanced icon at the top. You can mark cells or points that are outside of the normal range of the color map.
    • Click the color legend with the e. this is the Color Legend Editor.


Beginning gui 81.png


Matplotlib characters

  • If needed, open can.exo and read in all of the variables.
  • Select the DISPL variable.
  • Move forward one time step using the Next Frame icon.
  • We want to add an alpha character after DISPL.
    • Open the color editor.
    • Open the Edit Color Legend icon. It is the little color legend with the 'e' over it.
    • Modify the Title DISPL to say DISPL $\alpha$
  • Here is how to change a 2d plot of EQPS to EQPS (uV/m)
    • Plot Over Line. Apply. Turn off all variables other than EQPS.
    • Change the Legend Name from EQPS to EQPS ($\frac{\mu V}{m}$)
  • Matplotlib Mathtext formats are described here: http://matplotlib.org/users/mathtext.html

Axes Grid

  • Open dataset disk_out_ref.exo.
  • On the Display tab, scroll down and select Axis Grid
  • Note that you can edit the Axis Grid attributes.


Advanced gui 54.png

Lighting - Specular

It is possible to change the specular highlights in ParaView. This is on the Properties tab, about half way down. It is called Lighting: Specular. Note that reflections can look like the center of the color map, thus specular highlights are turned off by default.

Slice View and Layouts

  • Open disk_out_ref.exo. Turn all variables on. Apply. Color by Temp.
  • Clip. Turn off the Show Plane. Apply.

ParaView supports numerous simultaneous layouts, or windows, into your data.

  • Select the X to the right of Layout #1 (upper left side of the 3d window).

ParaView also supports different views than 3d views. Here is how to show your data as a slice view.

  • Select Slice View
  • Turn visiblity on for disk_out_ref.exo. Color by Temp.
  • Left click in the window, and drag disk_out_ref around.
  • Move the left, upper and right clip planes by dragging the black wedge.

You can intermix different view types.

  • Split horizontal.
  • Turn visibility on for disk_out_ref. Paint by Temp.

You can also connect the cameras for the different views. This can be done through the ToolsAdd Camera Links menu.


Advanced gui 55.png


Render View (Comparison)

ParaView can compare different time steps at the same time. This is called Comparative View.

  • Open can.exo. All vars on. Apply.
  • Split view horizontal. Select Render View (Comparitive)
  • Turn on visibility on the can.
  • View/ Comparitive View inspector.
  • Click on the blue +. This creates a 2X2 set of views of can.exo at four different timesteps.


Advanced gui 59.png


Menus and Help

Cover all menus.


Acknowledgements

Sandia National Laboratories is a multi-mission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy’s National Nuclear Security Administration under contract DE-NA-0003525.