Mercurial > repos > iuc > imagej2_analyze_skeleton

annotate imagej2_analyze_skeleton.xml @ 1:dd8e4e000d2f draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
author iuc
date Tue, 04 Aug 2015 13:19:34 -0400
parents a989ca433027
children 9631aab7da53
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'?>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
2 <tool id="imagej2_analyze_skeleton" name="Analyze skeleton" version="1.0.0">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
3 <description>with ImageJ2</description>
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>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
7 <expand macro="fiji_20141125_requirements" />
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
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
13 --prune_cycle_method $prune_cycle_method
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
14 --prune_ends $prune_ends
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
15 --calculate_largest_shortest_path $calculate_largest_shortest_path
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
16 --show_detailed_info $show_detailed_info
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
17 @max_heap_size_args@
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
18 --jython_script $__tool_directory__/jython_script.py
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"/>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
24 <param name="prune_cycle_method" type="select" label="Prune cycle method">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
25 <option value="none" selected="True">None</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
26 <option value="shortest_branch">Shortest branch</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
27 <option value="lowest_intensity_voxel">Lowest intensity voxel</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
28 <option value="lowest_intensity_branch">Lowest intensity branch</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
29 </param>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
30 <param name="prune_ends" type="select" label="Prune ends">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
31 <option value="no" selected="True">No</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
32 <option value="yes">Yes</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
33 </param>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
34 <param name="calculate_largest_shortest_path" type="select" label="Calculate largest shortest path">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
35 <option value="no" selected="True">No</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
36 <option value="yes">Yes</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
37 </param>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
38 <param name="show_detailed_info" type="select" label="Show detailed info">
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
39 <option value="no" selected="True">No</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
40 <option value="yes">Yes</option>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
41 </param>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
42 <expand macro="max_heap_size_type_conditional" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
43 </inputs>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
44 <outputs>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
45 <data name="output" format="tabular" label="${tool.name} on ${on_string}" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
46 </outputs>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
47 <tests>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
48 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
49 <param name="input" value="skeletonized_blobs.gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
50 <param name="input_datatype" value="gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
51 <output name="output" file="basic.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
52 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
53 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
54 <param name="input" value="skeletonized_clown.jpg" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
55 <param name="input_datatype" value="jpg" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
56 <param name="prune_cycle_method" value="shortest_branch" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
57 <output name="output" file="shortest_branch_basic.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
58 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
59 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
60 <param name="input" value="skeletonized_blobs.gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
61 <param name="input_datatype" value="gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
62 <param name="calculate_largest_shortest_path" value="yes" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
63 <output name="output" file="largest_shortest_path_basic.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
64 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
65 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
66 <param name="input" value="skeletonized_blobs.gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
67 <param name="input_datatype" value="gif" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
68 <param name="show_detailed_info" value="yes" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
69 <output name="output" file="detailed.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
70 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
71 <test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
72 <param name="input" value="skeletonized_clown.jpg" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
73 <param name="input_datatype" value="jpg" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
74 <param name="prune_cycle_method" value="shortest_branch" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
75 <param name="calculate_largest_shortest_path" value="yes" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
76 <param name="show_detailed_info" value="yes" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
77 <output name="output" file="shortest_branch_all_yes.tabular" ftype="tabular" />
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
78 </test>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
79 </tests>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
80 <help>
1
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
81
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
82 .. class:: warningmark
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
83
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
84 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
85 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
86 ImageJ2 **Make Binary** command with the following settings: **Iterations:** 1, **Count:** 1,
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
87 **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
88 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
89 ImageJ2** tool, which allows you to change them.
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
90
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
91 .. class:: warningmark
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
92
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
93 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
94 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
95 be useful.
dd8e4e000d2f planemo upload commit 98c34e070343a117019ffd25a3af117808159bf5-dirty
iuc
parents: 0
diff changeset
96
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
97 **What it does**
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
98
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
99 <![CDATA[
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
100 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
101 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
102 three different categories depending on their 26 neighbors:
0
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
103
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
104 - **End-point** voxels: if they have less than 2 neighbors.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
105 - **Junction** voxels: if they have more than 2 neighbors.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
106 - **Slab** voxels: if they have exactly 2 neighbors.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
107
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
108 -----
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
109
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
110 **Options**
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
111
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
112 - **Prune cycle method**: prune the possible loops in the skeleton.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
113 - **Prune ends**: prunes any branch that ends in an end-point.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
114 - **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
115 - **Show detailed info**: produces information about the branches of each skeleton in the image.
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
116 ]]>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
117 </help>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
118 <citations>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
119 <citation type="doi">10.1002/jemt.20829</citation>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
120 <citation type="doi">10.1038/nmeth.2102</citation>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
121 </citations>
a989ca433027 planemo upload commit 8f8692e83217a072a3ed928469621f1f606ab28a-dirty
iuc
parents:
diff changeset
122 </tool>