cpexport Module

This module is used to export complete CoProcessing Python scripts that can be used in a vtkCPPythonScriptPipeline.

This module uses paraview.cpstate Module to dump the ParaView session state as a an Python class description that can be then be used in the CoProcessor.

The exported script can be used in a vtkCPPythonScriptPipeline instance for CoProcessing.

paraview.cpexport.DumpCoProcessingScript(export_rendering, simulation_input_map, screenshot_info, padding_amount, rescale_data_range, enable_live_viz, live_viz_frequency, cinema_tracks, cinema_arrays, filename=None, write_start=0, make_cinema_table=False, root_directory='', request_specific_arrays=False, force_first_output=False)[source]

Returns a string with the generated CoProcessing script based on the options specified.

First three arguments are same as those expected by cpstate.DumpPipeline() function.

  • write_start – integer (0-) how many cycles catalyst should wait before executing
  • padding_amount – integer (0-10) to set image output filename padding
  • rescale_data_range – boolean set to true if the LUTs must be scaled on each timestep
  • enable_live_viz – boolean set to true if the generated script should handle live-visualization.
  • live_viz_frequency – integer specifying how often should the coprocessor send the live data
  • cinema_tracks – cinema offline visualizer parameters
  • cinema_arrays – selected value arrays for cinema
  • make_cinema_table – boolean set to true to request a cinema D index file.
  • filename – if specified, the script is written to the file.
  • root_directory – if specified, the script will export underneath this directory.
  • request_specific_arrays – boolean set to true to ask for individual arrays
  • force_first_output – boolean set to true to write the first timestep regardless of write_start.

Create a dummy pipeline and save the coprocessing state in the filename specified, if any, else dumps it out on stdout.