simple.__init__ Module

For generated server-side proxies, please refer to Available readers, sources, writers, filters and animation cues

simple is a module for using paraview server manager in Python. It provides a simple convenience layer to functionality provided by the C++ classes wrapped to Python as well as the servermanager module.

A simple example:

.. code:: python

from paraview.simple import *

# Create a new sphere proxy on the active connection and register it # in the sources group. sphere = Sphere(ThetaResolution=16, PhiResolution=32)

# Apply a shrink filter shrink = Shrink(sphere)

# Turn the visibility of the shrink object on. Show(shrink)

# Render the scene Render()

Scripts generated by ParaView’s Python Tracing, Python state saving, and Catalyst saving use functions in this module.

paraview.simple.__init__.AddCameraLink(viewProxy, viewProxyOther, linkName='')

Create a named camera link between two view proxies. If a link with the given name already exists it will be removed first and replaced with the newly created link.

Parameters:

• viewProxy (View proxy.) – The first view to link.

• viewProxyOther (View proxy.) – The second view to link.

• linkName (str) – The name of the link to create. Optional, defaults to automatically generating a link name.

Returns:

The link registration name.

Return type:

str

paraview.simple.__init__.AddFieldArrays(*input, **params)

AddFieldArrays is a deprecated proxy. It will be automatically replaced by FieldArraysFromFile

paraview.simple.__init__.AddLight(view=None)

Makes a new light and adds it to the designated or active view.

Parameters:

view – The view to add the light to. Optional, defaults to the active view.

Returns:

The new light

Return type:

paraview.servermanager.Light

paraview.simple.__init__.AddProxyLink(proxy1, proxy2, linkName='', link=None)

Create a link between two proxies and return its name.

An instance of a vtkSMProxyLink subclass can be given, otherwise a vtkSMProxyLink is created. This does not link proxy properties. See vtkSMProxyLink.LinkProxyPropertyProxies.

Parameters:

linkName (str) – Name of link to create. If empty, a default one is created for registration. If a link with the given name already exists it will be removed first.

Returns:

The link registration name.

Return type:

str

paraview.simple.__init__.AddRenderViewLink(viewProxy, viewProxyOther, linkName='', linkCameras=False)

Create a named view link between two render view proxies.

It also creates links for the AxesGrid proxy property in each view. By default, cameras are not linked.

If a link with the given name already exists it will be removed first and replaced with the newly created link.

Parameters:

• viewProxy (View proxy.) – The first view to link.

• viewProxyOther (View proxy.) – The second view to link.

• linkName (str) – The name of the link to create.

• linkCameras – If True, also link the view cameras.

Returns:

The link registration name.

Return type:

str

paraview.simple.__init__.AddSelectionLink(objProxy, objProxyOther, linkName, convertToIndices=True)

Create a named selection link between two source proxies. If a link with the given name already exists it will be removed first and repaced with the newly created link.

Parameters:

• objProxy (Source proxy) – First proxy to link.

• objProxyOther (Source proxy) – Second proxy to link. If None, uses the active source.

• linkName (str) – Name of the created link.

• convertToIndices (bool) – When True (default value), the input selection will always be converted into an indices-based selection before being applied to outputs.

paraview.simple.__init__.AddViewLink(viewProxy, viewProxyOther, linkName='')

Create a view link between two view proxies.

A view link is an extension of a proxy link that also performs rendering when a property changes.

Cameras in the views are not linked.

If a link with the given name already exists it will be removed first and replaced with the newly created link.

Parameters:

• viewProxy (View proxy.) – The first view to link.

• viewProxyOther (View proxy.) – The second view to link.

• linkName (str) – The name of the link to create. Optional, defaults to automatically generating a link name.

Returns:

The link registration name.

Return type:

str

paraview.simple.__init__.AnimateReader(reader=None, view=None)

This is a utility function that, given a reader and a view animates over all time steps of the reader.

Parameters:

• reader (reader proxy) – The reader source to iterate over. Optional, defaults to the active source.

• view (view proxy) – The view to animate. Optional, defaults to the active view.

Returns:

A new animation scene used to play the animation.

Return type:

paraview.simple.AnimationSceneProxy

paraview.simple.__init__.AppendArcLength(*input, **params)

AppendArcLength is a deprecated proxy. It will be automatically replaced by PolylineLength

paraview.simple.__init__.AppendLocationAttributes(*input, **params)

AppendLocationAttributes is a deprecated proxy. It will be automatically replaced by Coordinates

paraview.simple.__init__.AssignFieldToColorPreset(array_name, preset_name, range_override=None)

Assign a lookup table to an array by lookup table name.

Example usage:

AssignFieldToPreset("Temperature", "Cool to Warm")

Parameters:

• array_name (str) – The array name for which we want to bind a given color preset.

• preset_name (str) – The name for the color preset.

• range_override (2-element tuple or list of floats) – The range to use instead of the range of the array.

Returns:

True on success, False otherwise.

Return type:

bool

paraview.simple.__init__.AssignLookupTable(arrayInfo, lutName, rangeOveride=[])

Assign a lookup table to an array by lookup table name.

Example usage:

track = GetAnimationTrack("Center", 0, sphere) or
arrayInfo = source.PointData["Temperature"]
AssignLookupTable(arrayInfo, "Cool to Warm")

Parameters:

• arrayInfo (paraview.modules.vtkRemotingCore.vtkPVArrayInformation) – The information object for the array. The array name and its range is determined using the info object provided.

• lutName (str) – The name for the transfer function preset.

• rangeOveride (2-element tuple or list of floats) – The range to use instead of the range of the array determined using the arrayInfo parameter. Defaults to [], meaning the array info range will be used.

Returns:

True on success, False otherwise.

Return type:

bool

paraview.simple.__init__.AssignViewToLayout(view=None, layout=None, hint=0)

Assigns the view provided to the layout provided. If no layout exists, then a new layout will be created.

It is an error to assign the same view to multiple layouts.

Parameters:

• view (View proxy.) – The view to assign to the layout. Optional, defaults to the active view.

• layout (Layout proxy.) – If layout is None, then either the active layout or an existing layout on the same server will be used.

Returns:

Returns True on success.

Return type:

bool

paraview.simple.__init__.BlockScalars(*input, **params)

BlockScalars is a deprecated proxy. It will be automatically replaced by BlockIds

paraview.simple.__init__.ClearSelection(proxy=None)

Clears the selection on the active source.

Parameters:

proxy (Source proxy) – Source proxy whose selection should be cleared.

paraview.simple.__init__.ColorBlocksBy(rep=None, selectors=None, value=None, separate=False)

Like ColorBy(), set data array by which to color selected blocks within a representation, but color only selected blocks with the specified properties. This will automatically set up the color maps and others necessary state for the representations.

Parameters:

• rep (Representation proxy) – Must be a representation proxy i.e. the value returned by the GetRepresentation(). Optional, defaults to the display properties for the active source, if possible.

• selectors (list of str) – List of block selectors that choose which blocks to modify with this call.

• value (str) – Name of the array to color by.

• separate (bool) – Set to True to create a color map unique to this representation. Optional, default is that the color map used will be the global color map ParaView uses for any object colored by an array of the same name.

paraview.simple.__init__.ColorBy(rep=None, value=None, separate=False)

Set data array to color a representation by. This will automatically set up the color maps and others necessary state for the representations.

Parameters:

• rep (Representation proxy) – Must be a representation proxy i.e. the value returned by the GetRepresentation(). Optional, defaults to the display properties for the active source, if possible.

• value (str) – Name of the array to color by.

• separate (bool) – Set to True to create a color map unique to this representation. Optional, defaults to the global color map ParaView uses for any object colored by an array of the same name.

paraview.simple.__init__.ComputeConnectedSurfaceProperties(*input, **params)

ComputeConnectedSurfaceProperties is a deprecated proxy. It will be automatically replaced by ConnectedSurfaceProperties

paraview.simple.__init__.Connect(ds_host=None, ds_port=11111, rs_host=None, rs_port=11111, timeout=60, ns=None)

Creates a connection to a server.

Parameters:

• ds_host (string) – Data server hostname. Needed to set up a client/data server/render server connection.

• ds_port (int) – Data server port to listen on.

• rs_host (string) – Render server hostname. Needed to set up a client/data server/render server connection.

• rs_port (int) – Render server port to listen on.

• timeout (int) – Time in seconds at which the connection is abandoned if not made.

Example usage connecting to a host named “amber”:

Connect("amber") # Connect to a single server at default port
Connect("amber", 12345) # Connect to a single server at port 12345
Connect("amber", 11111, "vis_cluster", 11111) # connect to data server, render server pair
Connect("amber", timeout=30) # Connect to a single server at default port with a 30s timeout instead of default 60s
Connect("amber", timeout=-1) # Connect to a single server at default port with no timeout instead of default 60s
Connect("amber", timeout=0)  # Connect to a single server at default port without retrying instead of retrying for
the default 60s

