Skip to article

 

Programmable Filter

Executes a user supplied python script on its input dataset to produce an output dataset.

This filter will execute a python script to produce an output dataset. The filter keeps a copy of the python script in Script, and creates Interpretor, a python interpretor to run the script upon the first execution. To execute external python scripts on the FidesysViewer server, use: execfile('full_path/script_name.py'). Documentation is found in the Programmable Filter chapter of the ParaView Guide.

Property Description Default(s) Restrictions
Input This property specifies the input(s) to the programmable filter.  

Accepts input of following types:

  • vtkDataObject
  • vtkHyperTreeGrid
OutputDataSetType The value of this property determines the dataset type for the output of the programmable filter. 8

The value(s) is an enumeration of the following:

  • Same as Input (8)
  • vtkPolyData (0)
  • vtkStructuredGrid (2)
  • vtkRectilinearGrid (3)
  • vtkUnstructuredGrid (4)
  • vtkImageData (6)
  • vtkUniformGrid (10)
  • vtkMultiblockDataSet (13)
  • vtkHierarchicalBoxDataSet (15)
  • vtkHyperTreeGrid (32)
  • vtkTable (19)
  • vtkMolecule (33)
Script This property contains the text of a python program that the programmable filter runs. To execute external python scripts on the ParaView server, use: execfile('full_path/script_name.py'). Documentation is found in the Programmable Filter chapter of the ParaView Guide.    
RequestInformation Script This property is a python script that is executed during the RequestInformation pipeline pass. Use this to provide information such as WHOLE_EXTENT to the pipeline downstream.    
RequestUpdateExtent Script This property is a python script that is executed during the RequestUpdateExtent pipeline pass. Use this to modify the update extent that your filter ask up stream for.    
CopyArrays If this property is set to true, all the cell and point arrays from first input are copied to the output. 0

Accepts boolean values (0 or 1).
Parameters      
PythonPath A semi-colon (;) separated list of directories to add to the python library search path.    
TimestepValues Available timestep values.