Source code

Download source archive ↓

upstream/tools/image_processing/imagej2/imagej2_macros.xml

1<macros>
2    <token name="@TOOL_VERSION@">20240614</token>
3    <token name="@VERSION_SUFFIX@">1</token>
4    <xml name="fiji_requirements">
5        <requirements>
6            <requirement type="package" version="@TOOL_VERSION@">fiji</requirement>
7            <requirement type="package" version="3.11">grep</requirement>
8        </requirements>
9    </xml>
10    <xml name="image_type">
11        <param name="image_type" type="select" label="Image type">
12            <option value="8-bit_white" selected="true">8-bit white</option>
13            <option value="8-bit_black">8-bit black</option>
14            <option value="8-bit_random">8-bit random</option>
15            <option value="8-bit_ramp">8-bit ramp</option>
16            <option value="16-bit_white">16-bit white</option>
17            <option value="16-bit_black">16-bit black</option>
18            <option value="16-bit_random">16-bit random</option>
19            <option value="16-bit_ramp">16-bit ramp</option>
20            <option value="32-bit_white">32-bit white</option>
21            <option value="32-bit_black">32-bit black</option>
22            <option value="32-bit_random">32-bit random</option>
23            <option value="32-bit_ramp">32-bit ramp</option>
24            <option value="RGB_white">RGB white</option>
25            <option value="RGB_black">RGB black</option>
26            <option value="RGB_random">RGB random</option>
27            <option value="RGB_ramp">RGB ramp</option>
28        </param>
29    </xml>
30    <xml name="make_binary_params">
31        <param name="iterations" type="integer" value="1" min="1" max="100" label="Iterations" help="The number of times (1-100) erosion, dilation, opening, and closing are performed."/>
32        <param name="count" type="integer" value="1" min="1" max="8" label="Count" help="The number of adjacent background pixels necessary (1-8) for erosion or dilation."/>
33        <param name="black_background" type="select" label="Black background" help="If Yes, the background is black and the foreground is white (no implies the opposite).">
34            <option value="no" selected="true">No</option>
35            <option value="yes">Yes</option>
36        </param>
37        <param name="pad_edges_when_eroding" type="select" label="Pad edges when eroding" help="If Yes, eroding does not erode from the edges of the image.">
38            <option value="no" selected="true">No</option>
39            <option value="yes">Yes</option>
40        </param>
41    </xml>
42    <xml name="black_background_param">
43        <param name="black_background" type="select" label="Black background" help="If Yes, the background is black and the foreground is white (no implies the opposite).">
44            <option value="no" selected="true">No</option>
45            <option value="yes">Yes</option>
46        </param>
47    </xml>
48    <xml name="param_input">
49        <param format="bmp,eps,gif,jpg,pcx,pgm,png,psd,tiff" name="input" type="data" label="Select image"/>
50    </xml>
51    <xml name="param_source_image">
52        <param format="bmp,eps,gif,jpg,pcx,pgm,png,psd,tiff" name="source_image" type="data" label="Source image"/>
53    </xml>
54    <xml name="param_source_mask">
55        <param format="bmp,eps,gif,jpg,pcx,pgm,png,psd,tiff" name="source_mask" type="data" label="Source mask"/>
56    </xml>
57    <xml name="param_target_image">
58        <param format="bmp,eps,gif,jpg,pcx,pgm,png,psd,tiff" name="target_image" type="data" label="Target image"/>
59    </xml>
60    <xml name="param_target_mask">
61        <param format="bmp,eps,gif,jpg,pcx,pgm,png,psd,tiff" name="target_mask" type="data" label="Target mask"/>
62    </xml>
63    <xml name="test_bunwarpj_raw_transform">
64        <param name="target_image" value="dotblot.jpg"/>
65        <param name="source_image" value="blobs.gif"/>
66        <param name="target_raw_transformation" value="target_raw_transformation.txt"/>
67        <param name="source_raw_transformation" value="source_raw_transformation.txt"/>
68    </xml>
69    <xml name="test_target_source_images">
70        <param name="target_image" value="dotblot.jpg"/>
71        <param name="source_image" value="blobs.gif"/>
72    </xml>
73    <token name="@make_binary_args@">
74        --iterations $iterations
75        --count $count
76        --black_background $black_background
77        --pad_edges_when_eroding $pad_edges_when_eroding
78    </token>
79    <token name="@requires_binary_input@">
80.. class:: warningmark
81
82This tool works on binary images, so other image types will automatically be converted to binary
83before they are analyzed.  This step is performed using the ImageJ2 **Make Binary** command with
84the following settings: **Iterations:** 1, **Count:** 1, **Pad edges when eroding:** No.  The tool
85allows you to choose the **Black background** setting.  If these settings are not appropriate,
86first manually convert the image to binary using the **Convert to binary (black and white)**
87tool, which allows you to change them.
88    </token>
89    <xml name="image_datatypes">
90        <option value="bmp">bmp</option>
91        <option value="gif">gif</option>
92        <option value="jpg">jpg</option>
93        <option value="png" selected="true">png</option>
94        <option value="tiff">tiff</option>
95    </xml>
96    <xml name="bunwarpj_citations">
97        <citations>
98            <citation type="bibtex">
99                @InProceedings(Arganda-Carreras2006,
100                    author =     "Ignacio Arganda-Carreras and
101                                        Carlos Oscar S{\'a}nchez Sorzano and
102                                        Roberto Marabini and
103                                        Jos{\'e} Mar\'{\i}a Carazo and
104                                        Carlos Ortiz-de-Solorzano and
105                                        Jan Kybic",
106                    title =          "Consistent and Elastic Registration of Histological Sections Using Vector-Spline Regularization",    
107                    publisher =  "Springer Berlin / Heidelberg",    
108                    booktitle =   "Computer Vision Approaches to Medical Image Analysis",
109                    series =       "Lecture Notes in Computer Science",
110                    year =          "2006",
111                    volume =      "4241",
112                    pages =       "85-95",
113                    month =       "May",
114                    city =            "Graz, Austria")
115            </citation>
116            <citation type="doi">10.1038/nmeth.2019</citation>
117        </citations>
118    </xml>
119    <xml name="fiji_headless_citations">
120        <citations>
121            <citation type="doi">10.1038/nmeth.2102</citation>
122        </citations>
123    </xml>
124</macros>