paraview.simple.__init__.Create2DRenderView(**params)

Create the standard 3D render view with the 2D interaction mode turned on. See CreateView() for argument documentation

paraview.simple.__init__.CreateBarChartView(**params)

Create Bar Chart view. See CreateView() for argument documentation

paraview.simple.__init__.CreateComparativeBarChartView(**params)

Create comparative Bar Chart view. See CreateView() for argument documentation

paraview.simple.__init__.CreateComparativeRenderView(**params)

Create Comparative view. See CreateView() for argument documentation

paraview.simple.__init__.CreateComparativeXYPlotView(**params)

Create comparative XY plot Chart view. See CreateView() for argument documentation

paraview.simple.__init__.CreateExtractor(name, proxy=None, registrationName=None)

Creates a new extractor and returns it.

Parameters:

• name (str, optional) – The type of the extractor to create.

• proxy (paraview.servermanager.Proxy, optional) – The proxy to generate the extract from. If not specified the active source is used.

• registrationName – The registration name to use to register the extractor with the ProxyManager. If not specified a unique name will be generated.

Returns:

The extractor created, on success, else None

Return type:

paraview.servermanager.Proxy or None

paraview.simple.__init__.CreateLayout(name=None)

Create a new layout with no active view.

Parameters:

name – The name of the layout. Optional, defaults to an automatically created name.

paraview.simple.__init__.CreateLight()

Makes a new light and returns it, unattached to a view.

Returns:

The new light

Return type:

paraview.servermanager.Light

paraview.simple.__init__.CreateLookupTable(**params)

Create and return a lookup table.

Parameters:

params – A variadic list of key=value pairs giving values of specific named properties of the lookup table.

Returns:

Lookup table

Return type:

Lookup table proxy

paraview.simple.__init__.CreateParallelCoordinatesChartView(**params)

Create Parallel Coordinates Chart view. See CreateView() for argument documentation

paraview.simple.__init__.CreatePiecewiseFunction(**params)

Create and return a piecewise function.

Parameters:

params – A variadic list of key=value pairs giving values of specific named properties of the opacity function.

Returns:

Piecewise opacity function

Return type:

Opacity functon proxy

paraview.simple.__init__.CreateRenderView(**params)

Create standard 3D render view. See CreateView() for argument documentation

paraview.simple.__init__.CreateSelection(proxyname, registrationname, groupname='selection_sources', **args)

Make a new selection source proxy. Can be either vtkSelection or vtkAppendSelection. Use this so that selection don’t show up in the pipeline.

paraview.simple.__init__.CreateSteerableParameters(steerable_proxy_type_name, steerable_proxy_registration_name='SteeringParameters', result_mesh_name='steerable')

Creates a steerable proxy for Catalyst use cases.

Parameters:

• steerable_proxy_type_name (str) – Name of the proxy type to create.

• steerable_proxy_registration_name (str) – Registration name of the proxy created by this function. If not provided, defaults to “SteeringParameters”.

• result_mesh_name (str) – The name of the resulting mesh. If not provided, defaults to “steerable”.

Returns:

Proxy of the specified type.

Return type:

Steerable proxy.

paraview.simple.__init__.CreateTexture(filename=None, trivial_producer_key=None, proxyname=None)

Creates and returns a new ImageTexture proxy. The texture is not attached to anything by default but it can be applied to things, for example the view, like so:

GetActiveView().UseTexturedBackground = 1 GetActiveView().BackgroundTexture = CreateTexture(“foo.png”)

Parameters:

• filename (str) – The name of the image file to load as a texture. It can be None, in which case the texture is read from a trivial producer identified by the trivial_producer_key

• trivial_producer_key (str) – Identifier of the texture image source on the server. This is mainly used by scene importers when filename is None.

• proxyname (str) – The name for the texture when it is registered in ParaView.

Returns:

The newly created texture.

Return type:

Image texture proxy.

paraview.simple.__init__.CreateView(view_xml_name, **params)

Creates and returns the specified proxy view based on its name/label. Also set params keywords arguments as view properties.

Parameters:

• view_xml_name – Name of the requested View as it appears in the proxy definition XML. Examples include RenderView, ImageChartView, SpreadSheetView, etc.

• params – Dictionary created from named arguments. If one of these arguments is named ‘registrationName’, the string value associated with it will be used as the name of the proxy. That name will appear in the Pipeline Browser of the ParaView GUI, and it is the name to be passed to the FindView() function to find this view. Any additional named arguments will be passed as properties to initialize the view.

Returns:

The created view Python object.

Return type:

paraview.simple.__init__.CreateWriter(filename, proxy=None, **extraArgs)

Creates a writer that can write the data produced by the source proxy in the given file format (identified by the extension). This function doesn’t actually write the data, it simply creates the writer and returns it

Parameters:

• filename (str) – The name of the output data file.

• proxy (Source proxy.) – Source proxy whose output should be written. Optional, defaults to the creating a writer for the active source.

• extraArgs (A variadic list of key=value pairs giving values of specific named properties in the writer.) – Additional arguments that should be passed to the writer proxy.

paraview.simple.__init__.CreateXYPlotView(**params)

Create XY plot Chart view. See CreateView() for argument documentation

paraview.simple.__init__.CreateXYPointPlotView(**params)

Create XY plot point Chart view. See CreateView() for argument documentation

paraview.simple.__init__.Delete(proxy=None)

Deletes the given pipeline source or the active source if no argument is specified.

Parameters:

proxy (Source proxy. Optional, defaults to deleting the active source.) – the proxy to remove

paraview.simple.__init__.Disconnect(ns=None, force=True)

Disconnect from the currently connected server and free the active session. Does not shut down the client application where the call is executed.

Parameters:

• ns (Dict or None) – Namespace in which ParaView functions were created. Optional, defaults to the namespace returned by globals()

• force (bool) – Force disconnection in a simultaneous connection. Optional, defaults to forcing disconnection.

paraview.simple.__init__.EqualizeViewsBoth(layout=None)

Equalizes the vertical and horizontal view sizes in the provided layout.

Parameters:

layout (Layout proxy.) – Layout the layout contain the views to equalize. Optional, defaults to the active layout.

paraview.simple.__init__.EqualizeViewsHorizontally(layout=None)

Equalizes horizontal view sizes in the provided layout.

Parameters:

layout (Layout proxy.) – Layout the layout contain the views to equalize. Optional, defaults to the active layout.

paraview.simple.__init__.EqualizeViewsVertically(layout=None)

Equalizes vertical view sizes in the provided layout.

Parameters:

layout (Layout proxy.) – Layout the layout contain the views to equalize. Optional, defaults to the active layout.

paraview.simple.__init__.ExportTransferFunction(colortransferfunction, opacitytransferfunction, tfname, filename, location=16)

Export transfer function to a file. The file will be saved in the new JSON format.

Parameters:

• colortransferfunction (Color transfer function proxy.) – The color transfer function to export.

• opacitytransferfunction (Opacity transfer function proxy.) – The opacity transfer functon to export, if provided. can be None.

• tfname (str) – The name that will be given to the transfer function preset if imported back into ParaView.

• filename (str) – Path to file where exported transfer function should be saved.

• location (vtkPVServer.ServerFlags enum value) – Where the statefile should be saved, e.g., pass vtkPVSession.CLIENT if the statefile is located on the client system (default value), pass in vtkPVSession.SERVERS if on the server. Optional, defaults to vtkPVSession.CLIENT.

Returns:

True on success, False otherwise.

paraview.simple.__init__.ExportView(filename, view=None, **params)

Export a view to the specified output file. Based on the view and file extension, an exporter of the right type will be chosen to export the view.

Parameters:

• filename (str) – Name of the exported file.

• view (View proxy.) – The view proxy to export. Optional, defaults to the active view.

• params – A variadic list of key=value pairs giving values of specific named properties of the exporter.

paraview.simple.__init__.ExtendFileSeries(proxy=None)

For a reader proxy that supports reading files series, detect any new files added to the series and update the reader’s filename property.

Parameters:

proxy – Reader proxy that should check for a extended file series. Optional, defaults to extending file series in the active source.

Returns:

True if the operation succeeded, False otherwise

Return type:

bool

paraview.simple.__init__.FetchData(proxy=None, **kwargs)

Fetches data from the specified data producer for processing locally. Use this function with caution since this can cause large amounts of data to be gathered and delivered to the client.

If no producer is specified, the active source is used.

Basic Usage

#to fetch data from port 0

dataMap = FetchData(producer)

# to fetch data from a specific port

dataMap = FetchData(OutputPort(producer, 1))

FetchData() does not explicitly update the pipeline. It is expected that the pipeline is already updated. This will simply deliver the current data.

Returns a map where the key is an integer representing a rank and value is the dataset fetched from that rank.

Keyword Parameters

The following keyword parameters can be used to customize the fetchs.

GatherOnAllRanks (bool/int, optional):

This is used only in symmetric batch (or ParaView-Catalyst) mode. If True, then FetchData() will gather the data on all ranks. Default is to only gather the data on the root node.

SourceRanks (list(int), optional):

List of ints to specity explicitly the ranks from which to fetch data. By default, data from all ranks is fetched.

paraview.simple.__init__.FindExtractor(registrationName)

Returns an extractor with a specific registrationName.

Parameters:

registrationName (str) – Registration name for the extractor.

Returns:

The extractor or None

Return type:

paraview.servermanager.Proxy or None

paraview.simple.__init__.FindSource(name)

Return a pipeline source based on the name that was used to register it with ParaView.

Example usage:

Cone(guiName='MySuperCone')
Show()
Render()
myCone = FindSource('MySuperCone')

Parameters:

name (str) – The name that the pipeline source was registered with during creation or after renaming.

Returns:

The pipeline source if found.

Return type:

Pipeline source proxy.

paraview.simple.__init__.FindTextureOrCreate(registrationName, filename=None, trivial_producer_key=None)

Finds or creates a new ImageTexture proxy.

Parameters:

• registrationName (str) – The name for the texture when it is registered in ParaView.

• filename (str) – Path to the texture image source file. Optional, if not provided, the trivial_producer_key should be provided to tell which image source to use for the texture.

• trivial_producer_key (str) – Identifier of the texture image source on the server. This is mainly used by scene importers when filename is None.

paraview.simple.__init__.FindView(name)

Return a view proxy based on the name that was used to register it with ParaView.

Example usage:

CreateRenderView(guiName='RenderView1')
myView = FindSource('RenderView1')

Parameters:

name (str) – The name that the view was registered with during creation or after renaming.

Returns:

The view if found.

Return type:

View proxy.

paraview.simple.__init__.FindViewOrCreate(name, viewtype)

Returns the view if a view with the given name exists and is of the the given viewtype, otherwise creates a new view of the requested type. Note, if a new view is created, it will be assigned to a layout by calling AssignViewToLayout.

Parameters:

• name (str) – Name of the view to find.

• viewtype (str) – Type of the view to create.

paraview.simple.__init__.GenerateGlobalIds(*input, **params)

GenerateGlobalIds is a deprecated proxy. It will be automatically replaced by GlobalPointAndCellIds

paraview.simple.__init__.GenerateIds(*input, **params)

GenerateIds is a deprecated proxy. It will be automatically replaced by PointAndCellIds

paraview.simple.__init__.GenerateProcessIds(*input, **params)

GenerateProcessIds is a deprecated proxy. It will be automatically replaced by ProcessIds

paraview.simple.__init__.GenerateRGBPoints(preset_name=None, range_min=None, range_max=None)

Create and return a list of RGB points by using the provided arguments. The returned RGB points are intended to be used by transfer functions.

This function is used by Python state files so that they do not have to write out every single RGB point for a transfer function if those RGB points can be easily re-created.

Parameters:

• preset_name (str or None) – A preset name to apply, if any.

• range_min (float or None) – The minimum value for rescaling the RGBPoints range

• range_min – The maximum value for rescaling the RGBPoints range

Returns:

A list of RGBPoints which can be used in transfer functions

Return type:

list[float]

NOTE: this function might be used by old state files. As such, we must not break backward-compatibility with it.

paraview.simple.__init__.GenerateSpatioTemporalHarmonics(*input, **params)

GenerateSpatioTemporalHarmonics is a deprecated proxy. It will be automatically replaced by SpatioTemporalHarmonics

paraview.simple.__init__.GenerateSurfaceNormals(*input, **params)

GenerateSurfaceNormals is a deprecated proxy. It will be automatically replaced by SurfaceNormals

paraview.simple.__init__.GenerateSurfaceTangents(*input, **params)

GenerateSurfaceTangents is a deprecated proxy. It will be automatically replaced by SurfaceTangents

paraview.simple.__init__.GetActiveCamera()

Returns the active camera for the active view.

Returns:

The active camera

Return type:

vtkCamera

paraview.simple.__init__.GetActiveSource()

Returns the active source.

Returns:

Active pipeline source.

Return type:

Source proxy

paraview.simple.__init__.GetActiveView()

Returns the active view.

Returns:

Active view.

Return type:

View proxy.

paraview.simple.__init__.GetActiveViewOrCreate(viewtype)

Returns the active view if the active view is of the given type, otherwise creates a new view of the requested type. Note, if a new view is created, it will be assigned to a layout by calling AssignViewToLayout().

Parameters:

viewtype (str) – The type of view to access if it is the active view or create if it doesn’t exist.

Returns:

The active view if it is of type viewtype.

Return type:

View proxy.

paraview.simple.__init__.GetAllSettings()

Get a list of strings that return valid settings proxy types for the :func:GetSettingsProxy() function.

Returns:

List of valid settings proxy names

Return type:

list of str

paraview.simple.__init__.GetAnimationScene()

Returns the application-wide animation scene. ParaView has only one global animation scene. This method provides access to that. You are free to create additional animation scenes directly, but those scenes won’t be shown in the ParaView GUI.

Returns:

The animation scene

Return type:

paraview.servermanager.AnimationScene

paraview.simple.__init__.GetAnimationTrack(propertyname_or_property, index=None, proxy=None, registrationName=None)

Returns an animation cue for the property. If one doesn’t exist then a new one will be created. Typical usage:

track = GetAnimationTrack("Center", 0, sphere) or
track = GetAnimationTrack(sphere.GetProperty("Radius")) or

# this returns the track to animate visibility of the active source in
# all views.
track = GetAnimationTrack("Visibility")

For animating properties on implicit planes etc., use the following signatures:

track = GetAnimationTrack(slice.SliceType.GetProperty("Origin"), 0) or
track = GetAnimationTrack("Origin", 0, slice.SliceType)

paraview.simple.__init__.GetBlockColorTransferFunction(selector, arrayname, representation=None, separate=False, **params)

Get the color transfer function used to map a data array with the given name to colors in the blocks referred to by a selector expresson.

Parameters:

• selector (str) – Selector expression used to select blocks from whom the color transfer should be retrieved.

• arrayname (str) – Name of the array whose color transfer function is requested.

• representation (Representation proxy.) – Used to modify the array name when using a separate color transfer function. Optional, defaults to the active proxy.

• separate (bool) – If True, used to recover the separate color transfer function even if it is not used currently by the representation. Optional, defaults to False.

Returns:

This may create a new color transfer function if none exists, or return an existing one if found.

Return type:

Color transfer function proxy

paraview.simple.__init__.GetCameraTrack(view=None, registrationName=None)

Returns the camera animation track for the given view.

Parameters:

• view (View proxy) – The view whose camera animation track should be retrieved. If no view is specified, the active view will be used. If no existing camera animation track is found, a new one will be created.

• registrationName – Optional name to register the camera animation cue with.

Returns:

Camera animation cue

Return type:

paraview.servermanager.CameraAnimationCue

paraview.simple.__init__.GetColorTransferFunction(arrayname, representation=None, separate=False, **params)

Get the color transfer function used to map a data array with the given name to colors.

Parameters:

• arrayname (str) – Name of the array whose color transfer function is requested.

• representation (Representation proxy.) – Used to modify the array name when using a separate color transfer function. Optional, defaults to the active proxy.

• separate (bool) – If True, used to recover the separate color transfer function even if it is not used currently by the representation. Optional, defaults to False.

Returns:

This may create a new color transfer function if none exists, or return an existing one if found.

Return type:

Color transfer function proxy

paraview.simple.__init__.GetDisplayProperties(proxy=None, view=None)

DEPRECATED: Should use GetRepresentation() instead.

paraview.simple.__init__.GetDisplayProperty(*arguments, **keywords)

DEPRECATED: Should use GetRepresentationProperty()

paraview.simple.__init__.GetExtractors(proxy=None)

Returns a list of extractors associated with the proxy.

Parameters:

proxy (paraview.servermanager.Proxy, optional) – The proxy to return the extractors associated with. If not specified (or is None) then all extractors are returned.

Returns:

List of associated extractors if any. May return an empty list.

Return type:

list of paraview.servermanager.Proxy

paraview.simple.__init__.GetLayout(view=None)

Return the layout containing the given view, if any.

Parameters:

view – A view in the layout to be removed. Optional, defaults to the active view.

Returns:

The layout containing the view

Return type:

paraview.servermanager.ViewLayout

paraview.simple.__init__.GetLayoutByName(name)

Return the first layout with the given name, if any.

Parameters:

name (str) – Name of the layout

Returns:

The named layout if it exists

Return type:

Layout proxy or None

paraview.simple.__init__.GetLayouts()

Returns all the layout proxies.

Returns:

A list of all the layouts.

Return type:

list of layout proxies

paraview.simple.__init__.GetLight(number, view=None)

Get a previously added light.

Parameters:

• number (int) – The index of the light to obtain.

