annotate icqsol_add_texture.xml @ 3:1371f6eeb73c draft

Uploaded
author greg
date Mon, 14 Dec 2015 20:01:09 -0500
parents eb0b9337e095
children 34af65e1e8bf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
2
eb0b9337e095 Uploaded
greg
parents: 1
diff changeset
2 <tool id="icqsol_add_texture" name="Add texture" version="@WRAPPER_VERSION@.0">
eb0b9337e095 Uploaded
greg
parents: 1
diff changeset
3 <description>to shape</description>
0
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
4 <macros>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
5 <import>icqsol_macros.xml</import>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
6 </macros>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
7 <expand macro="requirements" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
8 <command>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
9 <![CDATA[
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
10 python $__tool_directory__/icqsol_add_texture.py
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
11 --input "$input"
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
12 --input_file_format_and_type $input.ext
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
13 --input_dataset_type $input.metadata.dataset_type
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
14 --input_texture "$input_texture"
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
15 --input_texture_file_format $input_texture.ext
1
0a94307d301c Uploaded
greg
parents: 0
diff changeset
16 #if $refine_shape_cond.refine_shape == "yes":
0a94307d301c Uploaded
greg
parents: 0
diff changeset
17 --max_edge_length $refine_shape_cond.max_edge_length
0
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
18 #end if
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
19 --output "$output"
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
20 --output_vtk_type $output_vtk_type
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
21 ]]>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
22 </command>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
23 <inputs>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
24 <param name="input" type="data" format="vtkascii,vtkbinary" label="Shape" help="Format can be vtkascii or vtkbinary." />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
25 <param name="input_texture" type="data" format="jpg,png" label="Texture image" help="Format can be jpg or png." />
1
0a94307d301c Uploaded
greg
parents: 0
diff changeset
26 <conditional name="refine_shape_cond">
0a94307d301c Uploaded
greg
parents: 0
diff changeset
27 <param name="refine_shape" type="select" label="Refine shape?" help="Points will be added to the shape's edges restricting their length to the maximum.">
0a94307d301c Uploaded
greg
parents: 0
diff changeset
28 <option value="no" selected="True">No</option>
0a94307d301c Uploaded
greg
parents: 0
diff changeset
29 <option value="yes">Yes</option>
0a94307d301c Uploaded
greg
parents: 0
diff changeset
30 </param>
0a94307d301c Uploaded
greg
parents: 0
diff changeset
31 <when value="no" />
0a94307d301c Uploaded
greg
parents: 0
diff changeset
32 <when value="yes">
0a94307d301c Uploaded
greg
parents: 0
diff changeset
33 <param name="max_edge_length" type="float" value="0" label="Maximum edge length" help="Refine shape by restricting edges to this length (zero value results in no refinement).">
0a94307d301c Uploaded
greg
parents: 0
diff changeset
34 <validator type="in_range" min="0" exclude_min="true" />
0a94307d301c Uploaded
greg
parents: 0
diff changeset
35 </param>
0a94307d301c Uploaded
greg
parents: 0
diff changeset
36 </when>
0a94307d301c Uploaded
greg
parents: 0
diff changeset
37 </conditional>
0
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
38 <expand macro="output_vtk_type_params" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
39 </inputs>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
40 <outputs>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
41 <data name="output" format="vtkascii">
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
42 <actions>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
43 <action type="format">
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
44 <option type="from_param" name="output_vtk_type" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
45 </action>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
46 </actions>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
47 </data>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
48 </outputs>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
49 <tests>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
50 <test>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
51 <param name="input" value="shaft.vtkascii" ftype="vtkascii" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
52 <param name="input_file_format_and_type" value="vtkascii" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
53 <param name="input_dataset_type" value="POLYDATA" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
54 <param name="input_texture" value="sandstone.jpg" ftype="jpg" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
55 <param name="max_edge_length" value="0.1" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
56 <output name="output" file="shaft_with_texture.vtkascii" ftype="vtkascii" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
57 <param name="output_vtk_type" value="vtkascii" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
58 </test>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
59 </tests>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
60 <help>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
61 **What it does**
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
62
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
63 Adds a texture by applying an image to the surface of a shape. The shape is projected onto a bounding box
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
64 and the color is selected by flattening the box to fit the image. Refinement can be applied for a smoother
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
65 result.
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
66
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
67 * **Shape** - Shape for applying a surface texture.
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
68 * **Maximum edge length** - The shape's edges are smoothed by adding points to its edges that are longer than the defined maximum length.
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
69 * **Texture image** - Image to be applied to the shape's surface to create the texture.
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
70
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
71 </help>
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
72 <expand macro="citations" />
4afbbfafc3c2 Uploaded
greg
parents:
diff changeset
73 </tool>