Skip to content

Commit ba5009d

Browse files
committed
bigwarp: d oc new and legacy dialogs
1 parent e255cc3 commit ba5009d

File tree

3 files changed

+65
-3
lines changed

3 files changed

+65
-3
lines changed

_pages/plugins/bigwarp.md

+65-3
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,73 @@ the warp on-the-fly.
1919

2020
## Installation
2121

22-
BigWarp comes with Fiji. You can access it via
23-
{% include bc path="Plugins | BigDataViewer Big Warp" %}.
24-
If this is not visible in your installation, try updating Fiji with
22+
BigWarp comes with Fiji. You can access it via {% include bc path="Plugins | BigDataViewer | Big Warp Command" %}
23+
for the newer startup dialog, or {% include bc path="Plugins | BigDataViewer | Big Warp" %}
24+
for the legacy dialog. If this is not visible in your installation, try updating Fiji with
2525
{% include bc path="Help Update..." %}.
2626

27+
## Starting BigWarp
28+
29+
### `Big Warp Command`
30+
31+
{::nomarkdown}
32+
<table>
33+
<tbody>
34+
<tr>
35+
<td style="padding: 5px;"> <img src="/media/plugins/bigwarp-init-dialog.png" width="500"/> </td>
36+
<td style="padding: 5px;">
37+
<ul>
38+
<li><b>BigWarp project or landmarks</b> : Select a saved BigWarp project file (json) or landmarks file (csv).</li>
39+
<li><b>Add open image</b>: Select an image open in ImageJ to add to BigWarp. Click the {% include button label='+' %} button to add the selected image to the table.</li>
40+
<li><b>Add image file/folder</b>: Select an file or folder. Click the {% include button label='+' %} button to add the selected image to the table.
41+
You can {% include button label='Browse' %} your file system, or explore {% include button label='H5/N5/Zarr' %} containers.</li>
42+
<li><b>Add transformation</b>: Select a transformation. Click the {% include button label='+' %} to add the selected transformation to the currrently selected row of the table.
43+
You can {% include button label='Browse' %} your file system, or explore {% include button label='H5/N5/Zarr' %} containers.</li>
44+
</ul>
45+
</td>
46+
</tr>
47+
</tbody>
48+
</table>
49+
{:/}
50+
51+
Selected images are displayed in a table at the bottom of the dialog. Indicate an image as
52+
moving by checking the box in the "Moving" column. Only *moving images* will be transformed by
53+
BigWarp. Any number of images can be set as moving. Clicking {% include button label='remove' %}
54+
will remove a row from the table.
55+
56+
BigWarp can also apply "external" transformations to images. These are shown in the *Transform*
57+
column of the table. They can be added with the "Add transformation" option above, or by writing
58+
a path or [N5URL](https://github.com/saalfeldlab/n5/wiki/URLs) directly into the table.
59+
60+
### `Big Warp`
61+
62+
{::nomarkdown}
63+
<table>
64+
<tbody>
65+
<tr>
66+
<td style="padding: 5px;"> <img src="/media/plugins/bigwarp-dialog-legacy.png" width="250"/> </td>
67+
<td style="padding: 5px;">
68+
<ul>
69+
<li><b>moving image</b> : Select an image open in ImageJ to be transformed.</li>
70+
<li><b>target image</b>: Select an image open in ImageJ as a reference image. Will not be transformed.</li>
71+
<li><b>N5/Zarr/HDF5/BDV-XML</b>: The four options below let you selected chunked storage containers for moving and target images</li>
72+
<ul>
73+
<li><b>Moving</b>: The root of of the storage container for the moving image (ususally ends with ".h5", ".n5", or ".zarr")</li>
74+
<li><b>Moving dataset</b>: The path to the moving image relative to the root ("/" refers to the container root)</li>
75+
<li><b>Target</b>: The root of of the storage container for the target image (ususally ends with ".h5", ".n5", or ".zarr")</li>
76+
<li><b>Target dataset</b>: The path to the target image relative to the root ("/" refers to the container root)</li>
77+
</ul>
78+
<li><b>Landmarks file</b>: A csv file containing landmarks</li>
79+
<li><b>Apply transform from landmarks</b>: if selected and landmarks are provided, BigWarp will transform the moving image(s) on startup.</li>
80+
</ul>
81+
</td>
82+
</tr>
83+
</tbody>
84+
</table>
85+
{:/}
86+
87+
Note: The moving or target images open in ImageJ may be multi-channel. Chunked file formats let you open images that are too large for "traditional" ImageJ, or stream image data on the fly from cloud storage.
88+
2789
## Usage
2890

2991
Open two images in ImageJ, one *moving* and the other *target* and navigate to
23.5 KB
Loading

media/plugins/bigwarp-init-dialog.png

39.5 KB
Loading

0 commit comments

Comments
 (0)