ParaView/Custom Filters: Difference between revisions
Daviddoria (talk | contribs) m (first paragraph wording) |
Daviddoria (talk | contribs) m (→Surface Streamlines: shitf -> shift) |
||
Line 25: | Line 25: | ||
{| border="1" | {| border="1" | ||
| 1 | | 1 | ||
| | | To create a custom filter, first select the sub-pipline in the pipeline browser. One can use Ctrl or Shift keys for multiple selection. With the pipeline selected, open the '''Create Custom Filter''' wizard accessible through the '''Tools''' menu. | ||
| [[Image:CustomFilterPipelineBrowser.png|200px]] | | [[Image:CustomFilterPipelineBrowser.png|200px]] | ||
|- | |- |
Revision as of 17:59, 1 November 2009
ParaView is a pipeline-based framework: the user loads in data and then applies one or more filters forming a pipeline. The pipeline can further process, render, or save the result. Users often find themselves applying the same set of filters with some minor parameter tweaks for a few filters in the pipeline to different datasets. With what we call custom filters, it is possible for the user to combine the pipeline into a single filter while exposing a set a properties from the internal filters that need tweaking. Additionally, the user can then share his custom filter's with other users.
This document describes how to create and use custom filters.
Surface Streamlines
One very commonly asked question on the mailing list is how to create surface streamlines. The pipeline for that looks like this:
In this example we'll create a new filter to create surface streamlines. As a first step, we set up the pipeline in ParaView. The image below shows the pipeline browser for the pipeline. Here the vector field source is "Slice1". One custom filter is going comprise of the sub-pipeline after "Slice1" which has been highlighted in following image.
On success the Custom Filter Manager will popup showing the newly created filter. Close this dialog. Now, if you look under the Filters|Alphabetical menu, you'll see the SurfaceStreamlines filter. It can now be used just like any other filter. Following image shows our custom filter applied to a vector field input.
Managing Custom Filters
The Custom Filter Manager, accessible through Tools | Manage Custom Filters menu option, can be used to remove/import/export custom filters. Exporting allows users to share custom filter definitions. Such exported definitions can be imported this manager. Custom filters need to be imported only once. Once imported, they get saved with other ParaView settings and hence are preserved across sessions. When saving state files involving custom filters, the custom filter definition gets saved in the state file, hence the state can be loaded on by any user even if he doesn't have the custom filter definition.