paraview.simple.GlyphWithCustomSource

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

The Glyph With Custom Source filter generates a glyph specified as the Source input to this filter at each point in the input dataset. The glyphs can be oriented and scaled by the input scalar and vector arrays. If the arrays are point-centered, glyphs are placed at points in the input dataset. If the arrays are cell-centered, glyphs are placed at the center of cells in the input dataset. A transform that applies to the glyph source can be modified to change the shape of the glyph. This filter operates on any type of data set. Its output is a polygonal dataset.

To use this filter, select the Orientation Array to orient the glyphs and the Scale Array to control glyph scaling if desired - each array can be set to ‘No array’ if orientation or scaling is not desired. When scaling by a 3-element vector array, the Vector Scale Mode can be set to either ‘Scale by Magnitude’, which scales glyphs according to the vector magnitude, or ‘Scale by Components’, which treats each component as a separate scaling factor in the corresponding dimension, i.e., the first component is the scaling factor in the x-dimension, the second component scales the y-dimension, and the third component scales the z-dimension. An overall constant Scale Factor is applied following the scaling controlled by other properties of this filter.

The Glyph Mode property controls which points in the input dataset are selected for glyphing since in most cases, glyphing all points in the input dataset can be both performance impeding as well as visually cluttered.

Data Descriptors

GlyphMode

This property indicates the mode that will be used to generate glyphs from the dataset.

GlyphSource

This property determines which glyph will be placed at the points in the input dataset.

GlyphTransform

The values in this property allow you to specify the transform (translation, rotation, and scaling) to apply to the glyph source.

Input

This property specifies the input to this filter. This is the dataset from which the locations are selected to be glyphed.

MaximumNumberOfSamplePoints

This property specifies the maximum number of sample points to use when sampling the space when Uniform Spatial Distribution is used.

OrientationArray

Select the input array to use for orienting the glyphs.

ScaleArray

Select the input array to be used for scaling the glyphs. If the scale array is a vector array, you can control how the glyphs are scaled with the **Vector Scale Mode** property.

ScaleFactor

Specify the constant multiplier to use to scale the glyphs.

Seed

This property specifies the seed that will be used for generating a uniform distribution of glyph points when a Uniform Spatial Distribution is used.

Stride

This property specifies the stride that will be used when glyphing by Every Nth Point.

VectorScaleMode

Select the mode when the scaling array is a vector. **Scale by Magnitude** scales the glyph by the vector magnitude. **Scale by Components** scales glyphs by each vector component in the dimension that component represents, e.g., the x-direction is scaled by component 0, the y-direction is scaled by component 1, and so on.

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