annotate icqsol_compose_shapes.xml @ 13:2ea276661f42 draft default tip

Uploaded
author greg
date Tue, 12 Jul 2016 14:34:52 -0400
parents 0afbb466e964
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
7
e2bb54208c19 Uploaded
greg
parents: 2
diff changeset
2 <tool id="icqsol_compose_shapes" name="Compose shapes" version="@WRAPPER_VERSION@.0">
0
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
3 <description></description>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
4 <macros>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
5 <import>icqsol_macros.xml</import>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
6 </macros>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
7 <expand macro="requirements" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
8 <command>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
9 <![CDATA[
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
10 python $__tool_directory__/icqsol_compose_shapes.py
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
11 --expression "$expression"
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
12 #for $i in $input_shapes:
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
13 --shape_dataset "${i.expression_var}" "${i.input_shape}" "${i.input_shape.ext}" "${i.input_shape.metadata.dataset_type}"
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
14 #end for
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
15 --output "$output"
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
16 --output_vtk_type $output_vtk_type
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
17 ]]>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
18 </command>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
19 <inputs>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
20 <param name="expression" type="text" value="" label="Composition expression" help="Example: A + B - C * D"/>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
21 <repeat name="input_shapes" title="Expression variable and shape" min="2">
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
22 <param name="expression_var" type="text" value="" label="Expression variable" help="The selected shape will be associated with this variable in the expression."/>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
23 <param name="input_shape" type="data" format="plyascii,plybinary,vtkascii,vtkbinary" label="Shape">
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
24 <validator type="dataset_ok_validator" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
25 </param>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
26 </repeat>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
27 <expand macro="output_vtk_type_params" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
28 </inputs>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
29 <outputs>
8
0afbb466e964 Uploaded
greg
parents: 7
diff changeset
30 <data name="output" format="vtkascii">
0
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
31 <actions>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
32 <action type="format">
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
33 <option type="from_param" name="output_vtk_type" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
34 </action>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
35 </actions>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
36 </data>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
37 </outputs>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
38 <tests>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
39 <test>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
40 <param name="expression" value="head + shaft - notch1 - notch2" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
41 <repeat name="input_shapes">
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
42 <param name="expression_var" value="head" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
43 <param name="input_shape" value="head.vtkascii" ftype="vtkascii" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
44 </repeat>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
45 <repeat name="input_shapes">
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
46 <param name="expression_var" value="shaft" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
47 <param name="input_shape" value="shaft.vtkascii" ftype="vtkascii" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
48 </repeat>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
49 <repeat name="input_shapes">
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
50 <param name="expression_var" value="notch1" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
51 <param name="input_shape" value="notch1.vtkascii" ftype="vtkascii" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
52 </repeat>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
53 <repeat name="input_shapes">
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
54 <param name="expression_var" value="notch2" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
55 <param name="input_shape" value="notch2.vtkascii" ftype="vtkascii" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
56 </repeat>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
57 <output name="output" file="philips_bolt.vtkascii" ftype="vtkascii" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
58 <param name="output_vtk_type" value="vtkascii" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
59 </test>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
60 </tests>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
61 <help>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
62 **What it does**
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
63
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
64 Creates a shape composed of any number of selected shapes where the composition is based on a mathematical
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
65 expression consisting of **+**, **-** and ***** operations. The **+** results in a union of shapes, the
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
66 **-** operator removes a shape and the ***** operator results in an intersection of shapes.
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
67
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
68 For example, if the **Composition expression** is **A + B - C - D**, selecting 4 shapes from your history
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
69 and associating each shape with a variable from the expression will result in a shape composed of the shapes
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
70 associated with A and B, but eliminating the shapes associated with C and D.
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
71
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
72 </help>
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
73 <expand macro="citations" />
36f5fa5bd6d9 Uploaded
greg
parents:
diff changeset
74 </tool>