• view (View proxy. Option, if not provided the active view is used.) – The view holding the light.

Returns:

The requested light.

Return type:

paraview.servermanager.Light or None

paraview.simple.__init__.GetLookupTableNames()

Returns a list containing the currently available transfer function preset names.

Returns:

List of currently availabe transfer function preset names.

Return type:

List of str

paraview.simple.__init__.GetMaterialLibrary()

Returns the material library for the active session.

Returns:

The material library

Return type:

paraview.servermanager.MaterialLibrary

paraview.simple.__init__.GetNumberOfCallbackThreads(n)

Gets the number of threads used by the threaded callback queue that can be used for saving screenshots.

Parameters:

n (int) – Not used

paraview.simple.__init__.GetNumberOfSMPThreads(n)

paraview.simple.__init__.GetOpacityTransferFunction(arrayname, representation=None, separate=False, **params)

Get the opacity transfer function used to map a data array with the given name to opacities in the blocks referred to by a selector expresson.

Parameters:

• arrayname (str) – Name of the array whose opacity transfer function is requested.

• representation (Representation proxy.) – Used to modify the array name when using a separate opacity transfer function. Optional, defaults to the active representation.

• separate (bool) – If True, used to recover the separate opacity transfer function even if it is not used currently by the representation. Optional, defaults to False.

Returns:

This may create a new opacity transfer function if none exists, or return an existing one if found.

Return type:

Opacity transfer function proxy

paraview.simple.__init__.GetOpenGLInformation(location=16)

Recover OpenGL information on either the client or server.

Parameters:

location (vtkPVServer.ServerFlags enum value) – Where the OpenGL information should be retrieved, e.g., pass vtkPVSession.CLIENT if you want OpenGL info from the client system (default value), pass in vtkPVSession.SERVERS if you want the server.

paraview.simple.__init__.GetParaViewSourceVersion()

Returns:

the ParaView source version string, e.g., ‘paraview version x.x.x, Date: YYYY-MM-DD’.

Return type:

str

paraview.simple.__init__.GetParaViewVersion()

Returns:

The version of the ParaView build in (major, minor) form.

Return type:

2-element tuple

paraview.simple.__init__.GetProperty(*arguments, **keywords)

Get one property of the given pipeline object. If keywords are used, you can set the proxy and the name of the property that you want to get as shown in the following example:

GetProperty({proxy=sphere, name="Radius"})

If arguments are used, then you have two cases:

• if only one argument is used that argument will be the property name.

• if two arguments are used then the first one will be the proxy and the second one the property name.

Several example are given below:

GetProperty(name="Radius")
GetProperty(proxy=sphereProxy, name="Radius")
GetProperty( sphereProxy, "Radius" )
GetProperty( "Radius" )

paraview.simple.__init__.GetRenderView()

Returns the active view if there is one. Else creates and returns a new view. :return: the active view

paraview.simple.__init__.GetRenderViews()

Get all render views in a list. :return: all render views in a list.

paraview.simple.__init__.GetRepresentation(proxy=None, view=None)

Given a pipeline proxy and a view, returns the corresponding representation object. If proxy and view are not specified, active objects are used.

Parameters:

• proxy (Source proxy) – Pipeline proxy whose representation in the given view is requested. Optional, defaults to the active view.

• view (View proxy) – The view associated with the requested representation. Optional, defaults to returning the representation associated with the active view.

Returns:

The representation for the given proxy in the view.

Return type:

Representation proxy

paraview.simple.__init__.GetRepresentationAnimationHelper(sourceproxy)

Method that returns the representation animation helper for a source proxy. It creates a new one if none exists.

paraview.simple.__init__.GetRepresentationProperty(*arguments, **keywords)

Same as GetProperty(), except that if no proxy parameter is passed, it will use the active representation, rather than the active source.

paraview.simple.__init__.GetRepresentations()

Returns all available representation proxies (display properties) in all views.

Returns:

dictionary of representations. Keys are tuples consisting of the registration name and integer ID of the representation proxy, and values are the representation proxies themselves.

Return type:

dict

paraview.simple.__init__.GetScalarBar(ctf, view=None)

Returns the scalar bar for the given color transfer function in the given view.

Parameters:

• ctf (Color transfer function proxy.) – The color transfer function proxy whose scalar bar representation should be returned.

• view (View proxy.) – View from which the scalar bar proxy should be retrieved. Optional, defaults to the active view, if possible.

Returns:

The scalar bar proxy for the color transfer function if found. his will either return an existing scalar bar or create a new one.

Return type:

Scalar bar proxy

paraview.simple.__init__.GetSelections()

Get all available selection sources.

Returns:

dictionary of selection sources. Keys are tuples consisting of the registration name and integer ID of the proxy, and values are the selection sources themselves.

Return type:

dictionary

paraview.simple.__init__.GetSettingsProxy(type)

Given a string giving the type of settings to access, returns the proxy for those settings.

Parameters:

type (str) – The type of settings to access. Valid types may be found by calling GetAllSettings().

paraview.simple.__init__.GetSources()

Get all available pipeline sources.

Returns:

dictionary of pipeline sources. Keys are tuples consisting of the registration name and integer ID of the proxy, and values are the pipeline sources themselves.

Return type:

dictionary

paraview.simple.__init__.GetTimeKeeper()

Returns the timekeeper proxy for the active session. Timekeeper is often used to manage time step information known to the ParaView application.

Returns:

timekeeper

Return type:

paraview.servermanager.TimeKeeper

paraview.simple.__init__.GetTimeTrack()

Returns the animation track used to control the time requested from all sources during playback

Returns:

The time animation track.

Return type:

paraview.servermanager.TimeAnimationCue

paraview.simple.__init__.GetTransferFunction2D(arrayname, array2name=None, representation=None, separate=False, **params)

Get the 2D color transfer function used to map a data array with the given name to colors.

Parameters:

• arrayname (str) – Name of the first array whose color transfer function is requested.

• array2name (str) – Name of the second array whose color transfer function is requested.

• representation (Representation proxy.) – Used to modify the array name when using a separate color transfer function. Optional, defaults to the active representation.

• separate (bool) – If True, used to recover the separate color transfer function even if it is not used currently by the representation. Optional, defaults to False.

Returns:

This may create a new 2D color transfer function if none exists, or return an existing one if found.

Return type:

2D color transfer function proxy

paraview.simple.__init__.GetViewForLight(proxy)

Given a light proxy, find which view it belongs to

Parameters:

proxy (Light proxy) – The light proxy whose view you want to retrieve.

Returns:

The view associated with the light if found, otherwise None

Return type:

View proxy or None

paraview.simple.__init__.GetViewProperties(view=None)

Same as GetActiveView(). this API is provided just for consistency with GetDisplayProperties().

paraview.simple.__init__.GetViewProperty(*arguments, **keywords)

Same as GetProperty(), except that if no ‘proxy’ parameter is passed, it will use the active view properties, rather than the active source.

paraview.simple.__init__.GetViews(viewtype=None)

Returns all views in a list.

Parameters:

viewtype (str) – If provided, only the views of the specified type are returned. Optional, defaults to None.

Returns:

list of views of the given viewtype, or all views if viewtype is None.

Return type:

list of view proxies

paraview.simple.__init__.GetViewsInLayout(layout=None)

Returns a list of views in the given layout.

Parameters:

layout (Layout proxy.) – Layout whose views should be returned. Optional, defaults to the layout for the active view, if possible.

Returns:

List of views in the layout.

Return type:

list

paraview.simple.__init__.GhostCellsGenerator(*input, **params)

GhostCellsGenerator is a deprecated proxy. It will be automatically replaced by GhostCells

paraview.simple.__init__.Hide(proxy=None, view=None)

Turns the visibility of a given pipeline source off in the given view. If pipeline object and/or view are not specified, active objects are used.

Parameters:

• proxy (Pipeline source proxy to hide.) – The pipeline source. Optional, defaults to the active source.

• view (View proxy.) – The view in which the pipeline source should be hidden. Optional, defaults to the active view.

paraview.simple.__init__.HideAll(view=None)

Hide all pipeline sources in the given view.

Parameters:

view (View proxy.) – The view in which to hide all pipeline sources. Optional, defaults to the active view.

paraview.simple.__init__.HideInteractiveWidgets(proxy=None)

If possible in the current environment, this function will request the application to hide the interactive widget(s) for the given proxy.

Parameters:

proxy (Source proxy.) – The proxy whose associated interactive widgets should be hidden. Optional, if not provided the active source’s widgets are hidden.

paraview.simple.__init__.HideScalarBarIfNotNeeded(lut, view=None)

Hides the given scalar bar if it is not used by any of the displayed data.

Parameters:

• lut (Scalar bar proxy) – The lookup table (lut) or scalar bar proxy

• view – The view in which the scalar bar should be hidden. Optional, defaults to hiding scalar bars in the active view.

paraview.simple.__init__.HideUnusedScalarBars(view=None)

Hides all unused scalar bars from the view. A scalar bar is used if some data is shown in that view that is coloring using the transfer function shown by the scalar bar.

Parameters:

view (View proxy) – View in which unused scalar bars should be hidden. Optional, defaults to the active view.

paraview.simple.__init__.ImportPresets(filename, location=16)

Import presets from a file. The file can be in the legacy color map XML format or in the new JSON format.

Parameters:

• filename (str) – Path of the file containing the presets.

• location (vtkPVServer.ServerFlags enum value) – Where the statefile should be save, e.g., pass vtkPVSession.CLIENT if the statefile is located on the client system (default value), pass in vtkPVSession.SERVERS if on the server. Optional, defaults to vtkPVSession.CLIENT.

Returns:

True on success, False otherwise.

paraview.simple.__init__.ImportView(filename, view=None, **params)

Import a view from a specified input scene file.

Parameters:

• filename (str) – The name of the file to import.

• view (View proxy.) – View proxy into which the scene should be imported. Optional, defaults to the active view.

• params – A variadic list of key=value pairs giving values of specific named properties of the importer.

paraview.simple.__init__.Interact(view=None)

Call this method to start interacting with a view. This method will block until the interaction is done. If the local process cannot support interactions, this method will simply return without doing anything.

Parameters:

view (View proxy.) – The interaction occurs with this view. Optional, defaults to the active view.

paraview.simple.__init__.LevelScalarsOverlappingAMR(*input, **params)

LevelScalarsOverlappingAMR is a deprecated proxy. It will be automatically replaced by OverlappingAMRLevelIds

paraview.simple.__init__.ListColorPresetNames()

Returns a list containing the currently available color transfer function preset names.

Returns:

List of currently available transfer function preset names.

Return type:

List of str

paraview.simple.__init__.LoadCustomFilters(filename, ns=None)

Loads a custom filter XML file and updates this module with new constructors if any. If you loaded the simple module with from paraview.simple import *, make sure to pass globals() as an argument.

Parameters:

• filename (str) – Path to XML file with custom filter definitions.

• ns (dict) – Namespace in which new functions will be loaded. Optional, defaults to None.

paraview.simple.__init__.LoadDistributedPlugin(pluginname, remote=True, ns=None)

Loads a plugin that’s distributed with the ParaView executable. This uses the information known about plugins distributed with ParaView to locate the shared library for the plugin to load.

Parameters:

• pluginname (str) – Short name of the plugin (not a file path)

• remote (bool) – If True, loads the plugin on the server unless the connection is not remote. If False, loads the plugin on the client. Optional, defaults to True.

• ns (dict) – Namespace in which new functions will be loaded. Optional, defaults to None.

Raises:

RuntimeError – If the plugin was not found.

paraview.simple.__init__.LoadLookupTable(fileName)

Load transfer function preset from a file. Both JSON (new) and XML (legacy) preset formats are supported.

Parameters:

fileName (str) – If the filename ends with a .xml, it’s assumed to be a legacy color map XML and will be converted to the new format before processing.

Returns:

True if successful, False otherwise.

Return type:

bool

paraview.simple.__init__.LoadPalette(paletteName)

Load a color palette to override the default foreground and background colors used by ParaView views. The current global palette’s colors are set to the colors in the loaded palette.

Parameters:

paletteName (str) – Name of the palette to load from this list: ‘WarmGrayBackground’, ‘DarkGrayBackground’, ‘NeutralGrayBackground’, ‘LightGrayBackground’, ‘WhiteBackground’, ‘BlackBackground’, ‘GradientBackground’.

paraview.simple.__init__.LoadPlugin(filename, remote=True, ns=None)

Loads a ParaView plugin and updates this module with new constructors if any. The remote argument (default to True) is to specify whether the plugin will be loaded on the client (remote=False) or on the server (remote=True).

If you loaded the simple module with from paraview.simple import *, make sure to pass globals() as an argument:

LoadPlugin("myplugin", False, globals()) # to load on client
LoadPlugin("myplugin", True, globals())  # to load on server
LoadPlugin("myplugin", ns=globals())     # to load on server

Otherwise, the new functions will not appear in the global namespace.

Parameters:

• filename (str) – Path to the plugin to load.

• remote (bool) – If True, loads the plugin on the server unless the connection is not remote. If False, loads the plugin on the client. Optional, defaults to True.

• ns (dict) – Namespace in which new functions will be loaded. Optional, defaults to None.

Returns:

None

paraview.simple.__init__.LoadPlugins(*args, **kwargs)

Loads ParaView plugins and updates this module with new constructors if any. The remote keyword argument (default to True) is to specify whether the plugin will be loaded on client (remote=False) or on server (remote=True). Proxy definition updates are deferred until all plugins have been read, which can be more computationally efficient when multiple plugins are loaded in sequence.

If you loaded the simple module with from paraview.simple import *, make sure to pass globals() as a keyword argument:

LoadPlugins("myplugin1", "myplugin2", remote=False, ns=globals()) # to load on client
LoadPlugins("myplugin", "myplugin2", remote=True, ns=globals())  # to load on server
LoadPlugins("myplugin", "myplugin2", ns=globals())     # to load on server

Otherwise, the new functions will not appear in the global namespace.

Note, remote=True has no effect when the connection is not remote.

paraview.simple.__init__.LoadState(statefile, data_directory=None, restrict_to_data_directory=False, filenames=None, location=16, *args, **kwargs)

Load PVSM state file.

This will load the state specified in the statefile.

ParaView can update absolute paths for data files used in the state which can be useful to portably load state file across different systems.

Alternatively, filenames can be used to specify a list of filenames explicitly. This must be list of the following form:

[
    {
        // either 'name' or 'id' are required. if both are provided, 'id'
        // is checked first.
        "name" : "[reader name shown in pipeline browser]",
        "id"   : "[reader id used in the pvsm state file]",

        // all modified filename-like properties on this reader
        "FileName" : "..."
        // ...
    }

    // ...
]

Calling this function with other positional or keyword arguments will invoke the legacy signature of this function _LoadStateLegacy.

Parameters:

• statefile (str) – Path to the statefile to load

• data_directory (str) – If not None, then ParaView searches for files matching those used in the state under the specified directory and if found, replaces the state to use the found files instead. Optional, defaults to None.

• restrict_to_data_directory (bool) – If set to True, if a file is not found under the data_directory, it will raise an error, otherwise it is left unchanged. Optional, defaults to False.

• filenames (str) – JSON-formatted string to specify a list of filenames.

• location (vtkPVServer.ServerFlags enum value) – Where the statefile is located, e.g., pass vtkPVSession.CLIENT if the statefile is located on the client system (default value), pass in vtkPVSession.SERVERS if on the server. Optional, defaults to client.

paraview.simple.__init__.LoadXML(xmlstring, ns=None)

Given a server manager XML as a string, parse and process it. If you loaded the simple module with from paraview.simple import *, make sure to pass globals() as the second arguments:

LoadXML(xmlstring, globals())

Otherwise, the new functions will not appear in the global namespace.

Parameters:

• xmlstring (str) – XML string containing server manager definitions.

• ns (dict) – Namespace in which new functions will be defined. Optional, defaults to None.

paraview.simple.__init__.LocateView(displayProperties=None)

Returns the view associated with the given displayProperties/representation object if it exists.

Parameters:

displayProperties (representation proxy) – a representation proxy returned by GetRepresentation(), GetDisplayProperties(), or Show() functions. Optional, defaults to the active representation.

Returns:

The view associated with the representation if it exists, otherwise None

Return type:

View proxy or None

paraview.simple.__init__.MakeBlueToRedLT(min, max)

Create a LookupTable that go from blue to red using the scalar range provided by the min and max arguments.

Parameters:

• min (float) – Minimum range value.

• max (float) – Maximum range value.

Returns:

the blue-to-red lookup table

Return type:

Lookup table proxy.

paraview.simple.__init__.OpenDataFile(filename, **extraArgs)

Creates a reader to read the give file, if possible. This uses extension matching to determine the best reader possible.

Returns:

Returns a suitable reader if found. If a reader cannot be identified, then this returns None.

Return type:

Reader proxy, or None

paraview.simple.__init__.OutputPort(proxy, outputPort=0)

paraview.simple.__init__.ProcessIdScalars(*input, **params)

ProcessIdScalars is a deprecated proxy. It will be automatically replaced by ProcessIds

paraview.simple.__init__.QuerySelect(QueryString='', FieldType='POINT', Source=None, InsideOut=False)

Selection by query expression.

Parameters:

• QueryString (str) – string with NumPy-like boolean expression defining which attributes are selected

• FieldType (str) – attribute to select, e.g., ‘POINT’ or ‘CELL’

• Source (paraview.servermanager.source.Proxy) – if not set, then the selection will be on the active source

• InsideOut (bool) – Invert the selection so that attributes that do not satisfy the expression are selected instead of elements that do.

Returns:

None

paraview.simple.__init__.ReloadFiles(proxy=None)

Forces a reader proxy to reload the data files.

Parameters:

proxy (Reader proxy) – Reader proxy whose files should be reloaded. Optional, defaults to reloading files in the active source.

Returns:

Returns True if files reloaded successfully, False otherwise

Return type:

bool

paraview.simple.__init__.RemoveCameraLink(linkName)

Remove a camera link with the given name.

Parameters:

linkName (str) – Name of the link to remove.

paraview.simple.__init__.RemoveLayout(proxy=None)

Remove the provided layout. If none is provided, remove the layout containing the active view. If it is the only layout it will create a new one with the same name as the removed one.

Parameters:

proxy (Layout proxy or None.) – The layout proxy to remove. Optional, defaults to the layout containing the active view.

paraview.simple.__init__.RemoveLight(light)

Removes an existing light from its view.

Parameters:

light (paraview.servermanager.Light) – The light to be removed.

paraview.simple.__init__.RemoveLink(linkName)

Remove a named link.

Parameters:

linkName (str) – Name of the link to remove.

paraview.simple.__init__.RemoveSelectionLink(linkName)

Remove a selection link with the given name.

Parameters:

linkName (str) – Name of the link to remove.

paraview.simple.__init__.RemoveViewsAndLayouts()

Removes all existing views and layouts.

paraview.simple.__init__.RenameLayout(newName, proxy=None)

Renames the given layout. If the given proxy is not registered in the ‘layouts’ group this method will have no effect.

Parameters:

• newName (str) – The new name of the layout proxy

• layout – The layout proxy to rename. It must be a member of the ‘layouts’ groupd. Optional, defaults to renaming the active layout.

paraview.simple.__init__.RenameProxy(proxy, group, newName)

Renames the given proxy. This is the name used by FindSource() and is displayed in the Pipeline Browser.

Parameters:

• proxy (Proxy object) – The proxy to be renamed

• group (str) – The group in which the proxy lives. Can be retrieved with proxy.GetXMLGroup()

• newName (str) – The new name of the proxy.

paraview.simple.__init__.RenameSource(newName, proxy=None)

Renames the given source proxy. If the given proxy is not registered in the ‘sources’ group this function will have no effect.

Parameters:

• newName (str) – The new name of the source proxy

• proxy (Source proxy) – The source proxy to rename. It must be a member of the ‘sources’ group. Optional, defaults to renaming the active source.

paraview.simple.__init__.RenameView(newName, proxy=None)

Renames the given view. If the given proxy is not registered in the ‘views’ group this method will have no effect.

Parameters:

• newName (str) – The new name of the view proxy

• proxy (View proxy) – The view proxy to rename. It must be a member of the ‘views’ group. Optional, defaults to renaming the active view.

paraview.simple.__init__.Render(view=None)

Renders the given view if given, otherwise renders the active view. If this is the first render and the view is a RenderView, the camera is reset.

Parameters:

view (View proxy.) – The view to render. Optional, defaults to rendering the active view.

paraview.simple.__init__.RenderAllViews()

Renders all existing views.

paraview.simple.__init__.ReplaceReaderFileName(readerProxy, files, propName)

Replaces the readerProxy by a new one given a list of files.

Parameters:

• readerProxy (Reader proxy.) – Reader proxy whose filename should be updated.

• files (list of str) – List of file names to be read by the reader.

• propName (str) – should be “FileNames” or “FileName” depending on the property name in the reader.

paraview.simple.__init__.ResetCamera(view=None)

Resets camera settings to make the whole scene visible while preserving orientation.

Parameters:

view (View proxy.) – The camera for this view is reset. Optional, defaults to the active view.

paraview.simple.__init__.ResetCameraToDirection(position=None, direction=None, up=None, view=None, bounds=None, sphere_bounds=None)

Resets the settings of the camera to the given position and direction.

Parameters:

• position (3-element tuple or list of floats.) – Position of the camera. (default: [0,0,0])

• direction (3-element tuple or list of floats.) – Direction of the camera. (default: [0, 0, -1])

• up (3-element tuple or list of floats.) – If provided, will be used as the camera’s up direction.

• view (View proxy.) – If provided, modifies the camera in this view.

• bounds (6-element tuple or list of floats.) – If provided, reset the camera using that bounds (min_x, max_x, min_y, max_y, min_z, max_z).

• sbounds (4-element tuple or list of floats.) – If provided, reset the camera using computed bounds from a sphere_bounds (center_x, center_y, center_z, radius).

Examples:

>> ResetCameraToDirection( … direction=[-1, -1, -1], … sphere_bounds=(-5, -4, -3, 25), … )

>> ResetCameraToDirection( … direction=[-1, -1, -1], … bounds=( … -30, 20, … -29, 21, … -28, 22, … ), … )

paraview.simple.__init__.ResetProperty(propertyName, proxy=None, restoreFromSettings=True)

Resets a proxy property to its default value.

Parameters:

• propertyName (str) – Name of the property to reset.

• proxy – The proxy whose property should be reset. Optional, defaults to the active source.

• restoreFromSettings (bool) – If True, the property will be reset to the default value stored in the settings if available, otherwise it will be reset to ParaView’s application default value. Optional, defaults to True.

paraview.simple.__init__.ResetSession()

Reset the session to its initial state. All pipeline readers, sources, filters extractors, and representations are removed.

paraview.simple.__init__.ReverseConnect(port=11111, ns=None)

Create a reverse connection to a server. First, disconnects from any servers, then listens on port and waits for an incoming connection from the server.

Parameters:

port (int) – The port to listen on for incoming connections.

Returns:

Connection object

Return type:

paraview.simple.__init__.SaveAnimation(filename, viewOrLayout=None, scene=None, location=16, **params)

Save animation as a movie file or series of images.

SaveAnimation is used to save an animation as a movie file (avi, mp4, or ogv) or a series of images.

Parameters:

• filename (str) – Name of the output file. The extension is used to determine the type of the output. Supported extensions are png, jpg, tif, bmp, and ppm. Based on platform (and build) configuration, avi, mp4, and ogv may be supported as well.

• viewOrLayout (View or layout proxy.) – The view or layout to save image from, defaults to None. If None, then the active view is used, if available. To save an image from a single view, this must be set to a view, to save an image from all views in a layout, pass the layout.

• scene (Animation scene proxy) – Animation scene to save. If not provided, then the active scene returned by GetAnimationScene is used.

• location (vtkPVSession.ServerFlags enum) – Location where the screenshot should be saved. This can be one of the following values: vtkPVSession.CLIENT, vtkPVSession.DATA_SERVER. The default is vtkPVSession.CLIENT.

Keyword Parameters (optional)

SaveAnimation supports all keyword parameters supported by SaveScreenshot. In addition, the following parameters are supported:

FrameRate (int):

Frame rate in frames per second for the output. This only affects the output when generated movies (avi or ogv), and not when saving the animation out as a series of images.

FrameWindow (tuple(int,int))

To save a part of the animation, provide the range in frames or timesteps index.

In addition, several format-specific keyword parameters can be specified. The format is chosen based on the file extension.

For Image-based file-formats that save series of images e.g. PNG, JPEG, following parameters are available.

SuffixFormat (string):

Format string used to convert the frame number to file name suffix.

FFMPEG avi file format supports following parameters.

Compression (int)

Set to 1 or True to enable compression.

Quality:

When compression is 1 (or True), this specifies the compression quality. 0 is worst quality (smallest file size) and 2 is best quality (largest file size).

VideoForWindows (VFW) avi file format supports following parameters.

Quality:

This specifies the compression quality. 0 is worst quality (smallest file size) and 2 is best quality (largest file size).

OGG/Theora file format supports following parameters.

Quality:

This specifies the compression quality. 0 is worst quality (smallest file size) and 2 is best quality (largest file size).

UseSubsampling:

When set to 1 (or True), the video will be encoded using 4:2:0 subsampling for the color channels.

paraview.simple.__init__.SaveData(filename, proxy=None, **extraArgs)

Save data produced by the proxy parameter into a file.

Properties to configure the writer can be passed in as keyword arguments. Example usage:

SaveData("sample.pvtp", source0)
SaveData("sample.csv", FieldAssociation="Points")

Parameters:

• filenam – Path where output file should be saved.

• proxy (Source proxy.) – Proxy to save. Optional, defaults to saving the active source.

• extraArgs – A variadic list of key=value pairs giving values of specific named properties in the writer.

paraview.simple.__init__.SaveExtracts(**kwargs)

Generate extracts. Parameters are forwarded for ‘SaveAnimationExtracts’ Currently, supported keyword parameters are:

Parameters:

• ExtractsOutputDirectory (str) – root directory for extracts. If the directory does not exist, it will be created.

• GenerateCinemaSpecification (bool) – If set to True, enables generation of a cinema specification.

• FrameRate (int) – The frame rate in frames-per-second if the extractor supports it.

