Skip to content

Commit f4bb761

Browse files
committed
add images to readme
1 parent de9f9cb commit f4bb761

File tree

7 files changed

+19
-15
lines changed

7 files changed

+19
-15
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Here are some examples of how to use the `plot_hipp_surf` function to visualize
2424
### Example 1: Plot Both Hemispheres
2525

2626
```python
27-
from plotting import plot_hipp_surf
27+
from hippunfold_plot.plotting import plot_hipp_surf
2828
from hippunfold_plot.utils import get_resource_path
2929

3030
#get subfields for demonstrating plotting
@@ -33,17 +33,18 @@ density = '1mm'
3333

3434
# Plot dorsal view
3535
fig = plot_hipp_surf(label_gii.format(density=density), hemi=None, density=density, view='dorsal')
36-
fig.show()
3736

3837
# Plot ventral view
3938
fig = plot_hipp_surf(label_gii.format(density=density), hemi=None, density=density, view='ventral')
40-
fig.show()
41-
```
4239

40+
```
41+
![png](example1_0.png)
42+
![png](example1_1.png)
43+
4344
### Example 2: Plot Left and Right Hemispheres Separately
4445

4546
```python
46-
from plotting import plot_hipp_surf
47+
from hippunfold_plot.plotting import plot_hipp_surf
4748
from hippunfold_plot.utils import get_resource_path
4849

4950
#get subfields for demonstrating plotting
@@ -52,31 +53,34 @@ density = '1mm'
5253

5354
# Plot left hemisphere
5455
fig = plot_hipp_surf(label_gii.format(density=density), hemi='left', density=density, view='dorsal')
55-
fig.show()
5656

5757
# Plot right hemisphere
5858
fig = plot_hipp_surf(label_gii.format(density=density), hemi='right', density=density, view='dorsal')
59-
fig.show()
59+
6060
```
61+
62+
![png](example2_0.png)
63+
![png](example2_1.png)
6164

62-
### Example 3: Plot Unfolded Space
65+
### Example 3: Plot unfolded and canonical space separately
6366

6467
```python
65-
from plotting import plot_hipp_surf
68+
from hippunfold_plot.plotting import plot_hipp_surf
6669
from hippunfold_plot.utils import get_resource_path
6770

6871
#get subfields for demonstrating plotting
6972
label_gii = get_resource_path('tpl-avg_label-hippdentate_density-{density}_subfields.label.gii')
7073
density = '1mm'
7174

7275
# Plot left hemisphere in unfolded space
73-
fig = plot_hipp_surf(label_gii.format(density=density), space='unfold', hemi='left', density=density, view='dorsal')
74-
fig.show()
76+
fig = plot_hipp_surf(label_gii.format(density=density), space='unfold', density=density, view='dorsal')
7577

76-
# Plot right hemisphere in unfolded space
77-
fig = plot_hipp_surf(label_gii.format(density=density), space='unfold', hemi='right', density=density, view='dorsal')
78-
fig.show()
78+
# Plot left hemisphere in canonical space
79+
fig = plot_hipp_surf(label_gii.format(density=density), space='canonical', density=density, view='dorsal')
7980
```
81+
82+
![png](example3_0.png)
83+
![png](example3_1.png)
8084

8185
## 🛠️ Functions
8286

@@ -128,4 +132,4 @@ If you have any questions or feedback, feel free to reach out or post an issue!
128132

129133
---
130134

131-
Happy plotting! 🎉
135+
Happy plotting! 🎉

doc/example1_0.png

546 KB
Loading

doc/example1_1.png

545 KB
Loading

doc/example2_0.png

280 KB
Loading

doc/example2_1.png

275 KB
Loading

doc/example3_0.png

144 KB
Loading

doc/example3_1.png

125 KB
Loading

0 commit comments

Comments
 (0)