Commit 62223d4c authored by Cory Quammen's avatar Cory Quammen Committed by Kitware Robot

Merge topic 'improve-python-filter-docs'

49caa2d1 Updated documentation of the Python Calculator and Annotation filters
Acked-by: Kitware Robot's avatarKitware Robot <kwrobot@kitware.com>
Acked-by: Utkarsh Ayachit's avatarUtkarsh Ayachit <utkarsh.ayachit@kitware.com>
Merge-request: !2957
parents bd14e3d6 49caa2d1
Pipeline #127157 running with stage
...@@ -15,9 +15,12 @@ ...@@ -15,9 +15,12 @@
to write expressions by defining certain variables. The to write expressions by defining certain variables. The
filter tries to assign each array to a variable of the filter tries to assign each array to a variable of the
same name. If the name of the array is not a valid Python same name. If the name of the array is not a valid Python
variable, it has to be accessed through a dictionary variable, it may be accessed through a variable with a
called arrays (i.e. arrays['array_name']). The points can sanitized version of that array name consisting of only
be accessed using the points variable.</Documentation> '_' and the alphanumeric characters in the name joined
together with no spaces. Point coordinates from datasets
that explicitly define them can be accessed using the variable
named 'points'.</Documentation>
<InputProperty clean_command="RemoveAllInputs" <InputProperty clean_command="RemoveAllInputs"
command="AddInputConnection" command="AddInputConnection"
multiple_input="1" multiple_input="1"
...@@ -223,7 +226,8 @@ annotation text. ...@@ -223,7 +226,8 @@ annotation text.
name="PythonAnnotation"> name="PythonAnnotation">
<Documentation long_help="This filter evaluates a Python expression for a text annotation" <Documentation long_help="This filter evaluates a Python expression for a text annotation"
short_help="Evaluates a Python expression for a text annotation"> short_help="Evaluates a Python expression for a text annotation">
This filter uses Python to calculate an expression. It This filter uses Python to calculate an expression and display
the result as an annotation in the render view. It
depends heavily on the numpy and paraview.vtk modules. To depends heavily on the numpy and paraview.vtk modules. To
use the parallel functions, mpi4py is also necessary. The use the parallel functions, mpi4py is also necessary. The
expression is evaluated and the resulting scalar value or expression is evaluated and the resulting scalar value or
...@@ -233,8 +237,12 @@ annotation text. ...@@ -233,8 +237,12 @@ annotation text.
to write expressions by defining certain variables. The to write expressions by defining certain variables. The
filter tries to assign each array to a variable of the filter tries to assign each array to a variable of the
same name. If the name of the array is not a valid Python same name. If the name of the array is not a valid Python
variable, it has to be accessed through a dictionary variable, it may be accessed through a variable with a
called arrays (i.e. arrays['array_name']).</Documentation> sanitized version of that array name consisting of only
'_' and the alphanumeric characters in the name joined
together with no spaces. Point coordinates from datasets
that explicitly define them can be accessed using the variable
named 'points'.</Documentation>
<InputProperty clean_command="RemoveAllInputs" <InputProperty clean_command="RemoveAllInputs"
command="AddInputConnection" command="AddInputConnection"
multiple_input="1" multiple_input="1"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment