Skip to content

Commit

Permalink
add images to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akhanf committed Dec 1, 2024
1 parent de9f9cb commit f4bb761
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Here are some examples of how to use the `plot_hipp_surf` function to visualize
### Example 1: Plot Both Hemispheres

```python
from plotting import plot_hipp_surf
from hippunfold_plot.plotting import plot_hipp_surf
from hippunfold_plot.utils import get_resource_path

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

# Plot dorsal view
fig = plot_hipp_surf(label_gii.format(density=density), hemi=None, density=density, view='dorsal')
fig.show()

# Plot ventral view
fig = plot_hipp_surf(label_gii.format(density=density), hemi=None, density=density, view='ventral')
fig.show()
```

```
![png](example1_0.png)
![png](example1_1.png)

### Example 2: Plot Left and Right Hemispheres Separately

```python
from plotting import plot_hipp_surf
from hippunfold_plot.plotting import plot_hipp_surf
from hippunfold_plot.utils import get_resource_path

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

# Plot left hemisphere
fig = plot_hipp_surf(label_gii.format(density=density), hemi='left', density=density, view='dorsal')
fig.show()

# Plot right hemisphere
fig = plot_hipp_surf(label_gii.format(density=density), hemi='right', density=density, view='dorsal')
fig.show()

```

![png](example2_0.png)
![png](example2_1.png)

### Example 3: Plot Unfolded Space
### Example 3: Plot unfolded and canonical space separately

```python
from plotting import plot_hipp_surf
from hippunfold_plot.plotting import plot_hipp_surf
from hippunfold_plot.utils import get_resource_path

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

# Plot left hemisphere in unfolded space
fig = plot_hipp_surf(label_gii.format(density=density), space='unfold', hemi='left', density=density, view='dorsal')
fig.show()
fig = plot_hipp_surf(label_gii.format(density=density), space='unfold', density=density, view='dorsal')

# Plot right hemisphere in unfolded space
fig = plot_hipp_surf(label_gii.format(density=density), space='unfold', hemi='right', density=density, view='dorsal')
fig.show()
# Plot left hemisphere in canonical space
fig = plot_hipp_surf(label_gii.format(density=density), space='canonical', density=density, view='dorsal')
```

![png](example3_0.png)
![png](example3_1.png)

## 🛠️ Functions

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

---

Happy plotting! 🎉
Happy plotting! 🎉
Binary file added doc/example1_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/example1_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/example2_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/example2_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/example3_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/example3_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f4bb761

Please sign in to comment.