Difference between revisions of "ParaView/UsersGuide/Filter Categories"

From KitwarePublic
Jump to navigationJump to search
(flesh out categorical discussion (more work needed))
(Replaced content with "{{ParaView/Template/DeprecatedUsersGuide}}")
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Available Filters ==
+
{{ParaView/Template/DeprecatedUsersGuide}}
 
 
There are a great many filters available in ParaView ([[ParaView/Users Guide/List of filters |1]]) (and even more in VTK), and because ParaView has a modular architecture, it is routine for people to add additional ones ([[ParaView/Users_Guide/Plugins |2]]).
 
Some filters have obscure purposes and are rarely used, but others are more general purpose and used very frequently. These most common filters are found easily on the '''Common''' ('''View''' -> '''Toolbars''') toolbar.
 
 
 
 
 
<center>[[File:ParaView_UsersGuide_CommonFiltersToolbar.png||link=]]</center>
 
 
 
<center>'''Figure 10. Common Filters Toolbar'''</center>
 
 
 
 
 
These filters include:
 
 
 
* '''Calculator''' - Evaluates a user-defined expression on a per-point or per-cell basis ([[ParaView/Users_Guide/Calculator|3]])
 
* '''Contour''' - Extracts the points, curves, or surfaces where a scalar field is equal to a user-defined value. This surface is often also called an isosurface.
 
* '''Clip''' - Intersects the geometry with a half space. The effect is to remove all the geometry on one side of a user-defined plane.
 
* '''Slice''' - Intersects the geometry with a plane. The effect is similar to clipping except that all that remains is the geometry where the plane is located.
 
* '''Threshold''' - Extracts cells that lie within a specified range of a scalar field.
 
* '''Extract Subset''' - Extracts a subset of a grid by defining either a volume of interest or a sampling rate.
 
* '''Glyph''' - Places a glyph, a simple shape, on each point in a mesh. The glyphs may be oriented by a vector and scaled by a vector or scalar.
 
* '''Stream Tracer''' - Seeds a vector field with points and then traces those seed points through the (steady state) vector field.
 
* '''Warp''' - Displaces each point in a mesh by a given vector field.
 
* '''Group Datasets''' - Combines the output of several pipeline objects into a single multi block data set.
 
* '''Group Extract Level''' - Extract one or more items from a multi block data set.
 
 
 
These eleven filters are a small sampling of what is available in ParaView.
 
 
 
 
 
In the Alphabetical submenu of the Filters menu you will find all of the filters that are useable in your copy of ParaView. Currently there are mote than one hundred of them, so to make them easier to find the Filters menu is organized into submenus. These submenus are organized as follows.
 
 
 
* '''Recent''' - The filters you've used recently.
 
* '''Common''' - The common filters. This is the same set of filters on the common filters toolbar.
 
* '''Cosmology''' - This contains filters developed at LANL for cosmology research.
 
* '''Data Analysis''' - The filters designed to retrieve quantitative values from the data. These filters compute data on the mesh, extract elements from the mesh, or plot data.
 
* '''Statistics''' - This contains filters that provide descriptive statistics of data, primarily in tabular form.
 
* '''Temporal''' - Filters that analyze or modify data that changes over time.
 
 
 
All filters can work on data that changes over time because they are re-executed at each time step. Filters in this category have the additional capability to inspect and make use of or even modify the temporal dimension.
 
 
 
* '''Alphabetical''' - Many filters do not fit into the above categories so all filters can be found here.
 
 
 
 
 
<center>[[File:ParaView_UsersGuide_FilterMenu.png||link=]]</center>
 
 
 
<center>'''Figure 11. A portion of the Alphabetical submenu of the Filters menu.'''</center>
 
 
 
 
 
Searching through these lists of filters, particularly the full alphabetical list, can be cumbersome. To speed up the selection of filters, you should use the quick launch dialog. Choose the first item from the filters menu, or alternatively press either '''CTRL''' and '''SPACE BAR''' (Windows or Linux) or '''ALT''' and '''SPACE BAR''' (on Macintosh) together to bring up the '''Quick Launch''' dialog. As you type in words or word fragments the dialog lists the filters whose names contain them. Use the up and down arrow key to select from among them and hit '''ENTER''' to create the filter.
 
 
 
 
 
