Help documentation about the functions in Python script

ParaView Support
1

Dear all,
I’m trying to use the Python script to set plots. I started trace and got some codes of the operations. When I wanted to modify the codes, I could not find the detailed help documentations of the functions. I tried help but the results did not give much useful information.

help
help911×764 21.3 KB

Where can I find the detailed documentation including description and examples of the functons like the matlab help documentation?

2

Hi @ChangzhiZhai

The complete doc is here: ParaView’s Python documentation! — ParaView/Python 5.11.0-RC1-109-g9c0a389cee documentation

What do you want to do exactly ? AxesGrid is not related directly to plots in ParaView.

3

Hi Mathieu,
Thanks for your reply. I tried the link but I didn’t find the description of “AxesGrid”.

  1. I want to set where to show the labels and what to show. For instance, I want to show 0, 100, 200 at x= 0, 10, 20.
  2. I’m used to use code to control plots in matlab, so I want to trace the Python script and modify it in ParaView. But I can not find the detailed help documentation of the functions used in the python script.
  3. What do you mean “AxesGrid is not related directly to plots in ParaView”? Are these functions in Python? I’m confused about the relationship between Python and ParaView
  4. There is a Y axis infront of the rendered volume after I set the “Data Scale” in “Axes Grid”. Why does that happen? How can I remove the infront Y axis? Following are the screen shots of this problem
    Image 13
    Image 131514×1270 122 KB

    Image 15
    Image 151156×1814 101 KB

    Image 14
    Image 141494×1247 132 KB
4

I’m very confused, you are talking about plots but you are showing a 3D view volume rendering. what kind of plots are you trying to produce ?

5

I’m sorry, maybe “plot” is ambiguous here. I am trying to generate 3D view volume rendering. I want to remove the infront upper Y axis in the view. I also want to use python script to control the 3D view including axis labels and other state.

6

Got it. The simplest way to find out how to replicate in pvpython what you do in the GUI is to use the trace.

  • Tools → PythonTrace → Show Incremental → Start
  • Enable axes
  • Look at the code in the python editor view.
7

Thank you.
If I use the GUI, how should I remove the infront upper Y axis in the view?

8

Hi @ChangzhiZhai ,

Please provide steps to reproduce in order to get this Y axis.

Best,

9

  1. Open the VTK file in paraview:
    NeNew_0800.vtk (1.6 MB)

  2. Set the Representation as Volume, Coloring as Pressure

    Image 18
    Image 18981×1696 74.6 KB

    There is no Y axis in the front in this step
    Image 13
    Image 131514×1270 122 KB

  3. Check “Axes Grid”, edit the first Data scale parameter as -2

    Image 15
    Image 151156×1814 101 KB

Apply, there is Y axis infront.

Image 14
Image 141494×1247 132 KB

10

I reproduce, definitely looks like a bug, please open an issue: https://gitlab.kitware.com/paraview/paraview/-/issues

11

OK, thank you.