simple.catalyst Module

paraview.simple.catalyst.CreateExtractor(name, proxy=None, registrationName=None)[source]

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.catalyst.CreateSteerableParameters(steerable_proxy_type_name, steerable_proxy_registration_name='SteeringParameters', result_mesh_name='steerable')[source]

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.catalyst.FindExtractor(registrationName)[source]

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.catalyst.GetExtractors(proxy=None)[source]

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.catalyst.SaveExtracts(**kwargs)[source]

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.catalyst.SaveExtractsUsingCatalystOptions(options)[source]

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.catalyst.UpdateSteerableParameters(steerable_proxy, steerable_source_name)[source]

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.