annotate landmark_registration.xml @ 6:02aa2873e67d draft default tip

planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
author imgteam
date Mon, 13 Nov 2023 22:11:23 +0000
parents 12997d4c5b00
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
02aa2873e67d planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
imgteam
parents: 5
diff changeset
1 <tool id="ip_landmark_registration" name="Perform affine image registration (landmark-based)" version="0.1.0-2" profile="20.05">
02aa2873e67d planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
imgteam
parents: 5
diff changeset
2 <description></description>
02aa2873e67d planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
imgteam
parents: 5
diff changeset
3 <edam_operations>
02aa2873e67d planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
imgteam
parents: 5
diff changeset
4 <edam_operation>operation_3443</edam_operation>
02aa2873e67d planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
imgteam
parents: 5
diff changeset
5 </edam_operations>
02aa2873e67d planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
imgteam
parents: 5
diff changeset
6 <xrefs>
02aa2873e67d planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
imgteam
parents: 5
diff changeset
7 <xref type="bio.tools">galaxy_image_analysis</xref>
02aa2873e67d planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/landmark_registration/ commit 2286a6c9da88596349ed9d967c51541409c0a7bf
imgteam
parents: 5
diff changeset
8 </xrefs>
0
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
9 <requirements>
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
10 <requirement type="package" version="0.18.1">scikit-image</requirement>
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
11 <requirement type="package" version="1.6.2">scipy</requirement>
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
12 <requirement type="package" version="1.2.4">pandas</requirement>
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
13 <requirement type="package" version="1.20.2">numpy</requirement>
0
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
14 </requirements>
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
15 <command detect_errors="aggressive">
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
16 <![CDATA[
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
17 python '$__tool_directory__/landmark_registration.py'
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
18 '$fn_lmkmov'
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
19 '$fn_lmkfix'
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
20 '$fn_out'
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
21 #if $algo_option.algo == "pwat"
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
22 --pwlt '$algo_option.fn_ptsmov'
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
23 #elif $algo_option.algo == "ransac"
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
24 --res_th $algo_option.res_th
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
25 --max_ite $algo_option.max_ite
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
26 #end if
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
27 ]]>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
28 </command>
0
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
29 <inputs>
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
30 <param name="fn_lmkmov" type="data" format="tabular" label="Coordinates of moving landmarks (tsv file)" />
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
31 <param name="fn_lmkfix" type="data" format="tabular" label="Coordinates of fixed landmarks (tsv file)" />
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
32 <conditional name="algo_option">
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
33 <param name="algo" type="select" label="Select the algorithm">
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
34 <option value="ransac">Affine Transformation (based on RANSAC)</option>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
35 <option value="ls">Affine Transformation (based on Least Squares)</option>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
36 <option value="pwat" selected="True">Piecewise Affine Transformation</option>
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
37 </param>
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
38 <when value="ransac">
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
39 <param name="res_th" type="float" value="2.0" label="Maximum distance for a data point to be classified as an inlier." />
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
40 <param name="max_ite" type="integer" value="100" label="Maximum number of iterations for random sample selection." />
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
41 </when>
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
42 <when value="ls"></when>
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
43 <when value="pwat">
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
44 <param name="fn_ptsmov" type="data" format="tabular" label="Coordinates of points to be transformed (tsv file)" />
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
45 </when>
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
46 </conditional>
0
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
47 </inputs>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
48 <outputs>
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
49 <data format="tabular" name="fn_out" />
0
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
50 </outputs>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
51 <tests>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
52 <test>
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
53 <param name="fn_lmkmov" value="points_moving.tsv"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
54 <param name="fn_lmkfix" value="points_fixed.tsv"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
55 <param name="algo" value="ls"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
56 <output name="fn_out" value="tmat.tsv" ftype="tabular" compare="diff" lines_diff="6"/>
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
57 </test>
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
58 <test>
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
59 <param name="fn_lmkmov" value="points_moving.tsv"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
60 <param name="fn_lmkfix" value="points_fixed.tsv"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
61 <param name="algo" value="ransac"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
62 <param name="res_th" value="2.0"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
63 <param name="max_ite" value="100"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
64 <output name="fn_out" value="tmat.tsv" ftype="tabular" compare="diff" lines_diff="6"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
65 </test>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
66 <test>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
67 <param name="fn_lmkmov" value="lmk_mov.tsv"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
68 <param name="fn_lmkfix" value="lmk_fix.tsv"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
69 <param name="algo" value="pwat"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
70 <param name="fn_ptsmov" value="points.tsv"/>
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
71 <output name="fn_out" value="points_pwlt.tsv" ftype="tabular"/>
0
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
72 </test>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
73 </tests>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
74 <help>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
75 **What it does**
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
76
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
77 1) Estimation of the affine transformation matrix between two sets of 2d points;
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
78 2) Piecewise affine transformation of points based on landmark pairs.
2
4e089a0983b1 "planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 927b78d47c31714776ccdf3d16f26c3779298abb"
imgteam
parents: 0
diff changeset
79
4
aee73493bf53 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit ba383a4f617791d0c84737a179e5b4b66cecc334
imgteam
parents: 3
diff changeset
80 About the format of landmark/point coordinates in the input TSV table: Columns with header "x" and "y" are for x- and y-coordinate, respectively.
0
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
81 </help>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
82 <citations>
5
12997d4c5b00 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit 6d6a6fd04fa1d1f9a5bf1aff451e43be072c0293
imgteam
parents: 4
diff changeset
83 <citation type="doi">10.3390/cells11152390</citation>
0
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
84 <citation type="doi">10.1016/j.jbiotec.2017.07.019</citation>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
85 </citations>
a71239f3543a planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tools/landmark_registration/ commit d5df0e2f37920d09b5d942a7b128041ee1f0b6f5
imgteam
parents:
diff changeset
86 </tool>