• FrameStride (int) – The number of timesteps to skip after a timestep is saved.

• FrameWindow (2-element tuple or list of ints) – The range of timesteps to extract.

paraview.simple.__init__.SaveExtractsUsingCatalystOptions(options)

Generate extracts using a CatalystOptions object. This is intended for use when a Catalyst analysis script is being run in batch mode.

Parameters:

options (CatalystOptions) – Catalyst options proxy

paraview.simple.__init__.SaveScreenshot(filename, viewOrLayout=None, saveInBackground=False, location=16, **params)

Save screenshot for a view or layout (collection of views) to an image.

SaveScreenshot is used to save the rendering results to an image.

Parameters:

• filename (str) – Name of the image file to save to. The filename extension is used to determine the type of image file generated. Supported extensions are png, jpg, tif, bmp, and ppm.

• viewOrLayout (View or layout proxy. Optional.) – The view or layout to save image from, defaults to None. If None, then the active view is used, if available. To save image from a single view, this must be set to a view, to save an image from all views in a layout, pass the layout.

• saveInBackground (bool) – If set to True, the screenshot will be saved by a different thread and run in the background. In such circumstances, one can wait until the file is written by calling WaitForScreenshot(filename)().

• location (vtkPVSession.ServerFlags enum) – Location where the screenshot should be saved. This can be one of the following values: vtkPVSession.CLIENT, vtkPVSession.DATA_SERVER. Optional, defaults to vtkPVSession.CLIENT.

Keyword Parameters (optional)

ImageResolution (tuple(int, int))

A 2-tuple to specify the output image resolution in pixels as (width, height). If not specified, the view (or layout) size is used.

FontScaling (str)

Specify whether to scale fonts proportionally (“Scale fonts proportionally”) or not (“Do not scale fonts”). Defaults to “Scale fonts proportionally”.

SeparatorWidth (int)

When saving multiple views in a layout, specify the width (in approximate pixels) for a separator between views in the generated image.

SeparatorColor (tuple(float, float, float))

Specify the color for separator between views, if applicable.

OverrideColorPalette (:obj:str, optional)

Name of the color palette to use, if any. If none specified, current color palette remains unchanged.

StereoMode (str)

Stereo mode to use, if any. Available values are “No stereo”, “Red-Blue”, “Interlaced”, “Left Eye Only”, “Right Eye Only”, “Dresden”, “Anaglyph”, “Checkerboard”, “Side-by-Side Horizontal”, and the default “No change”.

TransparentBackground (int)

Set to 1 (or True) to save an image with background set to alpha=0, if supported by the output image format.

In addition, several format-specific keyword parameters can be specified. The format is chosen based on the file extension.

For JPEG (*.jpg), the following parameters are available (optional)

Quality (int) [0, 100]

Specify the JPEG compression quality. O is low quality (maximum compression) and 100 is high quality (least compression).

Progressive (int):

Set to 1 (or True) to save progressive JPEG.

For PNG (*.png), the following parameters are available (optional)

CompressionLevel (int) [0, 9]

Specify the zlib compression level. 0 is no compression, while 9 is maximum compression.

Legacy Parameters

Prior to ParaView version 5.4, the following parameters were available and are still supported. However, they cannot be used together with other keyword parameters documented earlier.

view (proxy)

Single view to save image from.

layout (proxy)

Layout to save image from.

magnification (int)

Magnification factor to use to save the output image. The current view (or layout) size is scaled by the magnification factor provided.

quality (int)

Output image quality, a number in the range [0, 100].

paraview.simple.__init__.SaveState(filename, location=16)

Save a ParaView statefile (.pvsm) to disk on a system provided by the location parameter.

Parameters:

• filename (str) – Path where the state file should be saved.

• location (vtkPVServer.ServerFlags enum value) – Where the statefile should be save, e.g., pass vtkPVSession.CLIENT if the statefile is located on the client system (default value), pass in vtkPVSession.SERVERS if on the server.

paraview.simple.__init__.SelectCells(query=None, proxy=None)

Select cells satisfying the query.

Parameters:

• query (str) – The selection query. If None, then all cells are selected.

• proxy (Source proxy) – The source proxy to select from. Optional, defaults to the active source.

Returns:

Selection source

Return type:

servermanager.sources.SelectionQuerySource

paraview.simple.__init__.SelectCellsThrough(Rectangle=[], View=None, Modifier=None)

Select all cells within a rectangular region regardless of their visibility.

• Rectangle - list containing bottom left (x1, y1) and top right (x2, y2) corner of a rectangle defining the selection region in the format [x1, y1, x2, y2]. Defined in pixels.

• View - the view in which to perform the selection. If None, uses the current active view.

paraview.simple.__init__.SelectCompositeDataIDs(IDs=[], FieldType='POINT', ContainingCells=False, Source=None, Modifier=None)

Select attributes by composite attribute IDs.

• IDs - list of IDs of attribute types to select. Defined as 3-tuples of (flat block index, process number, attribute ID) interleaved in a single list.

• FieldType - type of attribute to select, e.g., ‘POINT’, ‘CELL’

• ContainingCells - if True and FieldType is ‘POINT’, select the cells containing the

  points corresponding to the given IDs.

• Source - If not None, specifies the sources whose elements should be selected by ID.

• Modifier - ‘ADD’, ‘SUBTRACT’, ‘TOGGLE’, or None to define whether and how the selection

  should modify the existing selection.

paraview.simple.__init__.SelectGlobalIDs(IDs=[], FieldType='POINT', ContainingCells=False, Source=None, Modifier=None)

Select attributes by global IDs.

• IDs - list of IDs of attribute types to select. Defined as a list of global IDs.

• FieldType - type of attribute to select, e.g., ‘POINT’, ‘CELL’

• ContainingCells - if True and FieldType is ‘POINT’, select the cells containing the

  points corresponding to the given IDs.

• Source - If not None, specifies the sources whose elements should be selected by ID.

• Modifier - ‘ADD’, ‘SUBTRACT’, ‘TOGGLE’, or None to define whether and how the selection

  should modify the existing selection.

paraview.simple.__init__.SelectHierarchicalDataIDs(IDs=[], FieldType='POINT', ContainingCells=False, Source=None, Modifier=None)

Select attributes by hierarchical data IDs.

• IDs - list of IDs of attribute types to select. Defined as 3-tuples of (level, index, attribute ID) interleaved in a single list.

• FieldType - type of attribute to select, e.g., ‘POINT’, ‘CELL’

• ContainingCells - if True and FieldType is ‘POINT’, select the cells containing the

  points corresponding to the given IDs.

• Source - If not None, specifies the sources whose elements should be selected by ID.

• Modifier - ‘ADD’, ‘SUBTRACT’, ‘TOGGLE’, or None to define whether and how the selection

  should modify the existing selection.

paraview.simple.__init__.SelectIDs(IDs=[], FieldType='POINT', ContainingCells=False, Source=None, Modifier=None)

Select attributes by attribute IDs.

• IDs - list of IDs of attribute types to select. Defined as (process number, attribute ID) pairs interleaved in a single list. For multiblock datasets, this will select attributes on all blocks of the provided (processor number, attribute ID) pairs

• FieldType - type of attribute to select, e.g., ‘POINT’, ‘CELL’

• ContainingCells - if True and FieldType is ‘POINT’, select the cells containing the

  points corresponding to the given IDs.

• Source - If not None, specifies the sources whose elements should be selected by ID.

• Modifier - ‘ADD’, ‘SUBTRACT’, ‘TOGGLE’, or None to define whether and how the selection

  should modify the existing selection.

paraview.simple.__init__.SelectLocation(Locations=[], Source=None, Modifier=None)

Select points by location.

• Locations - list of x, y, z points to select.

• Source - if not set, then the selection will be on the active source

paraview.simple.__init__.SelectPedigreeIDs(IDs=[], FieldType='POINT', ContainingCells=False, Source=None, Modifier=None)

Select attributes by Pedigree IDs.

• IDs - list of IDs of attribute types to select. Defined as (domain, ID) pairs interleaved in a single list.

• FieldType - type of attribute to select, e.g., ‘POINT’, ‘CELL’

• ContainingCells - if True and FieldType is ‘POINT’, select the cells containing the

  points corresponding to the given IDs.

• Source - If not None, specifies the sources whose elements should be selected by ID.

• Modifier - ‘ADD’, ‘SUBTRACT’, ‘TOGGLE’, or None to define whether and how the selection

  should modify the existing selection.

paraview.simple.__init__.SelectPoints(query=None, proxy=None)

Select points satisfying the query.

Parameters:

• query (str) – The selection query. If None, then all points are selected.

• proxy (Source proxy) – The source proxy to select from. Optional, defaults to the active source.

Returns:

Selection source

Return type:

servermanager.sources.SelectionQuerySource

paraview.simple.__init__.SelectPointsThrough(Rectangle=[], View=None, Modifier=None)

