Skip to content

Commit 8c42ef0

Browse files
authored
ENH: Update README.md to have install, segmentation and VSP instructions
1 parent 3291a42 commit 8c42ef0

File tree

1 file changed

+43
-5
lines changed

1 file changed

+43
-5
lines changed

README.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,52 @@ Patient-specific guides dramatically improve the success rate and efficiency. 3D
2929
# Use Cases
3030
[First clinical use](https://github.com/SlicerIGT/SlicerBoneReconstructionPlanner/discussions/40)
3131

32-
# Important information
33-
- Mandible/Fibula Segmentation are inputs of this module. The segment at position zero (first segment of the segmentation) should be the mandible/fibula bone segment because it is used to make the 3D bone model used in BoneReconstructionPlanner.
34-
- Mandible/Fibula segments shouldn't have holes inside because they confuse the positioning algorithm of the sawBoxes/miterBoxes. To eliminate holes from a segment use WrapSolidify effect in the segment editor.
35-
- BoneReconstructionPlanner module is made to do virtual surgical planning and design of patient-specific surgical guides for mandibular reconstruction.
36-
3732
# Sample Data
3833
- <a href="https://github.com/SlicerIGT/SlicerBoneReconstructionPlanner/releases/download/TestingData/Fibula.nrrd" >Fibula Scalar Volume</a>
3934
- <a href="https://github.com/SlicerIGT/SlicerBoneReconstructionPlanner/releases/download/TestingData/ResectedMandible.nrrd" >Mandible Scalar Volume</a>
4035

36+
# Instructions
37+
38+
## Installing BoneReconstructionPlanner
39+
40+
1. Download Slicer Stable Release from here: https://download.slicer.org/ It's version is 4.11.20210226
41+
2. Install Slicer
42+
3. Open Slicer
43+
4. Press Ctrl+4 to open the extension manager. Or click the upper-right icon with the letter 'E'
44+
5. Go to 'Install Extensions' tab
45+
6. On the upper-right search box write "BoneReconstructionPlanner"
46+
7. Click install and give okay to install other extensions if asked.
47+
8. Tell me if there are some errors till here.
48+
49+
50+
## Segmentation (Preparation for Virtual Surgical Planning)
51+
52+
Make a mandible segmentation and a fibula segmentation.
53+
54+
Example:
55+
0. CTs should have a recommended slice thickness of 0.65mm (or a maximum slice thickness of 1mm)
56+
1. Go to the segment editor. Create a new segmentation. Create a new segment, name it 'fibula'.
57+
2. Use threshold effect to select bone but not connecting tissue (like ligaments). Check if your selected threshold value is okay if there is no connection of the segmented bones near the joint. Threshold value should not be too low to not lose detail. Suggested value: 200
58+
3. Use Islands effect, select 'keep selected island' and click over the fibula to keep it.
59+
4. If successful continue. If not start over and use a higher threshold value or use scissors to isolate the fibula
60+
5. Go to Wrap Solidify effect and click apply. (This is needed because it is recommended that bone segmentations have no holes inside so the assisted miterBox positioning algorithms work well)
61+
6. Correct errors on segmentations with scissors if needed.
62+
7. The bone segment (fibula or mandible) should be the first of the segment-list of the segmentation. In other words the bone segment should be in position zero of the list.
63+
64+
## Virtual Surgical Planning
65+
66+
1. Click the search icon on the left of the module selector and write 'BoneReconstructionPlanner'. Click switch to module.
67+
2. Select the mandibular segmentation and the fibula segmentation.
68+
3. Click "Create bone models from segmentations"
69+
4. Click "Add mandibular curve" and create a curve along the mandible. This will help giving the cut planes their initial position.
70+
5. Click "Add cut plane" and click where you want plane. Add as many planes as needed. There will be a bone piece between every two adjacent planes. So the number of mandible planes should be the desired number of bone pieces for the reconstruction plus one. The first and the last mandible planes will be the mandible resection cuts.
71+
6. Click "Add fibula line". Draw a line over the fibula on the 3D view. First point distal, last point proximal.
72+
7. Click "Center fibula line using fibula model" to make the line be similar to the anatomical axis of the fibula.
73+
8. Tick these options: "Automatic mandibular planes positioning for maximum bones contact area", "Make all mandible planes rotate together"
74+
9. Click "Update fibula planes over fibula line; update fibula bone pieces and transform them to mandible" to make the reconstruction and create the fibula cut planes.
75+
10. Move the mandible planes as desired to change the position/orientation of the cuts.
76+
11. Click "Update fibula planes over fibula line; update fibula bone pieces and transform them to mandible" again. And repeat as many times as needed.
77+
78+
4179
# License
4280
- <a href="https://github.com/SlicerIGT/SlicerBoneReconstructionPlanner/blob/main/LICENSE" >Read license</a>

0 commit comments

Comments
 (0)