Skip to content

Commit 66a7219

Browse files
authored
Update 3d-cyclorama.md with v1.0.0
1 parent 6e3f251 commit 66a7219

1 file changed

Lines changed: 27 additions & 30 deletions

File tree

_pages/plugins/3d-cyclorama.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,35 @@ description: Fiji plugin to digitally unroll deformed tubes.
88
author: Charalambos Rossides
99
---
1010

11-
Fiji plugin to digitally unroll deformed tubes. If you use this plugin for your research or industrial applications we kindly ask you to cite our work [1].
11+
Fiji/Imagej plugin to unroll 3D deformed tubes within image stacks.
12+
13+
Author: Charalambos Rossides, University of Southampton
14+
15+
If you use this plugin for your research or industrial applications we kindly ask you to cite our work [1].
1216

1317
[1] Rossides, C., Pender, S.L.F. & Schneider, P. "3D cyclorama for digital unrolling and visualisation of deformed tubes." Sci Rep 11, 14672 (2021).
1418

1519
[https://doi.org/10.1038/s41598-021-93184-x](https://doi.org/10.1038/s41598-021-93184-x)
1620

21+
------------------------
22+
1723
## Download
1824

19-
Step 1 - enable the *3Dcyclorama* site:
25+
Step 1 - enable the *3D cyclorama* update site:
2026

2127
- Start Fiji
2228
- Go to Help > Update > Manage update sites
23-
- Click *Add update site*. Name: 3D cyclorama, URL: https://sites.imagej.net/3Dcyclorama
24-
- Check the newly added *3Dcyclorama* site
25-
- Click *close*
29+
- Find *3D cyclorama* in the list and tick its checkbox
30+
- Click *Close*
2631
- Click *Apply changes*
2732

28-
Step 2 - download dependencies:
29-
- Create a directory named *FastDTW* in the Fiji plugins directory (Fiji.app/plugins/FastDTW)
30-
- Download the FastDTW algorithm from github [https://github.com/rmaestre/FastDTW](https://github.com/rmaestre/FastDTW) (Click code > download zip)
31-
- Extract the contents of FastDTW-master (FastDTW.iml, README.md, src, target, etc.) in Fiji.app/plugins/FastDTW
32-
33-
Step 3 - Run:
33+
Step 2 - Run:
3434
- Restart Fiji
3535
- The 3D cyclorama plugin should appear in the Plugins menu towards the bottom in a menu titled **3D cyclorama**
3636

37-
## Tutorial
37+
------------------------
3838

39-
Usage:
39+
## Tutorial
4040

4141
A. Preparation
4242
1. Run imagej
@@ -119,7 +119,7 @@ B. Unrolling
119119
120120
Click "Load scanStack", navigate to the directory of your image stack, select one image and click "Open". This will open the image stack and it will load the ROIset file that is expected to be saved in the same directory. A message will be displayed in the script editor output panel informing of the selected RoiSet.
121121
```
122-
2. Compute the boundary contours (Panel 2: Compute boundary contours)
122+
2. Compute the boundary contours (Panel 2: Compute boundary contours)
123123
```
124124
Select the desired "contour length" (Start with 100 points. Increase if the contours do not properly capture the shape. Decrease as much as possible for improved performance).
125125
@@ -140,7 +140,7 @@ B. Unrolling
140140
If the contours in the intermediate slices remain relatively unchanged, then the "Interpolation interval" on panel 1 needs to be reduced.
141141
If the contours oscillate exceedingly from slice to slice, the "Interpolation interval" on panel 1 needs to be increased.
142142
```
143-
3. Compute the intermediate contours and resampling surfaces (Panel 3: Compute resampling surfaces)
143+
3. Compute the intermediate contours and resampling surfaces (Panel 3: Compute resampling surfaces)
144144
```
145145
Define the "number of contours" to be computed on each slice, which includes the boundary and intermediate contours:
146146
Begin with a small value (3 or 5) so that you can quickly derive the rest of the parameters on this panel.
@@ -206,7 +206,7 @@ B. Unrolling
206206
If you would like to save the mappping to file, check the "Save mapping" checkbox in Panel 4. Note that this is required for bi-directional examination of the result (see C. Analysis).
207207
If you would like to save the resulting 3D cyclorama to file as a tiff image, check the "Save cyclorama" in Panel 5.
208208
```
209-
4. Proceed with the final unrolling:
209+
4. Proceed with the final unrolling:
210210
```
211211
Close the image stack and run the 3D cyclorama plugin again.
212212
@@ -237,7 +237,7 @@ C. Analysis
237237
A "Load project" panel will pop up. Leave the default values and click "Load".
238238
In the file selector that pops up, navigate to the "Cyclorama" directory that was created in the directory of the image stack.
239239
Select the <datetime>_log.txt file and click "Open".
240-
This will open the image stack, the 3D cyclorama, the ImageJ log window and a panel titled "Analyze cyclorama".
240+
This will open the image stack, the 3D cyclorama, the Imagej log window and a panel titled "Analyze cyclorama".
241241
242242
Bidirectional mapping:
243243
When the checkbox "Link views" is checked clicking on either of the views (image stack or cyclorama) will create the corresponding (mapped) point on the other view.
@@ -263,7 +263,7 @@ C. Analysis
263263
This is useful when features are segmented on the 3D cyclorama and the corresponding features need to be quantified on the image stack.
264264
Example:
265265
Uncheck all check boxes.
266-
Select the rectangle tool (leftmost tool on the ImageJ toolbar).
266+
Select the rectangle tool (leftmost tool on the Imagej toolbar).
267267
Draw a rectangle on top of the 3D cyclorama and press ctrl+f to fill it with a given colour.
268268
Repeat this over all slices of the cyclorama (Keep the rectangle unchanged, scroll to change image slice and press ctrl+f on each slice).
269269
Under the "Invert projected image (Cyclorama)" click "Select".
@@ -279,27 +279,24 @@ C. Analysis
279279
This is useful when seed-points (e.g. for region growth segmentation purposes) need to be identified on the 3D cyclorama and defined on the image stack.
280280
Example:
281281
Uncheck the "Activate ROI manager" to close any open ROI manager.
282-
Select the point tool (7th tool from the left on the ImageJ toolbar).
282+
Select the point tool (7th tool from the left on the Imagej toolbar).
283283
Click on a feature on the cyclorama image and press "t" to add the ROI to the ROI manager. Repeat this several times to create several ROIs.
284284
Under the "Invert ROIs" click the "Invert" button.
285285
This will create a black mask stack with the same dimensions as the image stack and white cubes of 5 x 5 x 5 pixels at the corresponding (mapped) points of all the points currently existing in the ROI manager.
286286
287287
<p style="text-align:center;"><img src="https://user-images.githubusercontent.com/20737950/131255975-c5f6bbd8-eafe-4d34-9770-65716e112b9e.png" alt="131255975 c5f6bbd8 eafe 4d34 9770 65716e112b9e" width="800"></p>
288288
289289
## ChangeLog
290-
v1.0.0:
290+
### v1.0.0
291291
292+
- FastDTW is now bundled with the plugin and shipped via the update site. Manual install of FastDTW from rmaestre/FastDTW is no longer required.
292293
- Added functionality to flatten sheets and scrolls.
293-
294-
v0.6.0:
295-
296-
- Implemented sanity checks in GUI.
297-
298-
v0.5.0:
299294
295+
### v0.5.1
296+
297+
- Implemented sanity checks in GUI.
300298
- Restricted 3Dcyclorama GUI access to unnecessary backend functionality.
301-
302-
v0.4.0:
303-
299+
300+
### v0.4.0
301+
304302
- First mature GUI.
305-

0 commit comments

Comments
 (0)