annotate imagej2_analyze_skeleton.xml @ 4:ddff80b819bf draft default tip

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/image_processing/imagej2 commit 8ea6a4271431c05c82b09c0d3e629b13e6ea7936
author iuc
date Fri, 22 Jul 2016 23:27:42 -0400
parents 20555566d6ad
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
2 <tool id="imagej2_analyze_skeleton" name="Analyze skeleton" version="@WRAPPER_VERSION@.0">
3
20555566d6ad planemo upload commit 378c3ecfbaed0330faf197811d379431b0f9e92c-dirty
iuc
parents: 2
diff changeset
3 <description></description>
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
4 <macros>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
5 <import>imagej2_macros.xml</import>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
6 </macros>
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
7 <expand macro="fiji_requirements" />
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
8 <command>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
9 <![CDATA[
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
10 python $__tool_directory__/imagej2_analyze_skeleton.py
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
11 --input "$input"
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
12 --input_datatype $input.ext
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
13 --black_background $black_background
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
14 --prune_cycle_method $prune_cycle_method
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
15 --prune_ends $prune_ends
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
16 --calculate_largest_shortest_path $calculate_largest_shortest_path
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
17 ##TODO: seel below--show_detailed_info $show_detailed_info
4
ddff80b819bf planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/image_processing/imagej2 commit 8ea6a4271431c05c82b09c0d3e629b13e6ea7936
iuc
parents: 3
diff changeset
18 --jython_script $__tool_directory__/imagej2_analyze_skeleton_jython_script.py
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
19 --output "$output"
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
20 ]]>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
21 </command>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
22 <inputs>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
23 <param format="bmp,eps,gif,jpg,pcx,pgm,png,psd,tiff" name="input" type="data" label="Select grayscale image"/>
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
24 <expand macro="black_background_param" />
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
25 <param name="prune_cycle_method" type="select" label="Prune cycle method">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
26 <option value="none" selected="True">None</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
27 <option value="shortest_branch">Shortest branch</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
28 <option value="lowest_intensity_voxel">Lowest intensity voxel</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
29 <option value="lowest_intensity_branch">Lowest intensity branch</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
30 </param>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
31 <param name="prune_ends" type="select" label="Prune ends">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
32 <option value="no" selected="True">No</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
33 <option value="yes">Yes</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
34 </param>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
35 <param name="calculate_largest_shortest_path" type="select" label="Calculate largest shortest path">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
36 <option value="no" selected="True">No</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
37 <option value="yes">Yes</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
38 </param>
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
39 <!-- TODO: Uncomment this option when the tool has been enhanced to use the
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
40 future "Display labeled skeletons" option. See http://fiji.sc/AnalyzeSkeleton.
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
41 <param name="show_detailed_info" type="select" label="Show detailed info">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
42 <option value="no" selected="True">No</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
43 <option value="yes">Yes</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
44 </param>
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
45 -->
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
46 </inputs>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
47 <outputs>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
48 <data name="output" format="tabular" label="${tool.name} on ${on_string}" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
49 </outputs>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
50 <tests>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
51 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
52 <param name="input" value="skeletonized_blobs.gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
53 <param name="input_datatype" value="gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
54 <output name="output" file="basic.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
55 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
56 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
57 <param name="input" value="skeletonized_clown.jpg" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
58 <param name="input_datatype" value="jpg" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
59 <param name="prune_cycle_method" value="shortest_branch" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
60 <output name="output" file="shortest_branch_basic.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
61 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
62 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
63 <param name="input" value="skeletonized_blobs.gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
64 <param name="input_datatype" value="gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
65 <param name="calculate_largest_shortest_path" value="yes" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
66 <output name="output" file="largest_shortest_path_basic.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
67 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
68 <test>
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
69 <!-- TODO: Change this test and the following test to set "show_detailed_info"
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
70 to "yes" when the tool has been enhanced to use the future "Display labeled skeletons"
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
71 option. See http://fiji.sc/AnalyzeSkeleton. -->
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
72 <param name="input" value="skeletonized_blobs.gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
73 <param name="input_datatype" value="gif" />
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
74 <!-- <param name="show_detailed_info" value="yes" /> -->
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
75 <output name="output" file="detailed.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
76 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
77 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
78 <param name="input" value="skeletonized_clown.jpg" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
79 <param name="input_datatype" value="jpg" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
80 <param name="prune_cycle_method" value="shortest_branch" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
81 <param name="calculate_largest_shortest_path" value="yes" />
2
9631aab7da53 planemo upload commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
iuc
parents: 1
diff changeset
82 <!-- <param name="show_detailed_info" value="yes" /> -->
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
83 <output name="output" file="shortest_branch_all_yes.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
84 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
85 </tests>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
86 <help>
1
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
87
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
88 .. class:: warningmark
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
89
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
90 The underlying AnalyzeSkeleton Fiji plugin works on binary images, so other image types will
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
91 automatically be converted to binary before they are analyzed. This step is performed using the
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
92 ImageJ2 **Make Binary** command with the following settings: **Iterations:** 1, **Count:** 1,
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
93 **Black background:** No, **Pad edges when eroding:** No. If these settings are not appropriate,
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
94 first manually convert the image to binary using the **Convert to binary (black and white) with
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
95 ImageJ2** tool, which allows you to change them.
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
96
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
97 .. class:: warningmark
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
98
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
99 The **Skeletonize images** tool produces skeleton images that can be used as input to this tool.
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
100 Images that have not been skeletonized will not result in errors, but the results may or may not
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
101 be useful.
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
102
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
103 **What it does**
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
104
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
105 <![CDATA[
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
106 Tags all pixel/voxels in a skeleton image and then counts all its junctions, triple and quadruple
1
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
107 points and branches, and measures their average and maximum length. The voxels are classified into
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
108 three different categories depending on their 26 neighbors:
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
109
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
110 - **End-point** voxels: if they have less than 2 neighbors.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
111 - **Junction** voxels: if they have more than 2 neighbors.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
112 - **Slab** voxels: if they have exactly 2 neighbors.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
113
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
114 -----
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
115
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
116 **Options**
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
117
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
118 - **Prune cycle method**: prune the possible loops in the skeleton.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
119 - **Prune ends**: prunes any branch that ends in an end-point.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
120 - **Calculate largest shortest path**: calculate the largest shortest path of each skeleton using the APSP (all pairs shortest path).
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
121 ]]>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
122 </help>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
123 <citations>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
124 <citation type="doi">10.1002/jemt.20829</citation>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
125 <citation type="doi">10.1038/nmeth.2102</citation>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
126 </citations>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
127 </tool>