<center>[[File:ParaView_UsersGuide_QuickLaunchDialog.png|200px|link=]]</center>
 
 
 
<center>'''Figure 12. Quick Launch'''</center>
 
 
 
 
 
'''Why can't I apply the filter I want?'''
 
 
 
Note that many of the filters in the menu will be grayed out and not selectable at any given time. That is because any given filter may only operate on particular types of data. For example the Extract Subset will only operate on structured data sets so it is only enabled when the module you are building on top of produces image data, rectilinear grid data, or structured grid data. Likewise the contour filter requires scalar data and can not operate directly on data sets that have only vectors. The input restrictions for all filters are listed in the [[ParaViewUsersGuide/List_of_filters| Appendix]] and help menus.
 
 
 
When the filter you want is not available you should look for a similar filter which will accept your data or apply an intermediate filter which transforms your data into the required format. Since ParaView 3.10 you can also ask ParaView to try to do the conversion for you automatically by clicking "Auto convert Properties" in the application [[ParaView/Users_Guide/Settings | settings]].
 
 
 
== What does that filter do? ==
 
 
 
A description of what each filter does, what input data types it accepts and what output data types it produces can be found in the [ParaViewUsersGuide/List_of_filters|Appendix] and help menus. For a more complete understanding, remember that most ParaView filters are simply VTK algorithms, each of which is documented online in the VTK (http://www.vtk.org/doc/release/5.6/html/classes.html) and ParaView (http://www.paraview.org/ParaView3/Doc/Nightly/html/classes.html) Doxygen wiki pages.
 
 
 
 
 
When one is exploring a given data set, one does not want to have to hunt through the detailed descriptions of all of the filters in order to find the one filter that is needed at any given moment. It is useful then to be aware of the general high-level taxonomy of the different operations that the filters can be logically grouped into.
 
 
 
These are:
 
<!-- TODO these lists should be expanded and improved and each filter listsed should have a short explanations or at least a links to its entry in the appendix. -->
 
* Attribute Manipulation : which manipulate the field aligned, point aligned and cell aligned data values and in general derive new aligned quantities.
 
 
 
<!-- TODO could have separate categories for quantities derived from geometry, topology like normals, mesh quality, elevation. -->
 
Including '''Curvature''', '''Elevation''', '''Generate Ids''', '''Generate Surface Normals''', '''Gradient''', '''Mesh Quality''', '''Principal Component Analysis''', and '''Random Vectors'''.
 
 
 
* Geometric Manipulation : which essentially operate on or manipulate the shape of the data in a spatial context.
 
 
 
<!-- TODO separate category for decimation, refinement -->
 
Including  '''Reflect''', '''Transform''', and '''Warp'''
 
 
 
* Topological operations : which manipulate the connected structure of the data set itself, usually creating or destroying cells, for instance to reduce the data sets memory size while leaving it in the same place in space.
 
 
 
Including '''Cell Centers''', '''Clean''', '''Decimate''', '''Extract Surface''', '''Quadric Clustering''', '''Shrink''',  '''Smooth''', and '''Tetrahedralize'''.
 
 
 
* Sampling : which compute new data sets that represent some essential features from the data sets that they take as input.
 
 
 
Including '''Clip''' , '''Extract Subset''', '''Extract Selection''', '''Glyph''', '''Streamline''', '''Probe''', '''Plot''', '''Histogram''', and '''Slice'''
 
 
 
* Data Type Conversion : which covert between the various VTK data structures [[ParaView/Users Guide/VTK Data Model| VTK Data Model]] and join or split entire data structures
 
 
 
Including '''Append DataSets''','''Append Geometry''', '''Extract Blocks''', '''Extract AMR Blocks""", and  '''Group DataSets'''
 
 
 
* White Box Filters : which do arbitrary processing as specified at runtime by you the user
 
 
 
Including the '''calculator''' and '''python programmable''' filters.
 

Latest revision as of 14:37, 14 January 2015

PAGE DELETED
The Users Guide has been moved from the Wiki to The ParaView Guide. Please use the history if you want to access the old version of this document.