Select all points within a rectangular region regardless of their visibility.

• Rectangle - list containing bottom left (x1, y1) and top right (x2, y2) corner of a rectangle defining the selection region in the format [x1, y1, x2, y2]. Defined in pixels.

• View - the view in which to perform the selection. If None, uses the current active view.

paraview.simple.__init__.SelectSurfaceBlocks(Rectangle=[], View=None, Modifier=None)

Select visible blocks within a rectangular region.

• Rectangle - list containing bottom left (x1, y1) and top right (x2, y2) corner of a rectangle defining the selection region in the format [x1, y1, x2, y2]. Defined in pixels.

• View - the view in which to perform the selection. If None, uses the current active view.

• Modifier - ‘ADD’, ‘SUBTRACT’, ‘TOGGLE’, or None to define whether and how the selection should modify the existing selection.

paraview.simple.__init__.SelectSurfaceCells(Rectangle=[], Polygon=[], View=None, Modifier=None)

Select visible cells within a rectangular or polygon region.

• Rectangle - list containing bottom left (x1, y1) and top right (x2, y2) corner of a rectangle defining the selection region in the format [x1, y1, x2, y2]. Defined in pixels. If not empty, the Polygon parameter must be empty or None.

• Polygon - list of 2D points defining a polygon in which visible points should be selected,

  e.g., [x1, y1, x2, y2, …, xn, yn]. Defined in pixels. If not empty, the Rectangle parameter must be empty or None.

• View - the view in which to perform the selection. If None, uses the current active view.

• Modifier - ‘ADD’, ‘SUBTRACT’, ‘TOGGLE’, or None to define whether and how the selection should modify the existing selection.

paraview.simple.__init__.SelectSurfacePoints(Rectangle=[], Polygon=[], View=None, Modifier=None)

Select visible points within a rectangular or polygon region.

• Rectangle - list containing bottom left (x1, y1) and top right (x2, y2) corner of a rectangle defining the selection region in the format [x1, y1, x2, y2]. Defined in pixels. If not empty, the Polygon parameter must be empty or None.

• Polygon - list of 2D points defining a polygon in which visible points should be selected,

  e.g., [x1, y1, x2, y2, …, xn, yn]. Defined in pixels. If not empty, the Rectangle parameter must be empty or None.

• View - the view in which to perform the selection. If None, uses the current active view.

• Modifier - ‘ADD’, ‘SUBTRACT’, ‘TOGGLE’, or None to define whether and how the selection should modify the existing selection.

paraview.simple.__init__.SelectThresholds(Thresholds=[], ArrayName='', FieldType='POINT', Source=None, Modifier=None)

Select attributes in a source by thresholding on values in an associated array.

• Thresholds - list of lower and upper threshold bounds. Attributes with associated values in the selected array between any set of bounds will be selected.

• ArrayName - name of the array to threshold.

• FieldType - atttribute to select, e.g., ‘POINT’ or ‘CELL’

• Source - if not set, then the selection will be on the active source

class paraview.simple.__init__.SelectionProxy(**args)

Bases: Proxy

Special proxy wrapper type for Selections.

paraview.simple.__init__.SetActiveConnection(connection=None, ns=None)

Set the active connection. If the process was run without multi-server enabled and this method is called with a non-None argument while an ActiveConnection is present, it will raise a RuntimeError.

Parameters:

• connection (Connection object.) – If provided, changes the current connection.

• ns – Namespace in which functions from the old Connection are removed and functions in the new Connection are added.

Raises:

RuntimeError – If called when ParaView is not running in multi-server mode, a RuntimeError will be raised.

paraview.simple.__init__.SetActiveSource(source)

Sets the active source.

Parameters:

source (Source proxy) – The source

paraview.simple.__init__.SetActiveView(view)

Sets the active view.

Parameters:

view (View proxy.) – The view to make active.

paraview.simple.__init__.SetDisplayProperties(proxy=None, view=None, **params)

DEPRECATED: Should use SetRepresentationProperties() instead

paraview.simple.__init__.SetNumberOfCallbackThreads(n)

Sets the number of threads used by the threaded callback queue that can be used for saving screenshots.

Parameters:

n (int) – Number of callback threads.

paraview.simple.__init__.SetNumberOfSMPThreads(n)

Sets the number of threads used by vtkSMPTools. It is used in various filters.

paraview.simple.__init__.SetProperties(proxy=None, **params)

Sets one or more properties of the given pipeline source. If an argument is not provided, the active source is used. Pass in arguments of the form property_name=value to this function to set property values. For example:

SetProperties(Center=[1, 2, 3], Radius=3.5)

Parameters:

• proxy (Source proxy) – The pipeline source whose properties should be set. Optional, defaultst to the active source.

• params – A variadic list of key=value pairs giving values of specific named properties in the pipeline source. For a list of available properties, call help(proxy).

paraview.simple.__init__.SetRepresentationProperties(proxy=None, view=None, **params)

Sets one or more representation properties of the given pipeline source.

Pass a list of property_name=value pairs to this function to set property values. For example:

SetProperties(Color=[1, 0, 0], LineWidth=2)

Parameters:

• proxy (Source proxy) – Pipeline source whose representation properties should be set. Optional, defaults to the active source.

• view (View proxy) – The view in which to make the representation property changes. Optional, defaults to the active view.

paraview.simple.__init__.SetViewProperties(view=None, **params)

Sets one or more properties of the given view. If an argument is not provided, the active view is used. Pass in arguments of the form property_name=value to this function to set property values. For example:

SetProperties(Background=[1, 0, 0], UseImmediateMode=0)

Parameters:

• view (View proxy.) – The view whose properties are to be set. If not provided, the active view is used.

• params – A variadic list of key=value pairs giving values of specific named properties in the view. For a list of available properties, call help(view).

paraview.simple.__init__.Show(proxy=None, view=None, representationType=None, **params)

Turns on the visibility of a given pipeline proxy in the given view. If pipeline proxy and/or view are not specified, active objects are used.

Parameters:

• proxy (Source proxy.) – The pipeline proxy to show. If not provided, uses the active source.

• view (View proxy.) – The view proxy to show the source proxy in. Optional, defaults to the active view.

• representationType (str) – Name of the representation type to use. Optional, defaults to a suitable representation for the source proxy and view.

Returns:

The representation proxy for the source proxy in the view.

Return type:

Representation proxy.:

paraview.simple.__init__.ShowAll(view=None)

Show all pipeline sources in the given view.

Parameters:

view (View proxy. Optional, defaults to the active view.) – The view in which to show all pipeline sources.

paraview.simple.__init__.ShowInteractiveWidgets(proxy=None)

If possible in the current environment, this function will request the application to show the interactive widget(s) for the given proxy.

Parameters:

proxy (Source proxy.) – The proxy whose associated interactive widgets should be shown. Optional, if not provided the active source’s widgets are shown.

paraview.simple.__init__.UpdatePipeline(time=None, proxy=None)

Updates (executes) the given pipeline object for the given time as necessary (i.e., if it did not already execute).

Parameters:

• time (float) – The time at which to update the pipeline. Optional, defaults to updating the currently loaded timestep.

• proxy (Source proxy.) – Source proxy to update. Optional, defaults to updating the active source.

paraview.simple.__init__.UpdateScalarBars(view=None)

Hides all unused scalar bars and shows used scalar bars. A scalar bar is used if some data is shown in that view that is coloring using the transfer function shown by the scalar bar.

Parameters:

view (View proxy) – The view in which scalar bar visibility should be changed. Optional, defaults to using the active view.

paraview.simple.__init__.UpdateScalarBarsComponentTitle(ctf, representation=None)

Update the component portion of the title in all scalar bars using the provided lookup table. The representation is used to recover the array from which the component title was obtained.

Parameters:

• ctf (Transfer function proxy.) – The lookup table that the scalar bar represents. Optional, defaults to the representation of the active source in the active view.

• representation (Representation proxy) – If provided, it is the representation to use to recover the array that provides the component title portion. Optional, defaults to the active representation.

Returns:

True if operation succeeded, False otherwise.

Return type:

bool

paraview.simple.__init__.UpdateSteerableParameters(steerable_proxy, steerable_source_name)

Updates a steerable proxy of a provided source name.

Parameters:

• steerable_proxy (Source proxy.) – The steerable proxy to update.

• steerable_source_name (str) – The name of the steerable source proxy.

paraview.simple.__init__.WaitForScreenshot(filename=None)

Pause this thread until saving a screenshot has terminated.

Parameters:

filename (str) – Path where screenshot should be saved. If no filename is provided, then this thread pauses until all screenshots have been saved.

paraview.simple.__init__.WriteAnimationGeometry(filename, view=None)

Save the animation geometry from a specific view to a file specified. The animation geometry is written out as a PVD file.

Parameters:

• filename (str) – The file path of the PVD file to write.

• view (View proxy) – The view holding the geometry that should be saved. Optional, defaults to the active view if possible.