diff --git a/docs/usage/connectivity.md b/docs/usage/connectivity.md new file mode 100644 index 0000000000000000000000000000000000000000..e84b820f0376543bb577aabb577ededdeec0d7af --- /dev/null +++ b/docs/usage/connectivity.md @@ -0,0 +1,92 @@ +# Connectivity matrix + +One of the new features from the Interactive Viewer's [version 2.1.0](https://interactive-viewer-user-documentation.apps.hbp.eu/releases/v2.1.0/) is to explore connectivity data, based on the parcellation area (region). Source of connectivity data is specific dataset(s) from HBP Knowledge Graph. + +For now, connectivity data is explorable for parcellation: "JuBrain Cytoarchitectonic Atlas" which is available on "MNI Colin 27" and "ICBM 2009c Nonlinear Asymmetric" template spaces. + +## Explore area connectivity +Select parcellation "JuBrain Cytoarchitectonic Atlas" and click on a region to bring up a context-specific menu + +[](images/region_menu_with_connectivity.png) + +By clicking on the "Connectivity" button, available datasets for connectivity will be displayed + +[](images/connectivity_dataset_menu.png) + +From the picture above, connectivity is available from the dataset "1000 Brain Study". Click on a dataset name to explore connectivity data and color visualization on the parcellation. +After selecting the desired dataset you can mention several changes: + +1. Color map for parcellation regions will be changed by connectivity data. (The selected area is marked on the image below) + + - Color map before selecting connectivity + + [](images/connectivity_color_before.png) + + - Color map after selecting connectivity + + [](images/connectivity_color_after.png) + +2. A Side panel will be opened (If it is closed) and connectivity data will be displayed + + [](images/connectivity_data_main.png) + + +## Work with connectivity data +In the connectivity panel, under selected dataset, you can find the source region + [](images/connectivity_source_region.png) + + +### Explore/change dataset +From connectivity panel, you can change dataset or explore the description of the current dataset + + [](images/see_dataset_connectivity.png) + +Hover on (i) info icon to display dataset description + + [](images/connectivity_dataset_description.png) + +### Connected regions view +At the top of the connectivity diagram, you can see two checkboxes: "Log10" and "All results" + + 1. "Log10" checkbox is to see a diagram with logarithmic data. (Log10 checkbox is checked by default) + + | Diagram with logarithmic data | Diagram without logarithmic data | + |-------------------------------|----------------------------------| + | [](images/con_diagram_log.png) | [](images/con_diagram_no_log.png) | + +2. To see a number of connections on each connected region, the cursor should hover the desired area. +"All results" checkbox, displays connection number of all connected areas at once (Checkbox is unchecked by default) + + | Diagram with disabled "All results" | Diagram with enabled "All results" | + |-------------------------------|----------------------------------| + | [](images/conn_disabled_all.png) | [](images/conn_enabled_all.png) | + +By clicking the connected region, special panel will be expanded. + + [](images/conn_expanded_area.png) + +At the panel you can find a full name of the connected area and two buttons: + "Navigate" - to change template navigation and move to region. + "Connectivity" - to set region as source region and explore connectivity of it. + + + +## Export connectivity data +At the end of the connectivity panel, you can find export buttons. + + [](images/conn_export.png) + + +You can export connectivity data with two options + +1. Export data as a CSV file +2. Export data as "png" format image + +## Close Connectivity +You can close connectivity from a close button on the top right side of the connectivity section at the right-side panel. + + [](images/close_connectivity.png) + + +1. After clicking the close button, the standard parcellation region color map will be returned to the viewer. +2. Connectivity data will be disappeared from a side panel \ No newline at end of file diff --git a/docs/usage/images/close_connectivity.png b/docs/usage/images/close_connectivity.png new file mode 100644 index 0000000000000000000000000000000000000000..a5dc58c5fec14f70d900d34407f6a94e9a0aba11 Binary files /dev/null and b/docs/usage/images/close_connectivity.png differ diff --git a/docs/usage/images/con_diagram_log.png b/docs/usage/images/con_diagram_log.png new file mode 100644 index 0000000000000000000000000000000000000000..fdcd530bc71b257f386b2c34c6f2c31ea95b937a Binary files /dev/null and b/docs/usage/images/con_diagram_log.png differ diff --git a/docs/usage/images/con_diagram_no_log.png b/docs/usage/images/con_diagram_no_log.png new file mode 100644 index 0000000000000000000000000000000000000000..a7d7c76a38662b83c859aafed00768a2a6b2c58d Binary files /dev/null and b/docs/usage/images/con_diagram_no_log.png differ diff --git a/docs/usage/images/conn_disabled_all.png b/docs/usage/images/conn_disabled_all.png new file mode 100644 index 0000000000000000000000000000000000000000..9f52d6f29e3dc911233c1609644f76f6e0bd94b8 Binary files /dev/null and b/docs/usage/images/conn_disabled_all.png differ diff --git a/docs/usage/images/conn_enabled_all.png b/docs/usage/images/conn_enabled_all.png new file mode 100644 index 0000000000000000000000000000000000000000..b44a78a5a01ddbfaabce9d26fd608351978be353 Binary files /dev/null and b/docs/usage/images/conn_enabled_all.png differ diff --git a/docs/usage/images/conn_expanded_area.png b/docs/usage/images/conn_expanded_area.png new file mode 100644 index 0000000000000000000000000000000000000000..f958647061a136b56d48002f87f5a68e22cd3e69 Binary files /dev/null and b/docs/usage/images/conn_expanded_area.png differ diff --git a/docs/usage/images/conn_export.png b/docs/usage/images/conn_export.png new file mode 100644 index 0000000000000000000000000000000000000000..172c5e3808934398cdadd83522add391233cec7e Binary files /dev/null and b/docs/usage/images/conn_export.png differ diff --git a/docs/usage/images/connectivity_color_after.png b/docs/usage/images/connectivity_color_after.png new file mode 100644 index 0000000000000000000000000000000000000000..298f3b98bf756918d4ba4615c31390bc974f7032 Binary files /dev/null and b/docs/usage/images/connectivity_color_after.png differ diff --git a/docs/usage/images/connectivity_color_before.png b/docs/usage/images/connectivity_color_before.png new file mode 100644 index 0000000000000000000000000000000000000000..1dd9630b741361911d167bcfdf92b70256dcd182 Binary files /dev/null and b/docs/usage/images/connectivity_color_before.png differ diff --git a/docs/usage/images/connectivity_data_main.png b/docs/usage/images/connectivity_data_main.png new file mode 100644 index 0000000000000000000000000000000000000000..9272de593f85ca2882b5d58a4f746359129c271b Binary files /dev/null and b/docs/usage/images/connectivity_data_main.png differ diff --git a/docs/usage/images/connectivity_dataset_description.png b/docs/usage/images/connectivity_dataset_description.png new file mode 100644 index 0000000000000000000000000000000000000000..770c96206e863a21bc30439f6e2c3fb85eb5ca11 Binary files /dev/null and b/docs/usage/images/connectivity_dataset_description.png differ diff --git a/docs/usage/images/connectivity_dataset_menu.png b/docs/usage/images/connectivity_dataset_menu.png new file mode 100644 index 0000000000000000000000000000000000000000..e0e271a4c9661b980ecc65efe70058e4e181ff73 Binary files /dev/null and b/docs/usage/images/connectivity_dataset_menu.png differ diff --git a/docs/usage/images/connectivity_source_region.png b/docs/usage/images/connectivity_source_region.png new file mode 100644 index 0000000000000000000000000000000000000000..caea6c4869cb99236234057a765b60917e6a066e Binary files /dev/null and b/docs/usage/images/connectivity_source_region.png differ diff --git a/docs/usage/images/region_menu_with_connectivity.png b/docs/usage/images/region_menu_with_connectivity.png new file mode 100644 index 0000000000000000000000000000000000000000..2e683b6a491bb532952e68dc62244027cd3d436a Binary files /dev/null and b/docs/usage/images/region_menu_with_connectivity.png differ diff --git a/docs/usage/images/see_dataset_connectivity.png b/docs/usage/images/see_dataset_connectivity.png new file mode 100644 index 0000000000000000000000000000000000000000..6584cf63f42aac07c179be7e913611cd8279474a Binary files /dev/null and b/docs/usage/images/see_dataset_connectivity.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 94f31ae2651b79ed5e7b352a06df26154ef9f8e8..0b5b218f4b7a3ce0a1161edfe5c52618895db75d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,6 +21,7 @@ pages: - Selecting: 'usage/selecting.md' - Navigating: 'usage/navigating.md' - Searching: 'usage/search.md' + - Connectivity: 'usage/connectivity.md' - Advanced usage: - Keyboard shortcuts: 'advanced/keyboard.md' - URL parsing: 'advanced/url.md'