paraview.simple.PythonAnnotation

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

This filter uses Python to calculate an expression and display the result as an annotation in the render view. It depends heavily on the numpy and paraview.vtk modules. To use the parallel functions, mpi4py is also necessary. The expression is evaluated and the resulting scalar value or numpy array is added to the output as an array. See numpy integration, python annotation and python calculator documentation for the list of available functions. This filter tries to make it easy for the user to write expressions by defining certain variables. The filter tries to assign each array to a variable of the same name. If the name of the array is not a valid Python variable, it may be accessed through a variable with a sanitized version of that array name consisting of only ‘_’ and the alphanumeric characters in the name joined together with no spaces. Point coordinates from datasets that explicitly define them can be accessed using the variable named ‘points’.

Data Descriptors

ArrayAssociation

Select the attribute to use to populate array names.

Expression

The Python expression evaluated during execution. FieldData arrays are directly available through their name. Set of potentially available variables [inputs, points, t_value, t_steps, t_range, t_index, FieldData, PointData, CellData] (i.e.: “Momentum: (%f, %f, %f)” % (XMOM[t_index,0], YMOM[t_index,0], ZMOM[t_index,0]) ) Additional variables, using the fmt library’s syntax, are {timevalue}, {timerange}, {timesteps} and {timeindex}. These variables are always available, and their default values are 0, [], [] and 0 respectively.

Input

Set the input of the filter.

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