|(16 intermediate revisions by 2 users not shown)|
== Introduction ==
The Programmable Filter is a ParaView filter that processes one or more input datasets based on a Python script provided by the user. The parameters of the filter include the output data type, the script and a toggle that controls whether the input arrays are copied to the output. In this document, we introduce the use of the Programmable Filter and give a summary of the API available to the user.
Note that the Programmable Filter depends on Python. All ParaView binaries distributed by Kitware are built with Python enabled. If you have built ParaView yourself, you have to make sure that PARAVIEW_ENABLE_PYTHON is turned on when configuring the ParaView build.
Since the entire VTK API as well as any module that can be imported through Python is available through this filter, we can only skim the surface of what can be accomplished with this filter here. If you are not familiar with Python, we recommend first taking a look at one of the introductory guides such as the [http://docs.python.org/tutorial/ official Python Tutorial]. Also, if you are going to do any programming beyond the very basic stuff, we recommend reading up on the VTK API. [http:// www.vtk.org The VTK website] has links to VTK books and online documentation. For reference, you may need to look at the [http://www.vtk.org/doc/release/5.6/html/ VTK class documentation]. There is also more information about the Programmable Filter and some good recipes on the ParaView Wiki ([[Python_Programmable_Filter]]).