upstream/tools/image_processing/imagemagick/convert.xml
1<tool id="imagemagick_image_convert" name="Convert image format" version="@TOOL_VERSION@+galaxy2" profile="22.05">
2 <description>with ImageMagick</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
6 <expand macro="requirements"/>
7 <command detect_errors="aggressive">
8<![CDATA[
9 ln -s '${input}' input.${input.ext} &&
10 #if str($transformations) != 'None':
11 #set $trans_options = str($transformations).replace(',', ' ')
12 #else:
13 #set $trans_options = ''
14 #end if
15 magick
16 'input.${input.ext}'
17 -resize ${resize}%
18 +depth
19 $trans_options
20 #if $trimming.trimming_select == 'fuzz'
21 -define trim:edges=$trimming.sides
22 -fuzz ${trimming.fuzz_level}%
23 -trim
24 #else if $trimming.trimming_select == "manual"
25 -gravity $trimming.sides
26 #if $trimming.sides == "North" or $trimming.sides == "South":
27 -chop 0x${trimming.pixels}
28 #else if $trimming.sides == "East" or $trimming.sides == "West":
29 -chop ${trimming.pixels}x0
30 #end if
31 +repage
32 #end if
33 #if $palette.palette_select == "automatic"
34 -type Palette
35 #else if $palette.palette_select == "manual"
36 -colors '${palette.palette}'
37 #end if
38 #if $input.ext != 'pdf':
39 ## single output file
40 'temp.${output_format}'
41 &&
42 mv 'temp.${output_format}' '${output}'
43 #else:
44 ## create multiple output files for each PDF side
45 +adjoin temp_%03d.${output_format}
46 &&
47 mkdir ./outputs &&
48 mv temp_* ./outputs
49 #end if
50]]>
51 </command>
52 <inputs>
53 <param format="jpg,png,bmp,gif,svg,eps,tiff,pdf" name="input" type="data" label="Image to convert"/>
54 <param name="transformations" multiple="true" type="select" display="checkboxes" label="Transformations">
55 <option value="-flip">flip vertically</option>
56 <option value="-flop">flip horizontally</option>
57 <option value="-rotate 90">rotate 90 degree to the right</option>
58 <option value="-rotate 270">rotate 90 degree to the left</option>
59 <option value="-rotate 180">rotate 180 degree</option>
60 </param>
61 <conditional name="trimming">
62 <param name="trimming_select" type="select" label="Trim Image" help="Fuzz removes any edges that are exactly the same color as the corner pixels.">
63 <option value="no" selected="true">No</option>
64 <option value="fuzz">Fuzz</option>
65 <option value="manual">Manual</option>
66 </param>
67 <when value="no"/>
68 <when value="fuzz">
69 <param name="fuzz_level" type="integer" min="0" label="Fuzz distance in percent." value="0" help="Colors within this distance are considered equal."/>
70 <param name="sides" multiple="true" type="select" display="checkboxes" label="Which sides to trim?">
71 <option value="North">North</option>
72 <option value="East">East</option>
73 <option value="South">South</option>
74 <option value="West">West</option>
75 </param>
76 </when>
77 <when value="manual">
78 <param name="sides" type="select" label="Which sides to trim?">
79 <option value="North">North</option>
80 <option value="East">East</option>
81 <option value="South">South</option>
82 <option value="West">West</option>
83 </param>
84 <param name="pixels" type="integer" min="1" label="How many pixel to cut." value="50"/>
85 </when>
86 </conditional>
87 <conditional name="palette">
88 <param name="palette_select" type="select" label="Reduce Color Palette">
89 <option value="no" selected="true">No</option>
90 <option value="automatic">Automatic</option>
91 <option value="manual">Manual</option>
92 </param>
93 <when value="automatic"/>
94 <when value="manual">
95 <param name="palette" type="integer" min="1" label="Color Palette Size" value="32" help="Number of colors to use, should be in powers of 2 (1, 2, 4, 8, 16, 32, 64, ...), otherwise space is wasted in the palette."/>
96 </when>
97 <when value="no"/>
98 </conditional>
99 <param name="resize" type="integer" value="100" label="Resize (%)" min="0"/>
100 <param name="output_format" type="select" label="Output Format">
101 <option value="jpg">jpg</option>
102 <option value="png">png</option>
103 <option value="bmp">bmp</option>
104 <option value="gif">gif</option>
105 <option value="svg">svg</option>
106 <option value="eps">eps</option>
107 <option value="pdf">pdf</option>
108 <option value="tiff">tiff</option>
109 </param>
110 </inputs>
111 <outputs>
112 <data format="png" name="output">
113 <change_format>
114 <when input="output_format" value="jpg" format="jpg"/>
115 <when input="output_format" value="png" format="png"/>
116 <when input="output_format" value="bmp" format="bmp"/>
117 <when input="output_format" value="gif" format="gif"/>
118 <when input="output_format" value="svg" format="svg"/>
119 <when input="output_format" value="eps" format="eps"/>
120 <when input="output_format" value="pdf" format="pdf"/>
121 <when input="output_format" value="tiff" format="tiff"/>
122 </change_format>
123 <filter>input.ext != "pdf"</filter>
124 </data>
125 <collection name="splitted_pdf" type="list" label="${tool.name} on ${on_string} collection">
126 <discover_datasets pattern="__designation_and_ext__" directory="outputs"/>
127 <filter>input.ext == "pdf"</filter>
128 </collection>
129 </outputs>
130 <tests>
131 <test expect_num_outputs="1">
132 <param name="input" value="donald.jpg"/>
133 <param name="output_format" value="png"/>
134 <param name="transformations" value="-flip"/>
135 <param name="resize" value="50"/>
136 <conditional name="trimming">
137 <param name="trimming_select" value="no"/>
138 </conditional>
139 <output name="output" file="result_image_convert_1.png" compare="sim_size" delta="20000"/>
140 </test>
141 <test expect_num_outputs="1">
142 <param name="input" value="donald.jpg"/>
143 <param name="output_format" value="jpg"/>
144 <conditional name="trimming">
145 <param name="trimming_select" value="no"/>
146 </conditional>
147 <conditional name="palette">
148 <param name="palette_select" value="automatic"/>
149 </conditional>
150 <output name="output" file="donald-palette.jpg" compare="sim_size" delta="20000"/>
151 </test>
152 <test expect_num_outputs="1">
153 <param name="input" value="donald.jpg"/>
154 <param name="output_format" value="jpg"/>
155 <conditional name="trimming">
156 <param name="trimming_select" value="no"/>
157 </conditional>
158 <conditional name="palette">
159 <param name="palette_select" value="manual"/>
160 <param name="palette" value="2"/>
161 </conditional>
162 <output name="output" file="donald-colors-2.jpg" compare="sim_size" delta="20000"/>
163 </test>
164 <test expect_num_outputs="1">
165 <param name="input" value="test.pdf"/>
166 <param name="output_format" value="jpg"/>
167 <conditional name="trimming">
168 <param name="trimming_select" value="no"/>
169 </conditional>
170 <conditional name="palette">
171 <param name="palette_select" value="no"/>
172 </conditional>
173 <output_collection name="splitted_pdf" count="12" type="list">
174 <element name="temp_000" file="outputs/tmp_00.jpg" ftype="jpg" />
175 <element name="temp_001" file="outputs/tmp_01.jpg" ftype="jpg" />
176 </output_collection>
177 </test>
178 <test expect_num_outputs="1">
179 <param name="input" value="donald.jpg"/>
180 <param name="output_format" value="jpg"/>
181 <conditional name="trimming">
182 <param name="trimming_select" value="manual"/>
183 <param name="sides" value="North"/>
184 <param name="pixels" value="100"/>
185 </conditional>
186 <output name="output" file="donald_chopped.jpg" compare="sim_size" delta="20000"/>
187 </test>
188 <test expect_num_outputs="1">
189 <param name="input" value="donald-colors-2.jpg"/>
190 <param name="output_format" value="jpg"/>
191 <conditional name="trimming">
192 <param name="trimming_select" value="fuzz"/>
193 <param name="sides" value="North"/>
194 <param name="fuzz_level" value="5"/>
195 </conditional>
196 <output name="output" file="donald-colors-2-chopped.jpg" compare="sim_size" delta="20000"/>
197 </test>
198 </tests>
199 <help>
200<![CDATA[
201
202**What it does**
203
204This tool converts an image into another format. You can also do some transformations like flipping or rotating.
205Here you can see, how -flip behaves:
206
207Input:
208
209.. image:: $PATH_TO_IMAGES/donald.jpg
210
211Output:
212
213.. image:: $PATH_TO_IMAGES/donald.png
214
215]]>
216 </help>
217 <expand macro="citations"/>
218</tool>