paraview.simple.ProgrammableFilter

paraview.simple.ProgrammableFilter(*input, **params)

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 a python Interpreter to run the script upon the first execution. 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.

Data Descriptors

CopyArrays

If this property is set to true, all the cell and point arrays from first input are copied to the output.

Input

This property specifies the input(s) to the programmable filter.

OutputDataSetType

The value of this property determines the dataset type for the output of the programmable filter.

PythonPath

A semi-colon (;) separated list of directories to add to the python library search path.

RequestInformationScript

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.

RequestUpdateExtentScript

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.

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.

TimestepValues

Available timestep values.

Data Descriptors inherited from Proxy

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Methods

Initialize = aInitialize(self, connection=None, update=True)

Methods inherited from SourceProxy

FileNameChanged(self)

Called when the filename of a source proxy is changed.

GetCellDataInformation(self)

Returns the associated cell data information.

GetDataInformation(self, idx=None)

This method returns a DataInformation wrapper around a vtkPVDataInformation

GetFieldDataInformation(self)

Returns the associated cell data information.

GetPointDataInformation(self)

Returns the associated point data information.

UpdatePipeline(self, time=None)

This method updates the server-side VTK pipeline and the associated data information. Make sure to update a source to validate the output meta-data.

UpdatePipelineInformation(self)

This method updates the meta-data of the server-side VTK pipeline and the associated information properties

__getitem__(self, idx)

Given a slice, int or string, returns the corresponding output port

Methods inherited from Proxy

GetProperty(self, name)

Given a property name, returns the property object.

GetPropertyValue(self, name)

Returns a scalar for properties with 1 elements, the property itself for vectors.

InitializeFromProxy(self, aProxy, update=True)

Constructor. Assigns proxy to self.SMProxy, updates the server object as well as register the proxy in _pyproxies dictionary.

ListProperties(self)

Returns a list of all property names on this proxy.

SetPropertyWithName(self, pname, arg)

Generic method for setting the value of a property.

__del__(self)

Destructor. Cleans up all observers as well as remove the proxy from the _pyproxies dictionary

__eq__(self, other)

Returns true if the underlying SMProxies are the same.

__getattr__(self, name)

With the exception of a few overloaded methods, returns the SMProxy method

__hash__(self)

Return hash(self).

__init__(self, **args)

Default constructor. It can be used to initialize properties by passing keyword arguments where the key is the name of the property. In addition registrationGroup and registrationName (optional) can be specified (as keyword arguments) to automatically register the proxy with the proxy manager.

__iter__(self)

Creates an iterator for the properties.

__ne__(self, other)

Returns false if the underlying SMProxies are the same.

__setattr__(self, name, value)

Implement setattr(self, name, value).

add_attribute(self, name, value)

For the full list of servermanager proxies, please refer to Available readers, sources, writers, filters and animation cues