paraview.simple.PlotOverLine

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

The Plot Over Line filter samples the dataset attributes of the

input dataset at the points of a given line. The values of the point-centered variables along that line will be displayed in an XY Plot. This filter uses interpolation to determine the values at the selected point, whether or not it lies at an input point. This filter operates on any type of data and produces a polygonal output (a polyline). One can use different sampling patterns with this filter. “Sample At Cell Boundaries” gives the most accurate plots, “Sample At Segment Centers” provides one sample per probed cell, and “Sample Uniformally” samples uniformally along the input line.

Data Descriptors

ComputeTolerance

Set whether to compute the tolerance or to use a user provided value.

Input

This property specifies the dataset from which to obtain probe values.

PassCellArrays

When set the input cell data arrays are shallow copied to the output.

PassFieldArrays

Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output.

PassPartialArrays

When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial arrays are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, and 0 for all other types of arrays i.e int, char etc.

PassPointArrays

When set the input point data arrays are shallow copied to the output.

Point1

This property controls the coordinates of the first endpoint of the line.

Point2

This property controls the coordinates of the second endpoint of the line.

Resolution

This property sets the line resolution if sampling pattern is set to “Sample Uniformly”.

SamplingPattern

“Sample At Cell Boundaries” gives the most accurate plots by creating probing points at the cell borders. “Sample At Segment Centers” provides one sample per probed cell located at the middle of the line intersecting the cell. “Sample Uniformally” samples uniformally along the input line.

Tolerance

Set the tolerance to use for vtkDataSet::FindCell

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