paraview.simple.GradientOfUnstructuredDataSet

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

The Gradient (Unstructured) filter estimates the gradient vector at each point or cell. It operates on any type of vtkDataSet, and the output is the same type as the input. If the dataset is a vtkImageData, use the Gradient filter instead; it will be more efficient for this type of dataset.

Data Descriptors

ComputeDivergence

When this flag is on, the gradient filter will compute the divergence of a three-component array.

ComputeGradient

When this flag is on, the gradient filter will compute the gradient of the input array.

ComputeQCriterion

When this flag is on, the gradient filter will compute the Q-criterion of a three-component array.

ComputeVorticity

When this flag is on, the gradient filter will compute the vorticity/curl of a three-component array.

ContributingCellOption

Specify which dimensions of cells should be used when computing gradient quantities. Default is to use the dataset’s maximum cell dimension.

DivergenceArrayName

This property provides a name for the output array containing the divergence vector.

FasterApproximation

When this flag is on, the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data or when the input grid is not a vtkUnstructuredGrid.

Input

This property specifies the input to the Gradient (Unstructured) filter.

QCriterionArrayName

This property provides a name for the output array containing Q-criterion.

ReplacementValueOption

Specify what value to use for when the gradient quantities at a point can’t be computed with the selected **ContributingCellOption**.

ResultArrayName

This property provides a name for the output array containing the gradient vectors.

ScalarArray

This property lists the name of the scalar array from which to compute the gradient.

VorticityArrayName

This property provides a name for the output array containing the vorticity vector.

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