diff --git a/README.md b/README.md index 951e713..5e3f370 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -52,17 +53,19 @@ 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 @@ -70,13 +73,14 @@ label_gii = get_resource_path('tpl-avg_label-hippdentate_density-{density}_subfi 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 @@ -128,4 +132,4 @@ If you have any questions or feedback, feel free to reach out or post an issue! --- -Happy plotting! 🎉 \ No newline at end of file +Happy plotting! 🎉 diff --git a/doc/example1_0.png b/doc/example1_0.png new file mode 100644 index 0000000..41004d5 Binary files /dev/null and b/doc/example1_0.png differ diff --git a/doc/example1_1.png b/doc/example1_1.png new file mode 100644 index 0000000..05ec8c8 Binary files /dev/null and b/doc/example1_1.png differ diff --git a/doc/example2_0.png b/doc/example2_0.png new file mode 100644 index 0000000..5e76152 Binary files /dev/null and b/doc/example2_0.png differ diff --git a/doc/example2_1.png b/doc/example2_1.png new file mode 100644 index 0000000..9ce8143 Binary files /dev/null and b/doc/example2_1.png differ diff --git a/doc/example3_0.png b/doc/example3_0.png new file mode 100644 index 0000000..c67d255 Binary files /dev/null and b/doc/example3_0.png differ diff --git a/doc/example3_1.png b/doc/example3_1.png new file mode 100644 index 0000000..e4b2315 Binary files /dev/null and b/doc/example3_1.png differ